{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Reference overview","link":"/","routeSlug":"/"},{"type":"link","fsPath":"openapi/okta-management/guides/release-lifecycle.md","metadata":{"type":"markdown"},"label":"Release lifecycle","link":"/openapi/okta-management/guides/release-lifecycle","routeSlug":"/openapi/okta-management/guides/release-lifecycle"},{"type":"link","fsPath":"oauth2.md","metadata":{"type":"markdown"},"label":"OAuth 2.0 Scopes","link":"/oauth2","routeSlug":"/oauth2"},{"type":"group","label":"Postman","items":[{"type":"link","link":"https://www.postman.com/okta-eng/workspace/okta-public-api-collections/overview","label":"Postman Collections","external":true},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/rest/","label":"Test APIs with Postman","external":true}]},{"type":"group","label":"Expression Languages","items":[{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/okta-expression-language/","label":"Okta Expression Language","external":true},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/okta-expression-language-in-identity-engine/","label":"Expression Language in Identity Engine","external":true}]},{"type":"group","label":"OpenID Connect & OAuth 2.0","items":[{"type":"link","fsPath":"openapi/okta-oauth/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/okta-oauth/guides/overview","routeSlug":"/openapi/okta-oauth/guides/overview"},{"type":"link","fsPath":"openapi/okta-oauth/guides/client-auth.md","metadata":{"type":"markdown"},"label":"Client authentication","link":"/openapi/okta-oauth/guides/client-auth","routeSlug":"/openapi/okta-oauth/guides/client-auth"},{"type":"link","label":"Okta OpenID Connect & OAuth 2.0","link":"/openapi/okta-oauth/oauth","routeSlug":"/openapi/okta-oauth/oauth"},{"type":"group","label":"Dynamic Client Registration","link":"/openapi/okta-oauth/oauth/client","routeSlug":"/openapi/okta-oauth/oauth/client","items":[{"label":"List all client applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/listclients","routeSlug":"/openapi/okta-oauth/oauth/client/listclients","metadata":{"seo":{"title":"List all client applications","description":"
"}},"httpPath":"/oauth2/v1/clients"},{"label":"Register a client app","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/createclient","routeSlug":"/openapi/okta-oauth/oauth/client/createclient","metadata":{"seo":{"title":"Register a client app","description":"
"}},"httpPath":"/oauth2/v1/clients"},{"label":"Retrieve a client app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/getclient","routeSlug":"/openapi/okta-oauth/oauth/client/getclient","metadata":{"seo":{"title":"Retrieve a client app","description":"
CORS
OAuth 2.0 scope:
  • okta.clients.read
"}},"httpPath":"/oauth2/v1/clients/{clientId}"},{"label":"Replace a client app","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/replaceclient","routeSlug":"/openapi/okta-oauth/oauth/client/replaceclient","metadata":{"seo":{"title":"Replace a client app","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}"},{"label":"Delete a client app","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/deleteclient","routeSlug":"/openapi/okta-oauth/oauth/client/deleteclient","metadata":{"seo":{"title":"Delete a client app","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}"},{"label":"Generate a new client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/client/generatenewclientsecret","routeSlug":"/openapi/okta-oauth/oauth/client/generatenewclientsecret","metadata":{"seo":{"title":"Generate a new client secret","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/lifecycle/newSecret"}]},{"type":"group","label":"Custom Authorization Servers","link":"/openapi/okta-oauth/oauth/customas","routeSlug":"/openapi/okta-oauth/oauth/customas","items":[{"label":"Retrieve the OAuth 2.0 metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/getwellknownoauthconfigurationcustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/getwellknownoauthconfigurationcustomas","metadata":{"seo":{"title":"Retrieve the OAuth 2.0 metadata","description":"
CORS
"}},"httpPath":"/.well-known/oauth-authorization-server/oauth2/{authorizationServerId}"},{"label":"Retrieve the OpenID Connect metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/getwellknownopenidconfigurationcustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/getwellknownopenidconfigurationcustomas","metadata":{"seo":{"title":"Retrieve the OpenID Connect metadata","description":"
CORS
"}},"httpPath":"/oauth2/{authorizationServerId}/.well-known/openid-configuration"},{"label":"/authorize","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/authorizecustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/authorizecustomas","metadata":{"seo":{"title":"/authorize","description":"This is a starting point for browser-based OpenID Connect flows such as the implicit and authorization code flows. This request authenticates the user and returns tokens along with an authorization grant to the client app as a part of the callback response."}},"httpPath":"/oauth2/{authorizationServerId}/v1/authorize"},{"label":"/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/authorizecustomaswithpost","routeSlug":"/openapi/okta-oauth/oauth/customas/authorizecustomaswithpost","metadata":{"seo":{"title":"/authorize","description":"This is a starting point for browser-based OpenID Connect flows such as the implicit and authorization code flows. This endpoint method behaves the same as GET /oauth2/{authorizationServerId}/v1/authorize, except that all parameters are specified in the request body and submitted through the form post. No query parameters are allowed."}},"httpPath":"/oauth2/{authorizationServerId}/v1/authorize"},{"label":"/bc/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/bcauthorizecustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/bcauthorizecustomas","metadata":{"seo":{"title":"/bc/authorize","description":"This endpoint returns a unique identifier (auth_req_id) that identifies the authentication flow while it tries to authenticate the user in the background. This auth_req_id value is used in subsequent token requests to the /token endpoint."}},"httpPath":"/oauth2/{authorizationServerId}/v1/bc/authorize"},{"label":"/challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/challenge-custom-as","routeSlug":"/openapi/okta-oauth/oauth/customas/challenge-custom-as","metadata":{"seo":{"title":"/challenge","description":"Initiates the challenge of subsequent factor(s) in a direct authentication flow after the token endpoint has responded with mfa_required. This endpoint is optional if the client is able to proceed without it, for example, the client knows it needs to follow up with an OTP and can prompt the end user for one."}},"httpPath":"/oauth2/{authorizationServerId}/v1/challenge"},{"label":"/device/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/deviceauthorizecustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/deviceauthorizecustomas","metadata":{"seo":{"title":"/device/authorize","description":"
CORS
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/device/authorize"},{"label":"/introspect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/introspectcustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/introspectcustomas","metadata":{"seo":{"title":"/introspect","description":"
CORS
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/introspect"},{"label":"/keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/oauthkeyscustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/oauthkeyscustomas","metadata":{"seo":{"title":"/keys","description":"
CORS
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/keys"},{"label":"/logout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/logoutcustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/logoutcustomas","metadata":{"seo":{"title":"/logout","description":"Use this operation to sign a user out by removing their Okta browser session."}},"httpPath":"/oauth2/{authorizationServerId}/v1/logout"},{"label":"/logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/logoutcustomaswithpost","routeSlug":"/openapi/okta-oauth/oauth/customas/logoutcustomaswithpost","metadata":{"seo":{"title":"/logout","description":"Use this operation to sign a user out by removing their Okta browser session. This is the recommended method over GET as you can wrap the parameters in the request body."}},"httpPath":"/oauth2/{authorizationServerId}/v1/logout"},{"label":"/par","deprecated":false,"httpVerb":"options","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/paroptionscustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/paroptionscustomas","metadata":{"seo":{"title":"/par","description":"
Identity Engine
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/par"},{"label":"/par","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/parcustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/parcustomas","metadata":{"seo":{"title":"/par","description":"
Identity Engine
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/par"},{"label":"/primary-authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/primary-authenticate-custom-as","routeSlug":"/openapi/okta-oauth/oauth/customas/primary-authenticate-custom-as","metadata":{"seo":{"title":"/primary-authenticate","description":"Initiates direct authentication with an out-of-band authenticator"}},"httpPath":"/oauth2/{authorizationServerId}/v1/primary-authenticate"},{"label":"/revoke","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/revokecustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/revokecustomas","metadata":{"seo":{"title":"/revoke","description":"
CORS
"}},"httpPath":"/oauth2/{authorizationServerId}/v1/revoke"},{"label":"/token","deprecated":false,"httpVerb":"options","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/tokenoptionscustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/tokenoptionscustomas","metadata":{"seo":{"title":"/token","description":"Use this operation to request the permitted communication options for the /token endpoint."}},"httpPath":"/oauth2/{authorizationServerId}/v1/token"},{"label":"/token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/tokencustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/tokencustomas","metadata":{"seo":{"title":"/token","description":"This endpoint returns access tokens, ID tokens, and refresh tokens depending on the request parameters. For password, client credentials, SAML 2.0 assertion, and refresh token flows, calling /token is the only step of the flow. For the authorization code flow, calling /token is the second step of the flow."}},"httpPath":"/oauth2/{authorizationServerId}/v1/token"},{"label":"/userinfo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/userinfocustomas","routeSlug":"/openapi/okta-oauth/oauth/customas/userinfocustomas","metadata":{"seo":{"title":"/userinfo","description":""}},"httpPath":"/oauth2/{authorizationServerId}/v1/userinfo"},{"label":"/oob-authenticate","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/customas/oob-authenticate-custom-as","routeSlug":"/openapi/okta-oauth/oauth/customas/oob-authenticate-custom-as","metadata":{"seo":{"title":"/oob-authenticate","description":"Initiates direct authentication with an out-of-band authenticator"}},"httpPath":"/oauth2/{authorizationServerId}/v1/oob-authenticate"}]},{"type":"group","label":"Global Token Revocation","link":"/openapi/okta-oauth/oauth/globaltokenrevocation","routeSlug":"/openapi/okta-oauth/oauth/globaltokenrevocation","items":[{"label":"Initiate the global revocation of all tokens and sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/globaltokenrevocation/globaltokenrevocation","routeSlug":"/openapi/okta-oauth/oauth/globaltokenrevocation/globaltokenrevocation","metadata":{"seo":{"title":"Initiate the global revocation of all tokens and sessions","description":"
"}},"httpPath":"/oauth2/v1/global-token-revocation"}]},{"type":"group","label":"Org Authorization Server","link":"/openapi/okta-oauth/oauth/orgas","routeSlug":"/openapi/okta-oauth/oauth/orgas","items":[{"label":"Retrieve the OpenID Connect metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/getwellknownopenidconfiguration","routeSlug":"/openapi/okta-oauth/oauth/orgas/getwellknownopenidconfiguration","metadata":{"seo":{"title":"Retrieve the OpenID Connect metadata","description":"
CORS
"}},"httpPath":"/.well-known/openid-configuration"},{"label":"/authorize","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/authorize","routeSlug":"/openapi/okta-oauth/oauth/orgas/authorize","metadata":{"seo":{"title":"/authorize","description":"This is a starting point for browser-based OpenID Connect flows such as the implicit and authorization code flows. This request authenticates the user and returns tokens along with an authorization grant to the client app as a part of the callback response."}},"httpPath":"/oauth2/v1/authorize"},{"label":"/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/authorizewithpost","routeSlug":"/openapi/okta-oauth/oauth/orgas/authorizewithpost","metadata":{"seo":{"title":"/authorize","description":"This is a starting point for browser-based OpenID Connect flows such as the implicit and authorization code flows. This endpoint method behaves the same as GET /oauth2/v1/authorize, except that all parameters are specified in the request body and submitted through the form post. No query parameters are allowed."}},"httpPath":"/oauth2/v1/authorize"},{"label":"/bc/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/bcauthorize","routeSlug":"/openapi/okta-oauth/oauth/orgas/bcauthorize","metadata":{"seo":{"title":"/bc/authorize","description":"This endpoint returns a unique identifier (auth_req_id) that identifies the authentication flow while it tries to authenticate the user in the background. This auth_req_id value is used in subsequent token requests to the /token endpoint."}},"httpPath":"/oauth2/v1/bc/authorize"},{"label":"/challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/challenge","routeSlug":"/openapi/okta-oauth/oauth/orgas/challenge","metadata":{"seo":{"title":"/challenge","description":"Initiates the challenge of subsequent factor(s) in a direct authentication flow after the token endpoint has responded with mfa_required. This endpoint is optional if the client is able to proceed without it, for example, when the client knows it needs to follow up with an OTP and can prompt the end user for one."}},"httpPath":"/oauth2/v1/challenge"},{"label":"/device/authorize","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/deviceauthorize","routeSlug":"/openapi/okta-oauth/oauth/orgas/deviceauthorize","metadata":{"seo":{"title":"/device/authorize","description":"
CORS
"}},"httpPath":"/oauth2/v1/device/authorize"},{"label":"/introspect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/introspect","routeSlug":"/openapi/okta-oauth/oauth/orgas/introspect","metadata":{"seo":{"title":"/introspect","description":"
CORS
"}},"httpPath":"/oauth2/v1/introspect"},{"label":"/keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/oauthkeys","routeSlug":"/openapi/okta-oauth/oauth/orgas/oauthkeys","metadata":{"seo":{"title":"/keys","description":"
CORS
"}},"httpPath":"/oauth2/v1/keys"},{"label":"/logout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/logout","routeSlug":"/openapi/okta-oauth/oauth/orgas/logout","metadata":{"seo":{"title":"/logout","description":"Use this operation to sign a user out by removing their Okta browser session."}},"httpPath":"/oauth2/v1/logout"},{"label":"/logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/logoutwithpost","routeSlug":"/openapi/okta-oauth/oauth/orgas/logoutwithpost","metadata":{"seo":{"title":"/logout","description":"Use this operation to sign a user out by removing their Okta browser session. This is the recommended method over GET as you can wrap the parameters in the request body."}},"httpPath":"/oauth2/v1/logout"},{"label":"/par","deprecated":false,"httpVerb":"options","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/paroptions","routeSlug":"/openapi/okta-oauth/oauth/orgas/paroptions","metadata":{"seo":{"title":"/par","description":"
Identity Engine
"}},"httpPath":"/oauth2/v1/par"},{"label":"/par","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/par","routeSlug":"/openapi/okta-oauth/oauth/orgas/par","metadata":{"seo":{"title":"/par","description":"
Identity Engine
"}},"httpPath":"/oauth2/v1/par"},{"label":"/primary-authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/primary-authenticate","routeSlug":"/openapi/okta-oauth/oauth/orgas/primary-authenticate","metadata":{"seo":{"title":"/primary-authenticate","description":"Initiates direct authentication with an out-of-band authenticator"}},"httpPath":"/oauth2/v1/primary-authenticate"},{"label":"/revoke","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/revoke","routeSlug":"/openapi/okta-oauth/oauth/orgas/revoke","metadata":{"seo":{"title":"/revoke","description":"
CORS
"}},"httpPath":"/oauth2/v1/revoke"},{"label":"/token","deprecated":false,"httpVerb":"options","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/tokenoptions","routeSlug":"/openapi/okta-oauth/oauth/orgas/tokenoptions","metadata":{"seo":{"title":"/token","description":"Use this operation to request the permitted communication options for the /token operation."}},"httpPath":"/oauth2/v1/token"},{"label":"/token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/token","routeSlug":"/openapi/okta-oauth/oauth/orgas/token","metadata":{"seo":{"title":"/token","description":"This endpoint returns access tokens, ID tokens, and refresh tokens depending on the request parameters. For password, client credentials, SAML 2.0 assertion, and refresh token flows, calling /token is the only step of the flow. For the authorization code flow, calling /token is the second step of the flow."}},"httpPath":"/oauth2/v1/token"},{"label":"/userinfo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/userinfo","routeSlug":"/openapi/okta-oauth/oauth/orgas/userinfo","metadata":{"seo":{"title":"/userinfo","description":""}},"httpPath":"/oauth2/v1/userinfo"},{"label":"/oob-authenticate","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/orgas/oob-authenticate","routeSlug":"/openapi/okta-oauth/oauth/orgas/oob-authenticate","metadata":{"seo":{"title":"/oob-authenticate","description":"Initiates direct authentication with an out-of-band authenticator"}},"httpPath":"/oauth2/v1/oob-authenticate"}]},{"label":"/oauth2/v1/challenge","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1challenge/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1challenge/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/v1/challenge"}},"httpPath":"/oauth2/v1/challenge"},{"label":"/oauth2/v1/global-token-revocation","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1global-token-revocation/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1global-token-revocation/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/v1/global-token-revocation"}},"httpPath":"/oauth2/v1/global-token-revocation"},{"label":"/oauth2/v1/oob-authenticate","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1oob-authenticate/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1oob-authenticate/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/v1/oob-authenticate"}},"httpPath":"/oauth2/v1/oob-authenticate"},{"label":"/oauth2/v1/primary-authenticate","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1primary-authenticate/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1v1~1primary-authenticate/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/v1/primary-authenticate"}},"httpPath":"/oauth2/v1/primary-authenticate"},{"label":"/oauth2/{authorizationServerId}/v1/challenge","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1challenge/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1challenge/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/{authorizationServerId}/v1/challenge"}},"httpPath":"/oauth2/{authorizationServerId}/v1/challenge"},{"label":"/oauth2/{authorizationServerId}/v1/oob-authenticate","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1oob-authenticate/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1oob-authenticate/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/{authorizationServerId}/v1/oob-authenticate"}},"httpPath":"/oauth2/{authorizationServerId}/v1/oob-authenticate"},{"label":"/oauth2/{authorizationServerId}/v1/primary-authenticate","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1primary-authenticate/x-okta-lifecycle","routeSlug":"/openapi/okta-oauth/oauth/paths/~1oauth2~1{authorizationserverid}~1v1~1primary-authenticate/x-okta-lifecycle","metadata":{"seo":{"title":"/oauth2/{authorizationServerId}/v1/primary-authenticate"}},"httpPath":"/oauth2/{authorizationServerId}/v1/primary-authenticate"}]},{"type":"group","label":"SCIM Protocol","items":[{"type":"link","fsPath":"openapi/okta-scim/guides/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/okta-scim/guides","routeSlug":"/openapi/okta-scim/guides"},{"type":"link","fsPath":"openapi/okta-scim/guides/scim-20/index.md","metadata":{"type":"markdown"},"label":"SCIM V2.0","link":"/openapi/okta-scim/guides/scim-20","routeSlug":"/openapi/okta-scim/guides/scim-20"},{"type":"link","fsPath":"openapi/okta-scim/guides/scim-11/index.md","metadata":{"type":"markdown"},"label":"SCIM V1.1","link":"/openapi/okta-scim/guides/scim-11","routeSlug":"/openapi/okta-scim/guides/scim-11"}]},{"type":"group","label":"Okta Admin Management","items":[{"type":"link","fsPath":"openapi/okta-management/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/okta-management/guides/overview","routeSlug":"/openapi/okta-management/guides/overview"},{"type":"link","fsPath":"openapi/okta-management/guides/roles.md","metadata":{"type":"markdown"},"label":"Roles in Okta","link":"/openapi/okta-management/guides/roles","routeSlug":"/openapi/okta-management/guides/roles"},{"type":"link","fsPath":"openapi/okta-management/guides/permissions.md","metadata":{"type":"markdown"},"label":"Permissions in Okta","link":"/openapi/okta-management/guides/permissions","routeSlug":"/openapi/okta-management/guides/permissions"},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/system-log-query/","label":"System Log query","external":true}]},{"type":"group","label":"Okta Admin Management API","items":[{"type":"group","label":"Access Controls","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/apitoken.yaml","link":"/openapi/okta-management/management/tags/apitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken","label":"API Tokens","items":[{"type":"group","label":"API Tokens","link":"/openapi/okta-management/management/tags/apitoken/apitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken/apitoken","items":[]},{"label":"List all API token metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apitoken/other/listapitokens","routeSlug":"/openapi/okta-management/management/tags/apitoken/other/listapitokens","metadata":{"seo":{"title":"List all API token metadata","description":"
"}},"httpPath":"/api/v1/api-tokens"},{"label":"Revoke the current API token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apitoken/other/revokecurrentapitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken/other/revokecurrentapitoken","metadata":{"seo":{"title":"Revoke the current API token","description":"Revokes the API token provided in the Authorization header"}},"httpPath":"/api/v1/api-tokens/current"},{"label":"Retrieve an API token's metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apitoken/other/getapitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken/other/getapitoken","metadata":{"seo":{"title":"Retrieve an API token's metadata","description":"
"}},"httpPath":"/api/v1/api-tokens/{apiTokenId}"},{"label":"Upsert an API token network condition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apitoken/other/upsertapitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken/other/upsertapitoken","metadata":{"seo":{"title":"Upsert an API token network condition","description":"
"}},"httpPath":"/api/v1/api-tokens/{apiTokenId}"},{"label":"Revoke an API token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apitoken/other/revokeapitoken","routeSlug":"/openapi/okta-management/management/tags/apitoken/other/revokeapitoken","metadata":{"seo":{"title":"Revoke an API token","description":"
"}},"httpPath":"/api/v1/api-tokens/{apiTokenId}"}],"metadata":{"type":"openapi","title":"API Tokens","description":"The API Tokens API provides operations to manage SSWS API tokens for your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/attackprotection.yaml","link":"/openapi/okta-management/management/tags/attackprotection","routeSlug":"/openapi/okta-management/management/tags/attackprotection","label":"Attack Protection","items":[{"type":"group","label":"Attack Protection","link":"/openapi/okta-management/management/tags/attackprotection/attackprotection","routeSlug":"/openapi/okta-management/management/tags/attackprotection/attackprotection","items":[]},{"label":"Retrieve the authenticator settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/attackprotection/other/getauthenticatorsettings","routeSlug":"/openapi/okta-management/management/tags/attackprotection/other/getauthenticatorsettings","metadata":{"seo":{"title":"Retrieve the authenticator settings","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.orgs.read
"}},"httpPath":"/attack-protection/api/v1/authenticator-settings"},{"label":"Replace the authenticator settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/attackprotection/other/replaceauthenticatorsettings","routeSlug":"/openapi/okta-management/management/tags/attackprotection/other/replaceauthenticatorsettings","metadata":{"seo":{"title":"Replace the authenticator settings","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.orgs.manage
"}},"httpPath":"/attack-protection/api/v1/authenticator-settings"},{"label":"Retrieve the user lockout settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/attackprotection/other/getuserlockoutsettings","routeSlug":"/openapi/okta-management/management/tags/attackprotection/other/getuserlockoutsettings","metadata":{"seo":{"title":"Retrieve the user lockout settings","description":"
"}},"httpPath":"/attack-protection/api/v1/user-lockout-settings"},{"label":"Replace the user lockout settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/attackprotection/other/replaceuserlockoutsettings","routeSlug":"/openapi/okta-management/management/tags/attackprotection/other/replaceuserlockoutsettings","metadata":{"seo":{"title":"Replace the user lockout settings","description":"
"}},"httpPath":"/attack-protection/api/v1/user-lockout-settings"}],"metadata":{"type":"openapi","title":"Attack Protection","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/behavior.yaml","link":"/openapi/okta-management/management/tags/behavior","routeSlug":"/openapi/okta-management/management/tags/behavior","label":"Behavior Rules","items":[{"type":"group","label":"Behavior Rules","link":"/openapi/okta-management/management/tags/behavior/behavior","routeSlug":"/openapi/okta-management/management/tags/behavior/behavior","items":[]},{"label":"List all behavior detection rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/listbehaviordetectionrules","routeSlug":"/openapi/okta-management/management/tags/behavior/other/listbehaviordetectionrules","metadata":{"seo":{"title":"List all behavior detection rules","description":"
"}},"httpPath":"/api/v1/behaviors"},{"label":"Create a behavior detection rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/createbehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/createbehaviordetectionrule","metadata":{"seo":{"title":"Create a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors"},{"label":"Retrieve a behavior detection rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/getbehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/getbehaviordetectionrule","metadata":{"seo":{"title":"Retrieve a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors/{behaviorId}"},{"label":"Replace a behavior detection rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/replacebehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/replacebehaviordetectionrule","metadata":{"seo":{"title":"Replace a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors/{behaviorId}"},{"label":"Delete a behavior detection rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/deletebehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/deletebehaviordetectionrule","metadata":{"seo":{"title":"Delete a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors/{behaviorId}"},{"label":"Activate a behavior detection rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/activatebehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/activatebehaviordetectionrule","metadata":{"seo":{"title":"Activate a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors/{behaviorId}/lifecycle/activate"},{"label":"Deactivate a behavior detection rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/behavior/other/deactivatebehaviordetectionrule","routeSlug":"/openapi/okta-management/management/tags/behavior/other/deactivatebehaviordetectionrule","metadata":{"seo":{"title":"Deactivate a behavior detection rule","description":"
"}},"httpPath":"/api/v1/behaviors/{behaviorId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Behavior Rules","description":"The Behavior Rules API provides operations to manage the behavior detection rules for your organization."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/botprotection.yaml","link":"/openapi/okta-management/management/tags/botprotection","routeSlug":"/openapi/okta-management/management/tags/botprotection","label":"Bot Protection","items":[{"type":"group","label":"Bot Protection","link":"/openapi/okta-management/management/tags/botprotection/botprotection","routeSlug":"/openapi/okta-management/management/tags/botprotection/botprotection","items":[]},{"label":"Retrieve the bot protection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/botprotection/other/getbotprotectionconfiguration","routeSlug":"/openapi/okta-management/management/tags/botprotection/other/getbotprotectionconfiguration","metadata":{"seo":{"title":"Retrieve the bot protection configuration","description":"
"}},"httpPath":"/api/v1/bot-protection/configuration"},{"label":"Update the bot protection configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/botprotection/other/updatebotprotectionconfiguration","routeSlug":"/openapi/okta-management/management/tags/botprotection/other/updatebotprotectionconfiguration","metadata":{"seo":{"title":"Update the bot protection configuration","description":"
"}},"httpPath":"/api/v1/bot-protection/configuration"}],"metadata":{"type":"openapi","title":"Bot Protection","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/breachedcredentialprotection.yaml","link":"/openapi/okta-management/management/tags/breachedcredentialprotection","routeSlug":"/openapi/okta-management/management/tags/breachedcredentialprotection","label":"Breached Credential Protection","items":[{"type":"group","label":"Breached Credential Protection","link":"/openapi/okta-management/management/tags/breachedcredentialprotection/breachedcredentialprotection","routeSlug":"/openapi/okta-management/management/tags/breachedcredentialprotection/breachedcredentialprotection","items":[]},{"label":"Retrieve the breached credential protection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/breachedcredentialprotection/other/getbreachedcredentialprotectionconfiguration","routeSlug":"/openapi/okta-management/management/tags/breachedcredentialprotection/other/getbreachedcredentialprotectionconfiguration","metadata":{"seo":{"title":"Retrieve the breached credential protection configuration","description":"
"}},"httpPath":"/api/v1/breached-credential-protection/configuration"},{"label":"Replace the breached credential protection configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/breachedcredentialprotection/other/replacebreachedcredentialprotectionconfiguration","routeSlug":"/openapi/okta-management/management/tags/breachedcredentialprotection/other/replacebreachedcredentialprotectionconfiguration","metadata":{"seo":{"title":"Replace the breached credential protection configuration","description":"
"}},"httpPath":"/api/v1/breached-credential-protection/configuration"}],"metadata":{"type":"openapi","title":"Breached Credential Protection","description":"This feature helps you detect breached credentials in your Okta environment and customize their remediation.\n\nOkta monitors third-party lists of public data breaches for username-password combinations in your org. When a user signs in, Okta checks if their credentials appear in a list. If so, Okta expires the password according to the password policy configuration, and the results can include user logout, password expiry, and custom workflows. Okta records the `security.breached_credential.detected` event in the System Log, and the user is required to reset their password the next time they attempt to sign in."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/captcha.yaml","link":"/openapi/okta-management/management/tags/captcha","routeSlug":"/openapi/okta-management/management/tags/captcha","label":"CAPTCHAs","items":[{"type":"group","label":"CAPTCHAs","link":"/openapi/okta-management/management/tags/captcha/captcha","routeSlug":"/openapi/okta-management/management/tags/captcha/captcha","items":[]},{"label":"List all CAPTCHA instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/listcaptchainstances","routeSlug":"/openapi/okta-management/management/tags/captcha/other/listcaptchainstances","metadata":{"seo":{"title":"List all CAPTCHA instances","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.read
"}},"httpPath":"/api/v1/captchas"},{"label":"Create a CAPTCHA instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/createcaptchainstance","routeSlug":"/openapi/okta-management/management/tags/captcha/other/createcaptchainstance","metadata":{"seo":{"title":"Create a CAPTCHA instance","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/captchas"},{"label":"Retrieve a CAPTCHA instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/getcaptchainstance","routeSlug":"/openapi/okta-management/management/tags/captcha/other/getcaptchainstance","metadata":{"seo":{"title":"Retrieve a CAPTCHA instance","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.read
"}},"httpPath":"/api/v1/captchas/{captchaId}"},{"label":"Update a CAPTCHA instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/updatecaptchainstance","routeSlug":"/openapi/okta-management/management/tags/captcha/other/updatecaptchainstance","metadata":{"seo":{"title":"Update a CAPTCHA instance","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/captchas/{captchaId}"},{"label":"Replace a CAPTCHA instance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/replacecaptchainstance","routeSlug":"/openapi/okta-management/management/tags/captcha/other/replacecaptchainstance","metadata":{"seo":{"title":"Replace a CAPTCHA instance","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/captchas/{captchaId}"},{"label":"Delete a CAPTCHA instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/deletecaptchainstance","routeSlug":"/openapi/okta-management/management/tags/captcha/other/deletecaptchainstance","metadata":{"seo":{"title":"Delete a CAPTCHA instance","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/captchas/{captchaId}"},{"label":"Retrieve the org-wide CAPTCHA settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/getorgcaptchasettings","routeSlug":"/openapi/okta-management/management/tags/captcha/other/getorgcaptchasettings","metadata":{"seo":{"title":"Retrieve the org-wide CAPTCHA settings","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.read
"}},"httpPath":"/api/v1/org/captcha"},{"label":"Replace the org-wide CAPTCHA settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/replacesorgcaptchasettings","routeSlug":"/openapi/okta-management/management/tags/captcha/other/replacesorgcaptchasettings","metadata":{"seo":{"title":"Replace the org-wide CAPTCHA settings","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/org/captcha"},{"label":"Delete the org-wide CAPTCHA settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/captcha/other/deleteorgcaptchasettings","routeSlug":"/openapi/okta-management/management/tags/captcha/other/deleteorgcaptchasettings","metadata":{"seo":{"title":"Delete the org-wide CAPTCHA settings","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.captchas.manage
"}},"httpPath":"/api/v1/org/captcha"}],"metadata":{"type":"openapi","title":"CAPTCHAs","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=csh-captcha)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/networkzone.yaml","link":"/openapi/okta-management/management/tags/networkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone","label":"Network Zones","items":[{"type":"group","label":"Network Zones","link":"/openapi/okta-management/management/tags/networkzone/networkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/networkzone","items":[]},{"label":"List all network zones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/listnetworkzones","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/listnetworkzones","metadata":{"seo":{"title":"List all network zones","description":"
"}},"httpPath":"/api/v1/zones"},{"label":"Create a network zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/createnetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/createnetworkzone","metadata":{"seo":{"title":"Create a network zone","description":"
"}},"httpPath":"/api/v1/zones"},{"label":"Retrieve a network zone","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/getnetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/getnetworkzone","metadata":{"seo":{"title":"Retrieve a network zone","description":"
"}},"httpPath":"/api/v1/zones/{zoneId}"},{"label":"Replace a network zone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/replacenetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/replacenetworkzone","metadata":{"seo":{"title":"Replace a network zone","description":"
"}},"httpPath":"/api/v1/zones/{zoneId}"},{"label":"Delete a network zone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/deletenetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/deletenetworkzone","metadata":{"seo":{"title":"Delete a network zone","description":"
"}},"httpPath":"/api/v1/zones/{zoneId}"},{"label":"Activate a network zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/activatenetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/activatenetworkzone","metadata":{"seo":{"title":"Activate a network zone","description":"
"}},"httpPath":"/api/v1/zones/{zoneId}/lifecycle/activate"},{"label":"Deactivate a network zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/networkzone/other/deactivatenetworkzone","routeSlug":"/openapi/okta-management/management/tags/networkzone/other/deactivatenetworkzone","metadata":{"seo":{"title":"Deactivate a network zone","description":"
"}},"httpPath":"/api/v1/zones/{zoneId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Network Zones","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://okta-help.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/policy.yaml","link":"/openapi/okta-management/management/tags/policy","routeSlug":"/openapi/okta-management/management/tags/policy","label":"Policies","items":[{"type":"link","label":"Policy evaluation","link":"/openapi/okta-management/management/tags/policy/section/policy-evaluation","routeSlug":"/openapi/okta-management/management/tags/policy/section/policy-evaluation"},{"type":"link","label":"Rule priority","link":"/openapi/okta-management/management/tags/policy/section/rule-priority","routeSlug":"/openapi/okta-management/management/tags/policy/section/rule-priority"},{"type":"link","label":"Default rules","link":"/openapi/okta-management/management/tags/policy/section/default-rules","routeSlug":"/openapi/okta-management/management/tags/policy/section/default-rules"},{"type":"link","label":"Policy limitations","link":"/openapi/okta-management/management/tags/policy/section/policy-limitations","routeSlug":"/openapi/okta-management/management/tags/policy/section/policy-limitations"},{"type":"link","label":"App sign-in policy","link":"/openapi/okta-management/management/tags/policy/section/app-sign-in-policy","routeSlug":"/openapi/okta-management/management/tags/policy/section/app-sign-in-policy"},{"type":"link","label":"IdP discovery policy","link":"/openapi/okta-management/management/tags/policy/section/idp-discovery-policy","routeSlug":"/openapi/okta-management/management/tags/policy/section/idp-discovery-policy"},{"type":"link","label":"Password policy","link":"/openapi/okta-management/management/tags/policy/section/password-policy","routeSlug":"/openapi/okta-management/management/tags/policy/section/password-policy"},{"type":"link","label":"User profile policy","link":"/openapi/okta-management/management/tags/policy/section/user-profile-policy","routeSlug":"/openapi/okta-management/management/tags/policy/section/user-profile-policy"},{"type":"group","label":"Policies","link":"/openapi/okta-management/management/tags/policy/policy","routeSlug":"/openapi/okta-management/management/tags/policy/policy","items":[]},{"label":"List all policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/listpolicies","routeSlug":"/openapi/okta-management/management/tags/policy/other/listpolicies","metadata":{"seo":{"title":"List all policies","description":"
"}},"httpPath":"/api/v1/policies"},{"label":"Create a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/createpolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/createpolicy","metadata":{"seo":{"title":"Create a policy","description":"
"}},"httpPath":"/api/v1/policies"},{"label":"Create a policy simulation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/createpolicysimulation","routeSlug":"/openapi/okta-management/management/tags/policy/other/createpolicysimulation","metadata":{"seo":{"title":"Create a policy simulation","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/simulate"},{"label":"Retrieve a policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/getpolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/getpolicy","metadata":{"seo":{"title":"Retrieve a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}"},{"label":"Replace a policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/replacepolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/replacepolicy","metadata":{"seo":{"title":"Replace a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}"},{"label":"Delete a policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/deletepolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/deletepolicy","metadata":{"seo":{"title":"Delete a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}"},{"label":"Clone an existing policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/clonepolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/clonepolicy","metadata":{"seo":{"title":"Clone an existing policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/clone"},{"label":"Activate a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/activatepolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/activatepolicy","metadata":{"seo":{"title":"Activate a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/lifecycle/activate"},{"label":"Deactivate a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/deactivatepolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/deactivatepolicy","metadata":{"seo":{"title":"Deactivate a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/lifecycle/deactivate"},{"label":"List all resources mapped to a policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/listpolicymappings","routeSlug":"/openapi/okta-management/management/tags/policy/other/listpolicymappings","metadata":{"seo":{"title":"List all resources mapped to a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/mappings"},{"label":"Map a resource to a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/mapresourcetopolicy","routeSlug":"/openapi/okta-management/management/tags/policy/other/mapresourcetopolicy","metadata":{"seo":{"title":"Map a resource to a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/mappings"},{"label":"Retrieve a policy resource mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/getpolicymapping","routeSlug":"/openapi/okta-management/management/tags/policy/other/getpolicymapping","metadata":{"seo":{"title":"Retrieve a policy resource mapping","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/mappings/{mappingId}"},{"label":"Delete a policy resource mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/deletepolicyresourcemapping","routeSlug":"/openapi/okta-management/management/tags/policy/other/deletepolicyresourcemapping","metadata":{"seo":{"title":"Delete a policy resource mapping","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/mappings/{mappingId}"},{"label":"List all policy rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/listpolicyrules","routeSlug":"/openapi/okta-management/management/tags/policy/other/listpolicyrules","metadata":{"seo":{"title":"List all policy rules","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules"},{"label":"Create a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/createpolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/createpolicyrule","metadata":{"seo":{"title":"Create a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules"},{"label":"Retrieve a policy rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/getpolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/getpolicyrule","metadata":{"seo":{"title":"Retrieve a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules/{ruleId}"},{"label":"Replace a policy rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/replacepolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/replacepolicyrule","metadata":{"seo":{"title":"Replace a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules/{ruleId}"},{"label":"Delete a policy rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/deletepolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/deletepolicyrule","metadata":{"seo":{"title":"Delete a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules/{ruleId}"},{"label":"Activate a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/activatepolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/activatepolicyrule","metadata":{"seo":{"title":"Activate a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate"},{"label":"Deactivate a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/deactivatepolicyrule","routeSlug":"/openapi/okta-management/management/tags/policy/other/deactivatepolicyrule","metadata":{"seo":{"title":"Deactivate a policy rule","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate"},{"label":"List all apps mapped to a policy","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policy/other/listpolicyapps","routeSlug":"/openapi/okta-management/management/tags/policy/other/listpolicyapps","metadata":{"seo":{"title":"List all apps mapped to a policy","description":"
"}},"httpPath":"/api/v1/policies/{policyId}/app"}],"metadata":{"type":"openapi","title":"Policies","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://okta-developer.pixtulate.com/docs/concepts/policies/#authenticator-enrollment-policies): `MFA_ENROLL`\n* [App sign-in policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#app-sign-in-policies): `ACCESS_POLICY`\n* [Client update policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#client-update-policies): `CLIENT_UPDATE`\n* [Device signal collection policies](https://okta-developer.pixtulate.com/docs/guides/device-signal-collection-policies/main/): `DEVICE_SIGNAL_COLLECTION`\n* [Entity risk policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#identity-threat-protection-policies): `ENTITY_RISK`\n* [Global session policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#global-session-policies): `OKTA_SIGN_ON`\n* [IdP discovery policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#route-to-other-identity-providers): `IDP_DISCOVERY`\n* [Identity claims sourcing policy](https://okta-developer.pixtulate.com/docs/concepts/policies/#identity-claims-sourcing-policy): `IDENTITY_CLAIM_SOURCING`\n* [Password policies](https://okta-developer.pixtulate.com/docs/concepts/policies/#password-policies): `PASSWORD`\n* [Session violation enforcement policy](https://okta-developer.pixtulate.com/docs/concepts/policies/#identity-threat-protection-policies): `POST_AUTH_SESSION`\n* [Session violation detection policy](https://okta-developer.pixtulate.com/docs/concepts/policies/#identity-threat-protection-policies): `SESSION_VIOLATION_DETECTION`\n* [User profile policies](https://okta-developer.pixtulate.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://okta-help.pixtulate.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://okta-developer.pixtulate.com/docs/guides/multiple-identifiers/main/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/policybranch.yaml","link":"/openapi/okta-management/management/tags/policybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch","label":"Policy Branching","items":[{"type":"link","label":"Branch workflow","link":"/openapi/okta-management/management/tags/policybranch/section/branch-workflow","routeSlug":"/openapi/okta-management/management/tags/policybranch/section/branch-workflow"},{"type":"group","label":"Policy Branching","link":"/openapi/okta-management/management/tags/policybranch/policybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/policybranch","items":[]},{"label":"List all policy branches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/listpolicybranches","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/listpolicybranches","metadata":{"seo":{"title":"List all policy branches","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/branches"},{"label":"Create a policy branch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/createpolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/createpolicybranch","metadata":{"seo":{"title":"Create a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches"},{"label":"Retrieve a policy branch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/getpolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/getpolicybranch","metadata":{"seo":{"title":"Retrieve a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}"},{"label":"Replace a policy branch","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/replacepolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/replacepolicybranch","metadata":{"seo":{"title":"Replace a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}"},{"label":"Delete a policy branch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/deletepolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/deletepolicybranch","metadata":{"seo":{"title":"Delete a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}"},{"label":"Promote a policy branch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/promotepolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/promotepolicybranch","metadata":{"seo":{"title":"Promote a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/lifecycle/promote"},{"label":"Preview a policy branch promotion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/previewpolicybranchpromotion","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/previewpolicybranchpromotion","metadata":{"seo":{"title":"Preview a policy branch promotion","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/lifecycle/promote/preview"},{"label":"Stage a policy branch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/stagepolicybranch","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/stagepolicybranch","metadata":{"seo":{"title":"Stage a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/lifecycle/stage"},{"label":"List all policy branch rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/listpolicybranchrules","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/listpolicybranchrules","metadata":{"seo":{"title":"List all policy branch rules","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules"},{"label":"Create a policy branch rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/createpolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/createpolicybranchrule","metadata":{"seo":{"title":"Create a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules"},{"label":"Retrieve a policy branch rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/getpolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/getpolicybranchrule","metadata":{"seo":{"title":"Retrieve a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules/{ruleId}"},{"label":"Replace a policy branch rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/replacepolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/replacepolicybranchrule","metadata":{"seo":{"title":"Replace a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules/{ruleId}"},{"label":"Delete a policy branch rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/deletepolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/deletepolicybranchrule","metadata":{"seo":{"title":"Delete a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules/{ruleId}"},{"label":"Activate a policy branch rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/activatepolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/activatepolicybranchrule","metadata":{"seo":{"title":"Activate a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules/{ruleId}/lifecycle/activate"},{"label":"Deactivate a policy branch rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/deactivatepolicybranchrule","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/deactivatepolicybranchrule","metadata":{"seo":{"title":"Deactivate a policy branch rule","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/branches/{branchId}/rules/{ruleId}/lifecycle/deactivate"},{"label":"List the policy's branch history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/listpolicyhistory","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/listpolicyhistory","metadata":{"seo":{"title":"List the policy's branch history","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/history"},{"label":"Retrieve a policy history entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/getpolicyhistoryentry","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/getpolicyhistoryentry","metadata":{"seo":{"title":"Retrieve a policy history entry","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/history/{branchId}"},{"label":"Restore a policy branch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/restorefromhistory","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/restorefromhistory","metadata":{"seo":{"title":"Restore a policy branch","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.manage
"}},"httpPath":"/api/v1/policies/{policyId}/history/{branchId}/lifecycle/rollback"},{"label":"List all rules in a policy history entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/policybranch/other/listpolicyhistorybranchrules","routeSlug":"/openapi/okta-management/management/tags/policybranch/other/listpolicyhistorybranchrules","metadata":{"seo":{"title":"List all rules in a policy history entry","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read
"}},"httpPath":"/api/v1/policies/{policyId}/history/{branchId}/rules"}],"metadata":{"type":"openapi","title":"Policy Branching","description":" The Policy Branching API enables you to manage, test, and monitor branches of your app sign-in policies before enabling your new configuration and enforcing it for your end users and apps. This feature is only available for app sign-in (`ACCESS_POLICY` type) policies.\n\n> **Note:** This functionality is available as a self-service Early Access (EA) feature for Identity Engine orgs. To use it, enable the Change management for app sign-in policies feature. See [Self-service features](/docs/concepts/feature-lifecycle-management/#self-service-features).\n\nConceptually, policy branches work in a similar way as Git branches. However, you can only manage branches for app sign-in policies, and only operations under this API are supported for managing them. For more information about how policy branching works, see [Manage staged app sign-in policy branches](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ext-staged-policy-branches).\n\nThese are the different statuses that a policy branch can have:\n* `DRAFT`: A new branch that's created from the live policy. Rules are inherited from the live branch and can be edited. Only one `DRAFT` or `STAGED` branch can exist per policy at a time.\n* `STAGED`: A branch that has been staged can be edited and monitored. Rules can be added, updated, or deleted. And you can enable monitoring to observe how the rules behave before promoting the branch to `LIVE`. Only one `STAGED` or `DRAFT` branch can exist per policy at a time.\n* `LIVE`: The set of policy rules that are currently enforced. This is the standard branch state for an app sign-in policy.\n\nA policy can have a maximum of two branches across all statuses. When you create a new draft branch, the existing draft branch is deleted. See the following example of the number of branches a policy can have:\n\n* Policy A\n * Branch 1 (`LIVE`)\n * Branch 2 (`DRAFT` or `STAGED`)\n\n## Branch workflow\n\nThe following steps outline a typical workflow for managing policy branches:\n\n1. Create a branch of an existing live policy to make changes without affecting the active configuration. Use the Create a policy branch [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/createpolicybranch).\n2. Stage the branch. Staging changes the status from `DRAFT` to `STAGED` allows you to enable monitoring of the branch. You can also edit and update the rules of the policy branch as needed. Use the Stage a policy branch [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/stagepolicybranch).\n3. Add, update, or delete policy branch rules as needed. Rules can be modified on `STAGED` or `DRAFT` branches. Use the Create a policy branch rule [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/createpolicybranchrule) or Replace a policy branch rule [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/replacepolicybranchrule).\n4. If you're satisfied with the changes, promote the `STAGED` branch to `LIVE`, making it the active and enforced policy. Use the Promote a policy branch [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/promotepolicybranch).\n5. Optional. If you want to restore the previous live branch, review archived policy branches by using the List the policy's branch history [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/listpolicyhistory). You can then use the Restore a policy branch [endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/policybranch/other/restorepolicybranch) to restore an archived branch."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/session.yaml","link":"/openapi/okta-management/management/tags/session","routeSlug":"/openapi/okta-management/management/tags/session","label":"Sessions","items":[{"type":"link","label":"Session cookie","link":"/openapi/okta-management/management/tags/session/section/session-cookie","routeSlug":"/openapi/okta-management/management/tags/session/section/session-cookie"},{"type":"link","label":"Session token","link":"/openapi/okta-management/management/tags/session/section/session-token","routeSlug":"/openapi/okta-management/management/tags/session/section/session-token"},{"type":"group","label":"Sessions","link":"/openapi/okta-management/management/tags/session/session","routeSlug":"/openapi/okta-management/management/tags/session/session","items":[]},{"label":"Retrieve a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/session/other/getsession","routeSlug":"/openapi/okta-management/management/tags/session/other/getsession","metadata":{"seo":{"title":"Retrieve a session","description":"
"}},"httpPath":"/api/v1/sessions/{sessionId}"},{"label":"Revoke a session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/session/other/revokesession","routeSlug":"/openapi/okta-management/management/tags/session/other/revokesession","metadata":{"seo":{"title":"Revoke a session","description":"
"}},"httpPath":"/api/v1/sessions/{sessionId}"},{"label":"Refresh a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/session/other/refreshsession","routeSlug":"/openapi/okta-management/management/tags/session/other/refreshsession","metadata":{"seo":{"title":"Refresh a session","description":"
"}},"httpPath":"/api/v1/sessions/{sessionId}/lifecycle/refresh"}],"metadata":{"type":"openapi","title":"Sessions","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://okta-help.pixtulate.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://okta-developer.pixtulate.com/docs/reference/api/authn/#authentication-operations) or through OIDC using the [Resource Owner Password flow](https://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/reference/api/authn/) to validate a [user's primary credentials](https://okta-developer.pixtulate.com/docs/reference/api/authn/#primary-authentication) and secondary [MFA factor](https://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/threatinsight.yaml","link":"/openapi/okta-management/management/tags/threatinsight","routeSlug":"/openapi/okta-management/management/tags/threatinsight","label":"ThreatInsight","items":[{"type":"group","label":"ThreatInsight","link":"/openapi/okta-management/management/tags/threatinsight/threatinsight","routeSlug":"/openapi/okta-management/management/tags/threatinsight/threatinsight","items":[]},{"label":"Retrieve the ThreatInsight configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/threatinsight/other/getcurrentconfiguration","routeSlug":"/openapi/okta-management/management/tags/threatinsight/other/getcurrentconfiguration","metadata":{"seo":{"title":"Retrieve the ThreatInsight configuration","description":"
"}},"httpPath":"/api/v1/threats/configuration"},{"label":"Update the ThreatInsight configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/threatinsight/other/updateconfiguration","routeSlug":"/openapi/okta-management/management/tags/threatinsight/other/updateconfiguration","metadata":{"seo":{"title":"Update the ThreatInsight configuration","description":"
"}},"httpPath":"/api/v1/threats/configuration"}],"metadata":{"type":"openapi","title":"ThreatInsight","description":"[Okta ThreatInsight](https://okta-help.pixtulate.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://okta-help.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/trustedorigin.yaml","link":"/openapi/okta-management/management/tags/trustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin","label":"Trusted Origins","items":[{"type":"group","label":"Trusted Origins","link":"/openapi/okta-management/management/tags/trustedorigin/trustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/trustedorigin","items":[]},{"label":"List all trusted origins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/listtrustedorigins","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/listtrustedorigins","metadata":{"seo":{"title":"List all trusted origins","description":"
"}},"httpPath":"/api/v1/trustedOrigins"},{"label":"Create a trusted origin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/createtrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/createtrustedorigin","metadata":{"seo":{"title":"Create a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins"},{"label":"Retrieve a trusted origin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/gettrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/gettrustedorigin","metadata":{"seo":{"title":"Retrieve a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins/{trustedOriginId}"},{"label":"Replace a trusted origin","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/replacetrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/replacetrustedorigin","metadata":{"seo":{"title":"Replace a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins/{trustedOriginId}"},{"label":"Delete a trusted origin","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/deletetrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/deletetrustedorigin","metadata":{"seo":{"title":"Delete a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins/{trustedOriginId}"},{"label":"Activate a trusted origin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/activatetrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/activatetrustedorigin","metadata":{"seo":{"title":"Activate a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate"},{"label":"Deactivate a trusted origin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/trustedorigin/other/deactivatetrustedorigin","routeSlug":"/openapi/okta-management/management/tags/trustedorigin/other/deactivatetrustedorigin","metadata":{"seo":{"title":"Deactivate a trusted origin","description":"
"}},"httpPath":"/api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Trusted Origins","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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/)."}}]},{"type":"group","label":"Admin Roles","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/roleassignmentauser.yaml","link":"/openapi/okta-management/management/tags/roleassignmentauser","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser","label":"User Role Assignments","items":[{"type":"group","label":"User Role Assignments","link":"/openapi/okta-management/management/tags/roleassignmentauser/roleassignmentauser","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/roleassignmentauser","items":[]},{"label":"List all users with role assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/listuserswithroleassignments","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/listuserswithroleassignments","metadata":{"seo":{"title":"List all users with role assignments","description":"
"}},"httpPath":"/api/v1/iam/assignees/users"},{"label":"List all user role assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/listassignedrolesforuser","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/listassignedrolesforuser","metadata":{"seo":{"title":"List all user role assignments","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles"},{"label":"Assign a user role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/assignroletouser","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/assignroletouser","metadata":{"seo":{"title":"Assign a user role","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles"},{"label":"Retrieve a user role assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/getuserassignedrole","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/getuserassignedrole","metadata":{"seo":{"title":"Retrieve a user role assignment","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}"},{"label":"Unassign a user role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/unassignrolefromuser","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/unassignrolefromuser","metadata":{"seo":{"title":"Unassign a user role","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}"},{"label":"Retrieve all user role governance sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/getuserassignedrolegovernance","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/getuserassignedrolegovernance","metadata":{"seo":{"title":"Retrieve all user role governance sources","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/governance"},{"label":"Retrieve a user role governance source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/getroleassignmentgovernancegrant","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/getroleassignmentgovernancegrant","metadata":{"seo":{"title":"Retrieve a user role governance source","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/governance/{grantId}"},{"label":"Retrieve the user role governance source resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentauser/other/getroleassignmentgovernancegrantresources","routeSlug":"/openapi/okta-management/management/tags/roleassignmentauser/other/getroleassignmentgovernancegrantresources","metadata":{"seo":{"title":"Retrieve the user role governance source resources","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/governance/{grantId}/resources"}],"metadata":{"type":"openapi","title":"User Role Assignments","description":"The User Role Assignments APIs allow you to assign roles and designate third-party admin status to users."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roleassignmentbgroup.yaml","link":"/openapi/okta-management/management/tags/roleassignmentbgroup","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup","label":"Group Role Assignments","items":[{"type":"group","label":"Group Role Assignments","link":"/openapi/okta-management/management/tags/roleassignmentbgroup/roleassignmentbgroup","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup/roleassignmentbgroup","items":[]},{"label":"List all group role assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/listgroupassignedroles","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/listgroupassignedroles","metadata":{"seo":{"title":"List all group role assignments","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles"},{"label":"Assign a role to a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/assignroletogroup","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/assignroletogroup","metadata":{"seo":{"title":"Assign a role to a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles"},{"label":"Retrieve a group role assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/getgroupassignedrole","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/getgroupassignedrole","metadata":{"seo":{"title":"Retrieve a group role assignment","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}"},{"label":"Unassign a group role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/unassignrolefromgroup","routeSlug":"/openapi/okta-management/management/tags/roleassignmentbgroup/other/unassignrolefromgroup","metadata":{"seo":{"title":"Unassign a group role","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}"}],"metadata":{"type":"openapi","title":"Group Role Assignments","description":"The Group Role Assignments APIs allow you to assign roles and designate third-party admin status to groups."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roleassignmentclient.yaml","link":"/openapi/okta-management/management/tags/roleassignmentclient","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient","label":"Client Role Assignments","items":[{"type":"group","label":"Client Role Assignments","link":"/openapi/okta-management/management/tags/roleassignmentclient/roleassignmentclient","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient/roleassignmentclient","items":[]},{"label":"List all client role assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentclient/other/listrolesforclient","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient/other/listrolesforclient","metadata":{"seo":{"title":"List all client role assignments","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles"},{"label":"Assign a client role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentclient/other/assignroletoclient","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient/other/assignroletoclient","metadata":{"seo":{"title":"Assign a client role","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles"},{"label":"Retrieve a client role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentclient/other/retrieveclientrole","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient/other/retrieveclientrole","metadata":{"seo":{"title":"Retrieve a client role","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}"},{"label":"Unassign a client role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleassignmentclient/other/deleterolefromclient","routeSlug":"/openapi/okta-management/management/tags/roleassignmentclient/other/deleterolefromclient","metadata":{"seo":{"title":"Unassign a client role","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}"}],"metadata":{"type":"openapi","title":"Client Role Assignments","description":"The Client Role Assignments APIs allow you to assign roles and designate third-party admin status to public client apps."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/rolebtargetadmin.yaml","link":"/openapi/okta-management/management/tags/rolebtargetadmin","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin","label":"User Role Targets","items":[{"type":"group","label":"User Role Targets","link":"/openapi/okta-management/management/tags/rolebtargetadmin/rolebtargetadmin","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/rolebtargetadmin","items":[]},{"label":"List all admin role app targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/listapplicationtargetsforapplicationadministratorroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/listapplicationtargetsforapplicationadministratorroleforuser","metadata":{"seo":{"title":"List all admin role app targets","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps"},{"label":"Assign all apps as target to admin role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignallappsastargettoroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignallappsastargettoroleforuser","metadata":{"seo":{"title":"Assign all apps as target to admin role","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps"},{"label":"Assign an admin role app target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignapptargettoadminroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignapptargettoadminroleforuser","metadata":{"seo":{"title":"Assign an admin role app target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Unassign an admin role app target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassignapptargetfromappadminroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassignapptargetfromappadminroleforuser","metadata":{"seo":{"title":"Unassign an admin role app target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Assign an admin role app instance target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignappinstancetargettoappadminroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assignappinstancetargettoappadminroleforuser","metadata":{"seo":{"title":"Assign an admin role app instance target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"Unassign an admin role app instance target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassignappinstancetargetfromadminroleforuser","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassignappinstancetargetfromadminroleforuser","metadata":{"seo":{"title":"Unassign an admin role app instance target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"List all admin role group targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/listgrouptargetsforrole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/listgrouptargetsforrole","metadata":{"seo":{"title":"List all admin role group targets","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/groups"},{"label":"Assign an admin role group target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assigngrouptargettouserrole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/assigngrouptargettouserrole","metadata":{"seo":{"title":"Assign an admin role group target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/groups/{groupId}"},{"label":"Unassign an admin role group target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassigngrouptargetfromuseradminrole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/unassigngrouptargetfromuseradminrole","metadata":{"seo":{"title":"Unassign an admin role group target","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/groups/{groupId}"},{"label":"Retrieve a role target by assignment type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetadmin/other/getroletargetsbyuseridandroleid","routeSlug":"/openapi/okta-management/management/tags/rolebtargetadmin/other/getroletargetsbyuseridandroleid","metadata":{"seo":{"title":"Retrieve a role target by assignment type","description":"
"}},"httpPath":"/api/v1/users/{userId}/roles/{roleIdOrEncodedRoleId}/targets"}],"metadata":{"type":"openapi","title":"User Role Targets","description":"User role targets are a way of limiting the app or group resources for a [standard role](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://okta-developer.pixtulate.com/docs/concepts/role-assignment/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/rolebtargetbgroup.yaml","link":"/openapi/okta-management/management/tags/rolebtargetbgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup","label":"Group Role Targets","items":[{"type":"group","label":"Group Role Targets","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/rolebtargetbgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/rolebtargetbgroup","items":[]},{"label":"List all group role app targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/listapplicationtargetsforapplicationadministratorroleforgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/listapplicationtargetsforapplicationadministratorroleforgroup","metadata":{"seo":{"title":"List all group role app targets","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps"},{"label":"Assign a group role app target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assignapptargettoadminroleforgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assignapptargettoadminroleforgroup","metadata":{"seo":{"title":"Assign a group role app target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Unassign a group role app target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassignapptargettoadminroleforgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassignapptargettoadminroleforgroup","metadata":{"seo":{"title":"Unassign a group role app target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Assign a group role app instance target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assignappinstancetargettoappadminroleforgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assignappinstancetargettoappadminroleforgroup","metadata":{"seo":{"title":"Assign a group role app instance target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"Unassign a group role app instance target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassignappinstancetargettoappadminroleforgroup","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassignappinstancetargettoappadminroleforgroup","metadata":{"seo":{"title":"Unassign a group role app instance target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"List all group role group targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/listgrouptargetsforgrouprole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/listgrouptargetsforgrouprole","metadata":{"seo":{"title":"List all group role group targets","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups"},{"label":"Assign a group role group target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assigngrouptargettogroupadminrole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/assigngrouptargettogroupadminrole","metadata":{"seo":{"title":"Assign a group role group target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}"},{"label":"Unassign a group role group target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassigngrouptargetfromgroupadminrole","routeSlug":"/openapi/okta-management/management/tags/rolebtargetbgroup/other/unassigngrouptargetfromgroupadminrole","metadata":{"seo":{"title":"Unassign a group role group target","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}"}],"metadata":{"type":"openapi","title":"Group Role Targets","description":"Group role targets allow you to limit the app or group resources for a [standard role](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://okta-developer.pixtulate.com/docs/concepts/role-assignment/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/rolebtargetclient.yaml","link":"/openapi/okta-management/management/tags/rolebtargetclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient","label":"Client Role Targets","items":[{"type":"group","label":"Client Role Targets","link":"/openapi/okta-management/management/tags/rolebtargetclient/rolebtargetclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/rolebtargetclient","items":[]},{"label":"List all client role app targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/listapptargetroletoclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/listapptargetroletoclient","metadata":{"seo":{"title":"List all client role app targets","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps"},{"label":"Assign a client role app target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/assignapptargetroletoclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/assignapptargetroletoclient","metadata":{"seo":{"title":"Assign a client role app target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Unassign a client role app target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/removeapptargetrolefromclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/removeapptargetrolefromclient","metadata":{"seo":{"title":"Unassign a client role app target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}"},{"label":"Assign a client role app instance target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/assignapptargetinstanceroleforclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/assignapptargetinstanceroleforclient","metadata":{"seo":{"title":"Assign a client role app instance target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"Unassign a client role app instance target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/removeapptargetinstanceroleforclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/removeapptargetinstanceroleforclient","metadata":{"seo":{"title":"Unassign a client role app instance target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}"},{"label":"List all client role group targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/listgrouptargetroleforclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/listgrouptargetroleforclient","metadata":{"seo":{"title":"List all client role group targets","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/groups"},{"label":"Assign a client role group target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/assigngrouptargetroleforclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/assigngrouptargetroleforclient","metadata":{"seo":{"title":"Assign a client role group target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/groups/{groupId}"},{"label":"Unassign a client role group target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolebtargetclient/other/removegrouptargetrolefromclient","routeSlug":"/openapi/okta-management/management/tags/rolebtargetclient/other/removegrouptargetrolefromclient","metadata":{"seo":{"title":"Unassign a client role group target","description":"
"}},"httpPath":"/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/groups/{groupId}"}],"metadata":{"type":"openapi","title":"Client Role Targets","description":"Client role targets allow you to limit the app or group resources for a [standard role](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://okta-developer.pixtulate.com/docs/concepts/role-assignment/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/rolecresourceset.yaml","link":"/openapi/okta-management/management/tags/rolecresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset","label":"Resource Sets","items":[{"type":"group","label":"Resource Sets","link":"/openapi/okta-management/management/tags/rolecresourceset/rolecresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/rolecresourceset","items":[]},{"label":"List all resource sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourceset/other/listresourcesets","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/other/listresourcesets","metadata":{"seo":{"title":"List all resource sets","description":"
"}},"httpPath":"/api/v1/iam/resource-sets"},{"label":"Create a resource set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourceset/other/createresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/other/createresourceset","metadata":{"seo":{"title":"Create a resource set","description":"
"}},"httpPath":"/api/v1/iam/resource-sets"},{"label":"Retrieve a resource set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourceset/other/getresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/other/getresourceset","metadata":{"seo":{"title":"Retrieve a resource set","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}"},{"label":"Replace a resource set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourceset/other/replaceresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/other/replaceresourceset","metadata":{"seo":{"title":"Replace a resource set","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}"},{"label":"Delete a resource set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourceset/other/deleteresourceset","routeSlug":"/openapi/okta-management/management/tags/rolecresourceset/other/deleteresourceset","metadata":{"seo":{"title":"Delete a resource set","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}"}],"metadata":{"type":"openapi","title":"Resource Sets","description":"The Resource Sets API provides operations to manage resource sets as a custom set of resources. See [Supported resources](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/roles/#supported-resources)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/rolecresourcesetresource.yaml","link":"/openapi/okta-management/management/tags/rolecresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource","label":"Resource Set Resources","items":[{"type":"group","label":"Resource Set Resources","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/rolecresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/rolecresourcesetresource","items":[]},{"label":"List all resource set resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/listresourcesetresources","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/listresourcesetresources","metadata":{"seo":{"title":"List all resource set resources","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources"},{"label":"Add a resource set resource with conditions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/addresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/addresourcesetresource","metadata":{"seo":{"title":"Add a resource set resource with conditions","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources"},{"label":"Add more resources to a resource set","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/addresourcesetresources","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/addresourcesetresources","metadata":{"seo":{"title":"Add more resources to a resource set","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources"},{"label":"Retrieve a resource set resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/getresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/getresourcesetresource","metadata":{"seo":{"title":"Retrieve a resource set resource","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}"},{"label":"Replace the resource set resource conditions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/replaceresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/replaceresourcesetresource","metadata":{"seo":{"title":"Replace the resource set resource conditions","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}"},{"label":"Delete a resource set resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/deleteresourcesetresource","routeSlug":"/openapi/okta-management/management/tags/rolecresourcesetresource/other/deleteresourcesetresource","metadata":{"seo":{"title":"Delete a resource set resource","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}"}],"metadata":{"type":"openapi","title":"Resource Set Resources","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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/roles/#supported-resources)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roledresourcesetbinding.yaml","link":"/openapi/okta-management/management/tags/roledresourcesetbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding","label":"Role Resource Set Bindings","items":[{"type":"group","label":"Role Resource Set Bindings","link":"/openapi/okta-management/management/tags/roledresourcesetbinding/roledresourcesetbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding/roledresourcesetbinding","items":[]},{"label":"List all role resource set bindings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/listbindings","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/listbindings","metadata":{"seo":{"title":"List all role resource set bindings","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings"},{"label":"Create a role resource set binding","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/createresourcesetbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/createresourcesetbinding","metadata":{"seo":{"title":"Create a role resource set binding","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings"},{"label":"Retrieve a role resource set binding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/getbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/getbinding","metadata":{"seo":{"title":"Retrieve a role resource set binding","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}"},{"label":"Delete a role resource set binding","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/deletebinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbinding/other/deletebinding","metadata":{"seo":{"title":"Delete a role resource set binding","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}"}],"metadata":{"type":"openapi","title":"Role Resource Set Bindings","description":"The Role Resource Set Bindings API provides operations to assign members to a [Custom Role](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/roleecustom/) that targets resources in a [Resource Set](https://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roledresourcesetbindingmember.yaml","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember","label":"Role Resource Set Binding Members","items":[{"type":"group","label":"Role Resource Set Binding Members","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/roledresourcesetbindingmember","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/roledresourcesetbindingmember","items":[]},{"label":"List all role resource set binding members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/listmembersofbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/listmembersofbinding","metadata":{"seo":{"title":"List all role resource set binding members","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members"},{"label":"Add more role resource set binding members","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/addmemberstobinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/addmemberstobinding","metadata":{"seo":{"title":"Add more role resource set binding members","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members"},{"label":"Retrieve a role resource set binding member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/getmemberofbinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/getmemberofbinding","metadata":{"seo":{"title":"Retrieve a role resource set binding member","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}"},{"label":"Unassign a role resource set binding member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/unassignmemberfrombinding","routeSlug":"/openapi/okta-management/management/tags/roledresourcesetbindingmember/other/unassignmemberfrombinding","metadata":{"seo":{"title":"Unassign a role resource set binding member","description":"
"}},"httpPath":"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}"}],"metadata":{"type":"openapi","title":"Role Resource Set Binding Members","description":"The Role Resource Set Binding Members API provides operations to manage members in a [Role Resource Set Binding](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/RoleDResourceSetBinding/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roleecustom.yaml","link":"/openapi/okta-management/management/tags/roleecustom","routeSlug":"/openapi/okta-management/management/tags/roleecustom","label":"Custom Roles","items":[{"type":"group","label":"Custom Roles","link":"/openapi/okta-management/management/tags/roleecustom/roleecustom","routeSlug":"/openapi/okta-management/management/tags/roleecustom/roleecustom","items":[]},{"label":"List all custom roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustom/other/listroles","routeSlug":"/openapi/okta-management/management/tags/roleecustom/other/listroles","metadata":{"seo":{"title":"List all custom roles","description":"
"}},"httpPath":"/api/v1/iam/roles"},{"label":"Create a custom role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustom/other/createrole","routeSlug":"/openapi/okta-management/management/tags/roleecustom/other/createrole","metadata":{"seo":{"title":"Create a custom role","description":"
"}},"httpPath":"/api/v1/iam/roles"},{"label":"Retrieve a role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustom/other/getrole","routeSlug":"/openapi/okta-management/management/tags/roleecustom/other/getrole","metadata":{"seo":{"title":"Retrieve a role","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}"},{"label":"Replace a custom role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustom/other/replacerole","routeSlug":"/openapi/okta-management/management/tags/roleecustom/other/replacerole","metadata":{"seo":{"title":"Replace a custom role","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}"},{"label":"Delete a custom role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustom/other/deleterole","routeSlug":"/openapi/okta-management/management/tags/roleecustom/other/deleterole","metadata":{"seo":{"title":"Delete a custom role","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}"}],"metadata":{"type":"openapi","title":"Custom Roles","description":"The Custom Roles API provides operations to manage custom roles that limit an admin's access to a subset of permissions and resources."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/roleecustompermission.yaml","link":"/openapi/okta-management/management/tags/roleecustompermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission","label":"Custom Role Permissions","items":[{"type":"group","label":"Custom Role Permissions","link":"/openapi/okta-management/management/tags/roleecustompermission/roleecustompermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/roleecustompermission","items":[]},{"label":"List all custom role permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustompermission/other/listrolepermissions","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/other/listrolepermissions","metadata":{"seo":{"title":"List all custom role permissions","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}/permissions"},{"label":"Retrieve a custom role permission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustompermission/other/getrolepermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/other/getrolepermission","metadata":{"seo":{"title":"Retrieve a custom role permission","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}"},{"label":"Create a custom role permission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustompermission/other/createrolepermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/other/createrolepermission","metadata":{"seo":{"title":"Create a custom role permission","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}"},{"label":"Replace a custom role permission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustompermission/other/replacerolepermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/other/replacerolepermission","metadata":{"seo":{"title":"Replace a custom role permission","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}"},{"label":"Delete a custom role permission","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/roleecustompermission/other/deleterolepermission","routeSlug":"/openapi/okta-management/management/tags/roleecustompermission/other/deleterolepermission","metadata":{"seo":{"title":"Delete a custom role permission","description":"
"}},"httpPath":"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}"}],"metadata":{"type":"openapi","title":"Custom Role Permissions","description":"The Custom Role Permissions API provides operations to manage the permissions assigned to a custom role."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/governancebundle.yaml","link":"/openapi/okta-management/management/tags/governancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle","label":"IAM Governance Bundles","items":[{"type":"group","label":"IAM Governance Bundles","link":"/openapi/okta-management/management/tags/governancebundle/governancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/governancebundle","items":[]},{"label":"/api/v1/iam/governance/bundles","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v1/iam/governance/bundles"}},"httpPath":"/api/v1/iam/governance/bundles"},{"label":"List all governance bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/listgovernancebundles","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/listgovernancebundles","metadata":{"seo":{"title":"List all governance bundles","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles"},{"label":"Create a governance bundle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/creategovernancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/creategovernancebundle","metadata":{"seo":{"title":"Create a governance bundle","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles"},{"label":"/api/v1/iam/governance/bundles/{bundleId}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v1/iam/governance/bundles/{bundleId}"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}"},{"label":"Retrieve a governance bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/getgovernancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/getgovernancebundle","metadata":{"seo":{"title":"Retrieve a governance bundle","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}"},{"label":"Replace a governance bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/replacegovernancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/replacegovernancebundle","metadata":{"seo":{"title":"Replace a governance bundle","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}"},{"label":"Delete a governance bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/deletegovernancebundle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/deletegovernancebundle","metadata":{"seo":{"title":"Delete a governance bundle","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}"},{"label":"/api/v1/iam/governance/bundles/{bundleId}/entitlements","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}~1entitlements/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}~1entitlements/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v1/iam/governance/bundles/{bundleId}/entitlements"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}/entitlements"},{"label":"List all entitlements for a governance bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/listbundleentitlements","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/listbundleentitlements","metadata":{"seo":{"title":"List all entitlements for a governance bundle","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}/entitlements"},{"label":"/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}~1entitlements~1{entitlementid}~1values/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1bundles~1{bundleid}~1entitlements~1{entitlementid}~1values/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values"},{"label":"List all values for a governance bundle entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/listbundleentitlementvalues","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/listbundleentitlementvalues","metadata":{"seo":{"title":"List all values for a governance bundle entitlement","description":"
"}},"httpPath":"/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values"},{"label":"/api/v1/iam/governance/optIn","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1optin/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/governancebundle/paths/~1api~1v1~1iam~1governance~1optin/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v1/iam/governance/optIn"}},"httpPath":"/api/v1/iam/governance/optIn"},{"label":"Retrieve the Admin Console opt-in status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/getoptinstatus","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/getoptinstatus","metadata":{"seo":{"title":"Retrieve the Admin Console opt-in status","description":"
"}},"httpPath":"/api/v1/iam/governance/optIn"},{"label":"Opt in the Admin Console to entitlement management","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/optin","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/optin","metadata":{"seo":{"title":"Opt in the Admin Console to entitlement management","description":"
"}},"httpPath":"/api/v1/iam/governance/optIn"},{"label":"Opt out the Admin Console from entitlement management","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/governancebundle/other/optout","routeSlug":"/openapi/okta-management/management/tags/governancebundle/other/optout","metadata":{"seo":{"title":"Opt out the Admin Console from entitlement management","description":"
"}},"httpPath":"/api/v1/iam/governance/optOut"}],"metadata":{"type":"openapi","title":"IAM Governance Bundles","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=csh-governance-admin-roles) and [Entitlement Management](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ext-entitlement-mgt)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/subscription.yaml","link":"/openapi/okta-management/management/tags/subscription","routeSlug":"/openapi/okta-management/management/tags/subscription","label":"Subscriptions","items":[{"type":"group","label":"Subscriptions","link":"/openapi/okta-management/management/tags/subscription/subscription","routeSlug":"/openapi/okta-management/management/tags/subscription/subscription","items":[]},{"label":"List all subscriptions for a role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/listsubscriptionsrole","routeSlug":"/openapi/okta-management/management/tags/subscription/other/listsubscriptionsrole","metadata":{"seo":{"title":"List all subscriptions for a role","description":"
"}},"httpPath":"/api/v1/roles/{roleRef}/subscriptions"},{"label":"Retrieve a subscription for a role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/getsubscriptionsnotificationtyperole","routeSlug":"/openapi/okta-management/management/tags/subscription/other/getsubscriptionsnotificationtyperole","metadata":{"seo":{"title":"Retrieve a subscription for a role","description":"
"}},"httpPath":"/api/v1/roles/{roleRef}/subscriptions/{notificationType}"},{"label":"Subscribe a role to a specific notification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/subscribebynotificationtyperole","routeSlug":"/openapi/okta-management/management/tags/subscription/other/subscribebynotificationtyperole","metadata":{"seo":{"title":"Subscribe a role to a specific notification type","description":"
"}},"httpPath":"/api/v1/roles/{roleRef}/subscriptions/{notificationType}/subscribe"},{"label":"Unsubscribe a role from a specific notification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/unsubscribebynotificationtyperole","routeSlug":"/openapi/okta-management/management/tags/subscription/other/unsubscribebynotificationtyperole","metadata":{"seo":{"title":"Unsubscribe a role from a specific notification type","description":"
"}},"httpPath":"/api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribe"},{"label":"List all subscriptions for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/listsubscriptionsuser","routeSlug":"/openapi/okta-management/management/tags/subscription/other/listsubscriptionsuser","metadata":{"seo":{"title":"List all subscriptions for a user","description":"
"}},"httpPath":"/api/v1/users/{userId}/subscriptions"},{"label":"Retrieve a subscription for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/getsubscriptionsnotificationtypeuser","routeSlug":"/openapi/okta-management/management/tags/subscription/other/getsubscriptionsnotificationtypeuser","metadata":{"seo":{"title":"Retrieve a subscription for a user","description":"
"}},"httpPath":"/api/v1/users/{userId}/subscriptions/{notificationType}"},{"label":"Subscribe a user to a specific notification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/subscribebynotificationtypeuser","routeSlug":"/openapi/okta-management/management/tags/subscription/other/subscribebynotificationtypeuser","metadata":{"seo":{"title":"Subscribe a user to a specific notification type","description":"
"}},"httpPath":"/api/v1/users/{userId}/subscriptions/{notificationType}/subscribe"},{"label":"Unsubscribe a user from a specific notification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/subscription/other/unsubscribebynotificationtypeuser","routeSlug":"/openapi/okta-management/management/tags/subscription/other/unsubscribebynotificationtypeuser","metadata":{"seo":{"title":"Unsubscribe a user from a specific notification type","description":"
"}},"httpPath":"/api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe"}],"metadata":{"type":"openapi","title":"Subscriptions","description":"The Subscriptions API provides operations to manage email subscription settings for Okta administrator notifications."}}]},{"type":"group","label":"Applications","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/application.yaml","link":"/openapi/okta-management/management/tags/application","routeSlug":"/openapi/okta-management/management/tags/application","label":"Applications","items":[{"type":"group","label":"Applications","link":"/openapi/okta-management/management/tags/application/application","routeSlug":"/openapi/okta-management/management/tags/application/application","items":[{"type":"link","label":"Google Workspace","link":"/openapi/okta-management/management/tags/application/application/googleapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/googleapplication","httpVerb":"schema"},{"type":"link","label":"Microsoft Office 365","link":"/openapi/okta-management/management/tags/application/application/office365application","routeSlug":"/openapi/okta-management/management/tags/application/application/office365application","httpVerb":"schema"},{"type":"link","label":"Org2Org","link":"/openapi/okta-management/management/tags/application/application/org2orgapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/org2orgapplication","httpVerb":"schema"},{"type":"link","label":"Salesforce","link":"/openapi/okta-management/management/tags/application/application/salesforceapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/salesforceapplication","httpVerb":"schema"},{"type":"link","label":"Slack","link":"/openapi/okta-management/management/tags/application/application/slackapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/slackapplication","httpVerb":"schema"},{"type":"link","label":"Trend Micro Apex One Service","link":"/openapi/okta-management/management/tags/application/application/trendmicroapexoneserviceapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/trendmicroapexoneserviceapplication","httpVerb":"schema"},{"type":"link","label":"Zoom","link":"/openapi/okta-management/management/tags/application/application/zoomusapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/zoomusapplication","httpVerb":"schema"},{"type":"link","label":"Zscaler 2.0","link":"/openapi/okta-management/management/tags/application/application/zscalerbyzapplication","routeSlug":"/openapi/okta-management/management/tags/application/application/zscalerbyzapplication","httpVerb":"schema"}]},{"label":"List all applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/listapplications","routeSlug":"/openapi/okta-management/management/tags/application/other/listapplications","metadata":{"seo":{"title":"List all applications","description":"
"}},"httpPath":"/api/v1/apps"},{"label":"Create an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/createapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/createapplication","metadata":{"seo":{"title":"Create an application","description":"
"}},"httpPath":"/api/v1/apps"},{"label":"Retrieve a CSV export of filtered applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/getapplicationscsvexport","routeSlug":"/openapi/okta-management/management/tags/application/other/getapplicationscsvexport","metadata":{"seo":{"title":"Retrieve a CSV export of filtered applications","description":"
Early Access
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/export"},{"label":"List all applications that match search filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/listapplicationsbysearch","routeSlug":"/openapi/okta-management/management/tags/application/other/listapplicationsbysearch","metadata":{"seo":{"title":"List all applications that match search filters","description":"
Early Access
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/search"},{"label":"List all app types in use with usage counts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/listapptypeusage","routeSlug":"/openapi/okta-management/management/tags/application/other/listapptypeusage","metadata":{"seo":{"title":"List all app types in use with usage counts","description":"
Early Access
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/types"},{"label":"Retrieve an application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/getapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/getapplication","metadata":{"seo":{"title":"Retrieve an application","description":"
"}},"httpPath":"/api/v1/apps/{appId}"},{"label":"Replace an application","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/replaceapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/replaceapplication","metadata":{"seo":{"title":"Replace an application","description":"
"}},"httpPath":"/api/v1/apps/{appId}"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/deleteapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/deleteapplication","metadata":{"seo":{"title":"Delete an application","description":"
"}},"httpPath":"/api/v1/apps/{appId}"},{"label":"Activate an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/activateapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/activateapplication","metadata":{"seo":{"title":"Activate an application","description":"
"}},"httpPath":"/api/v1/apps/{appId}/lifecycle/activate"},{"label":"Deactivate an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/application/other/deactivateapplication","routeSlug":"/openapi/okta-management/management/tags/application/other/deactivateapplication","metadata":{"seo":{"title":"Deactivate an application","description":"
"}},"httpPath":"/api/v1/apps/{appId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Applications","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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication)\noperation with the corresponding OIN app schema in the request body."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationconnections.yaml","link":"/openapi/okta-management/management/tags/applicationconnections","routeSlug":"/openapi/okta-management/management/tags/applicationconnections","label":"Application Connections","items":[{"type":"group","label":"Application Connections","link":"/openapi/okta-management/management/tags/applicationconnections/applicationconnections","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/applicationconnections","items":[]},{"label":"Retrieve the default provisioning connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/getdefaultprovisioningconnectionforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/getdefaultprovisioningconnectionforapplication","metadata":{"seo":{"title":"Retrieve the default provisioning connection","description":"
"}},"httpPath":"/api/v1/apps/{appId}/connections/default"},{"label":"Update the default provisioning connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/updatedefaultprovisioningconnectionforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/updatedefaultprovisioningconnectionforapplication","metadata":{"seo":{"title":"Update the default provisioning connection","description":"
"}},"httpPath":"/api/v1/apps/{appId}/connections/default"},{"label":"Retrieve a JSON Web Key Set (JWKS) for the default provisioning connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/getuserprovisioningconnectionjwks","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/getuserprovisioningconnectionjwks","metadata":{"seo":{"title":"Retrieve a JSON Web Key Set (JWKS) for the default provisioning connection","description":"
CORS
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/{appId}/connections/default/jwks"},{"label":"Activate the default provisioning connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/activatedefaultprovisioningconnectionforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/activatedefaultprovisioningconnectionforapplication","metadata":{"seo":{"title":"Activate the default provisioning connection","description":"
"}},"httpPath":"/api/v1/apps/{appId}/connections/default/lifecycle/activate"},{"label":"Deactivate the default provisioning connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/deactivatedefaultprovisioningconnectionforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/deactivatedefaultprovisioningconnectionforapplication","metadata":{"seo":{"title":"Deactivate the default provisioning connection","description":"
"}},"httpPath":"/api/v1/apps/{appId}/connections/default/lifecycle/deactivate"},{"label":"Verify the provisioning connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationconnections/other/verifyprovisioningconnectionforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationconnections/other/verifyprovisioningconnectionforapplication","metadata":{"seo":{"title":"Verify the provisioning connection","description":"
"}},"httpPath":"/api/v1/apps/{appName}/{appId}/oauth2/callback"}],"metadata":{"type":"openapi","title":"Application Connections","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 |
Connection
| Description |
Apps supported
|\n | -------------------------------- | -------------- | ----------- |\n | Token | The provisioning API connection is based on bearer token authentication. |
  • Okta Org2Org (`okta_org2org`)
  • Zscaler 2.0 (`zscalerbyz`)
|\n | OAuth 2.0 | The provisioning API connection is based on OAuth 2.0 authentication. |
  • Google Workspace (`google`)
  • Microsoft Office 365 (`office365`)
  • Okta Org2Org (`okta_org2org`)
  • Slack (`slack`)
  • Zoom (`zoomus`)
|\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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationcrossappaccessconnections.yaml","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections","label":"Application Cross App Access Connections","items":[{"type":"group","label":"Application Cross App Access Connections","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/applicationcrossappaccessconnections","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/applicationcrossappaccessconnections","items":[]},{"label":"Retrieve all Cross App Access connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/getallcrossappaccessconnections","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/getallcrossappaccessconnections","metadata":{"seo":{"title":"Retrieve all Cross App Access connections","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/{appId}/cwo/connections"},{"label":"Create a Cross App Access connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/createcrossappaccessconnection","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/createcrossappaccessconnection","metadata":{"seo":{"title":"Create a Cross App Access connection","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.apps.manage
"}},"httpPath":"/api/v1/apps/{appId}/cwo/connections"},{"label":"Retrieve a Cross App Access connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/getcrossappaccessconnection","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/getcrossappaccessconnection","metadata":{"seo":{"title":"Retrieve a Cross App Access connection","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.apps.read
"}},"httpPath":"/api/v1/apps/{appId}/cwo/connections/{connectionId}"},{"label":"Update a Cross App Access connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/updatecrossappaccessconnection","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/updatecrossappaccessconnection","metadata":{"seo":{"title":"Update a Cross App Access connection","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.apps.manage
"}},"httpPath":"/api/v1/apps/{appId}/cwo/connections/{connectionId}"},{"label":"Delete a Cross App Access connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/deletecrossappaccessconnection","routeSlug":"/openapi/okta-management/management/tags/applicationcrossappaccessconnections/other/deletecrossappaccessconnection","metadata":{"seo":{"title":"Delete a Cross App Access connection","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.apps.manage
"}},"httpPath":"/api/v1/apps/{appId}/cwo/connections/{connectionId}"}],"metadata":{"type":"openapi","title":"Application Cross App Access 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\n> **Note:** The removal of the Application Cross App Access Connections API is scheduled for an upcoming release. Your existing managed connection configurations will stop working.\n> Use the corresponding [Okta for AI Agents API](https://okta-developer.pixtulate.com/docs/api/secures-ai) to reconfigure your connections:\n> [Create a resource connection](https://okta-developer.pixtulate.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/createresourceconnection) with `IDENTITY_ASSERTION_APP_INSTANCE`.\n>\n> For instructions on how AI agent connections are configured in the Admin Console, see [Configure resource server connectors](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent-rsc-svr-config).\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationfeatures.yaml","link":"/openapi/okta-management/management/tags/applicationfeatures","routeSlug":"/openapi/okta-management/management/tags/applicationfeatures","label":"Application Features","items":[{"type":"group","label":"Application Features","link":"/openapi/okta-management/management/tags/applicationfeatures/applicationfeatures","routeSlug":"/openapi/okta-management/management/tags/applicationfeatures/applicationfeatures","items":[]},{"label":"List all features","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationfeatures/other/listfeaturesforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationfeatures/other/listfeaturesforapplication","metadata":{"seo":{"title":"List all features","description":"
"}},"httpPath":"/api/v1/apps/{appId}/features"},{"label":"Retrieve a feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationfeatures/other/getfeatureforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationfeatures/other/getfeatureforapplication","metadata":{"seo":{"title":"Retrieve a feature","description":"
"}},"httpPath":"/api/v1/apps/{appId}/features/{featureName}"},{"label":"Update a feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationfeatures/other/updatefeatureforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationfeatures/other/updatefeatureforapplication","metadata":{"seo":{"title":"Update a feature","description":"
"}},"httpPath":"/api/v1/apps/{appId}/features/{featureName}"}],"metadata":{"type":"openapi","title":"Application Features","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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/applicationconnections/updatedefaultprovisioningconnectionforapplication).\n\nThe following available provisioning features are supported by the indicated apps:\n\n|
Feature
| Description |
Apps supported
|\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. |
  • Google Workspace (`google`)
  • Microsoft Office 365 (`office365`)
  • Okta Org2Org (`okta_org2org`)
  • Slack (`slack`)
  • Zoom (`zoomus`)
  • Zscaler 2.0 (`zscalerbyz`)
|\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. |
  • Google Workspace (`google`)
  • Microsoft Office 365 (`office365`)
  • Okta Org2Org (`okta_org2org`)
  • Slack (`slack`)
  • Zoom (`zoomus`)
|\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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationgrants.yaml","link":"/openapi/okta-management/management/tags/applicationgrants","routeSlug":"/openapi/okta-management/management/tags/applicationgrants","label":"Application Grants","items":[{"type":"group","label":"Application Grants","link":"/openapi/okta-management/management/tags/applicationgrants/applicationgrants","routeSlug":"/openapi/okta-management/management/tags/applicationgrants/applicationgrants","items":[]},{"label":"List all app grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgrants/other/listscopeconsentgrants","routeSlug":"/openapi/okta-management/management/tags/applicationgrants/other/listscopeconsentgrants","metadata":{"seo":{"title":"List all app grants","description":"
"}},"httpPath":"/api/v1/apps/{appId}/grants"},{"label":"Grant consent to scope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgrants/other/grantconsenttoscope","routeSlug":"/openapi/okta-management/management/tags/applicationgrants/other/grantconsenttoscope","metadata":{"seo":{"title":"Grant consent to scope","description":"
"}},"httpPath":"/api/v1/apps/{appId}/grants"},{"label":"Retrieve an app grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgrants/other/getscopeconsentgrant","routeSlug":"/openapi/okta-management/management/tags/applicationgrants/other/getscopeconsentgrant","metadata":{"seo":{"title":"Retrieve an app grant","description":"
"}},"httpPath":"/api/v1/apps/{appId}/grants/{grantId}"},{"label":"Revoke an app grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgrants/other/revokescopeconsentgrant","routeSlug":"/openapi/okta-management/management/tags/applicationgrants/other/revokescopeconsentgrant","metadata":{"seo":{"title":"Revoke an app grant","description":"
"}},"httpPath":"/api/v1/apps/{appId}/grants/{grantId}"}],"metadata":{"type":"openapi","title":"Application Grants","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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationgroups.yaml","link":"/openapi/okta-management/management/tags/applicationgroups","routeSlug":"/openapi/okta-management/management/tags/applicationgroups","label":"Application Groups","items":[{"type":"group","label":"Application Groups","link":"/openapi/okta-management/management/tags/applicationgroups/applicationgroups","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/applicationgroups","items":[]},{"label":"List all application groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgroups/other/listapplicationgroupassignments","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/other/listapplicationgroupassignments","metadata":{"seo":{"title":"List all application groups","description":"
"}},"httpPath":"/api/v1/apps/{appId}/groups"},{"label":"Retrieve an application group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgroups/other/getapplicationgroupassignment","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/other/getapplicationgroupassignment","metadata":{"seo":{"title":"Retrieve an application group","description":"
"}},"httpPath":"/api/v1/apps/{appId}/groups/{groupId}"},{"label":"Assign an application group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgroups/other/assigngrouptoapplication","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/other/assigngrouptoapplication","metadata":{"seo":{"title":"Assign an application group","description":"
"}},"httpPath":"/api/v1/apps/{appId}/groups/{groupId}"},{"label":"Update an application group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgroups/other/updategroupassignmenttoapplication","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/other/updategroupassignmenttoapplication","metadata":{"seo":{"title":"Update an application group","description":"
"}},"httpPath":"/api/v1/apps/{appId}/groups/{groupId}"},{"label":"Unassign an application group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationgroups/other/unassignapplicationfromgroup","routeSlug":"/openapi/okta-management/management/tags/applicationgroups/other/unassignapplicationfromgroup","metadata":{"seo":{"title":"Unassign an application group","description":"
"}},"httpPath":"/api/v1/apps/{appId}/groups/{groupId}"}],"metadata":{"type":"openapi","title":"Application Groups","description":"The Application Groups API provides a set of operations to manage group assignment for an app."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationinterclienttrustmappings.yaml","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings","label":"Application Interclient Trust Mappings","items":[{"type":"group","label":"Application Interclient Trust Mappings","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/applicationinterclienttrustmappings","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/applicationinterclienttrustmappings","items":[]},{"label":"List all allowed apps for a target app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/listinterclientallowedapplications","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/listinterclientallowedapplications","metadata":{"seo":{"title":"List all allowed apps for a target app","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.apps.interclientTrust.read
"}},"httpPath":"/api/v1/apps/{appId}/interclient-allowed-apps"},{"label":"Create an allowed app mapping for a target app","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/createinterclienttrustmapping","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/createinterclienttrustmapping","metadata":{"seo":{"title":"Create an allowed app mapping for a target app","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.apps.interclientTrust.manage
"}},"httpPath":"/api/v1/apps/{appId}/interclient-allowed-apps"},{"label":"Delete an interclient trust mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/deleteinterclienttrustmapping","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/deleteinterclienttrustmapping","metadata":{"seo":{"title":"Delete an interclient trust mapping","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.apps.interclientTrust.manage
"}},"httpPath":"/api/v1/apps/{appId}/interclient-allowed-apps/{allowedAppId}"},{"label":"List all target apps for an allowed app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/listinterclienttargetapplications","routeSlug":"/openapi/okta-management/management/tags/applicationinterclienttrustmappings/other/listinterclienttargetapplications","metadata":{"seo":{"title":"List all target apps for an allowed app","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.apps.interclientTrust.read
"}},"httpPath":"/api/v1/apps/{appId}/interclient-target-apps"}],"metadata":{"type":"openapi","title":"Application Interclient Trust Mappings","description":"The Application Interclient Trust Mappings API allows you to manage interclient trust mappings for an app. Use it to configure which OpenID Connect (OIDC) origin apps can exchange tokens to sign in to a target web app. These trust mappings are required to enable the [Native to Web SSO flow](https://okta-developer.pixtulate.com/docs/guides/native-to-web-sso/main/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationlogos.yaml","link":"/openapi/okta-management/management/tags/applicationlogos","routeSlug":"/openapi/okta-management/management/tags/applicationlogos","label":"Application Logos","items":[{"type":"group","label":"Application Logos","link":"/openapi/okta-management/management/tags/applicationlogos/applicationlogos","routeSlug":"/openapi/okta-management/management/tags/applicationlogos/applicationlogos","items":[]},{"label":"Upload an application logo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationlogos/other/uploadapplicationlogo","routeSlug":"/openapi/okta-management/management/tags/applicationlogos/other/uploadapplicationlogo","metadata":{"seo":{"title":"Upload an application logo","description":"
"}},"httpPath":"/api/v1/apps/{appId}/logo"}],"metadata":{"type":"openapi","title":"Application Logos","description":"Provides a resource to manage the application instance logo"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationpolicies.yaml","link":"/openapi/okta-management/management/tags/applicationpolicies","routeSlug":"/openapi/okta-management/management/tags/applicationpolicies","label":"Application Policies","items":[{"type":"group","label":"Application Policies","link":"/openapi/okta-management/management/tags/applicationpolicies/applicationpolicies","routeSlug":"/openapi/okta-management/management/tags/applicationpolicies/applicationpolicies","items":[]},{"label":"Assign an app sign-in policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationpolicies/other/assignapplicationpolicy","routeSlug":"/openapi/okta-management/management/tags/applicationpolicies/other/assignapplicationpolicy","metadata":{"seo":{"title":"Assign an app sign-in policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.apps.manage
"}},"httpPath":"/api/v1/apps/{appId}/policies/{policyId}"}],"metadata":{"type":"openapi","title":"Application Policies","description":"The Application Policies API provides a resource to manage app sign-in policies associated with an app."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationsso.yaml","link":"/openapi/okta-management/management/tags/applicationsso","routeSlug":"/openapi/okta-management/management/tags/applicationsso","label":"Application SSO","items":[{"type":"group","label":"Application SSO","link":"/openapi/okta-management/management/tags/applicationsso/applicationsso","routeSlug":"/openapi/okta-management/management/tags/applicationsso/applicationsso","items":[]},{"label":"Preview the application SAML metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationsso/other/previewsamlmetadataforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationsso/other/previewsamlmetadataforapplication","metadata":{"seo":{"title":"Preview the application SAML metadata","description":"
"}},"httpPath":"/api/v1/apps/{appId}/sso/saml/metadata"}],"metadata":{"type":"openapi","title":"Application SSO","description":"Provides a Single Sign-On (SSO) resource for an application"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationssocredentialkey.yaml","link":"/openapi/okta-management/management/tags/applicationssocredentialkey","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey","label":"Application Key Credentials","items":[{"type":"group","label":"Application Key Credentials","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/applicationssocredentialkey","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/applicationssocredentialkey","items":[]},{"label":"List all certificate signing requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/listcsrsforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/listcsrsforapplication","metadata":{"seo":{"title":"List all certificate signing requests","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/csrs"},{"label":"Generate a certificate signing request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/generatecsrforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/generatecsrforapplication","metadata":{"seo":{"title":"Generate a certificate signing request","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/csrs"},{"label":"Retrieve a certificate signing request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/getcsrforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/getcsrforapplication","metadata":{"seo":{"title":"Retrieve a certificate signing request","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/csrs/{csrId}"},{"label":"Revoke a certificate signing request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/revokecsrfromapplication","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/revokecsrfromapplication","metadata":{"seo":{"title":"Revoke a certificate signing request","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/csrs/{csrId}"},{"label":"Publish a certificate signing request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/publishcsrfromapplication","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/publishcsrfromapplication","metadata":{"seo":{"title":"Publish a certificate signing request","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish"},{"label":"List all key credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/listapplicationkeys","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/listapplicationkeys","metadata":{"seo":{"title":"List all key credentials","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/keys"},{"label":"Generate a key credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/generateapplicationkey","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/generateapplicationkey","metadata":{"seo":{"title":"Generate a key credential","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/keys/generate"},{"label":"Retrieve a key credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/getapplicationkey","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/getapplicationkey","metadata":{"seo":{"title":"Retrieve a key credential","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/keys/{keyId}"},{"label":"Clone a key credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/cloneapplicationkey","routeSlug":"/openapi/okta-management/management/tags/applicationssocredentialkey/other/cloneapplicationkey","metadata":{"seo":{"title":"Clone a key credential","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/keys/{keyId}/clone"}],"metadata":{"type":"openapi","title":"Application Key Credentials","description":"The Application Key Credentials API provides a set of operations to manage an app's key store credentials.\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationssopublickeys.yaml","link":"/openapi/okta-management/management/tags/applicationssopublickeys","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys","label":"Application Public Keys","items":[{"type":"group","label":"Application Public Keys","link":"/openapi/okta-management/management/tags/applicationssopublickeys/applicationssopublickeys","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/applicationssopublickeys","items":[]},{"label":"List all the OAuth 2.0 client JSON Web Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/listjwk","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/listjwk","metadata":{"seo":{"title":"List all the OAuth 2.0 client JSON Web Keys","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks"},{"label":"Add a JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/addjwk","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/addjwk","metadata":{"seo":{"title":"Add a JSON Web Key","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks"},{"label":"Retrieve an OAuth 2.0 client JSON Web Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/getjwk","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/getjwk","metadata":{"seo":{"title":"Retrieve an OAuth 2.0 client JSON Web Key","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks/{keyId}"},{"label":"Delete an OAuth 2.0 client JSON Web Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deletejwk","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deletejwk","metadata":{"seo":{"title":"Delete an OAuth 2.0 client JSON Web Key","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks/{keyId}"},{"label":"Activate an OAuth 2.0 client JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/activateoauth2clientjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/activateoauth2clientjsonwebkey","metadata":{"seo":{"title":"Activate an OAuth 2.0 client JSON Web Key","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/activate"},{"label":"Deactivate an OAuth 2.0 client JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deactivateoauth2clientjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deactivateoauth2clientjsonwebkey","metadata":{"seo":{"title":"Deactivate an OAuth 2.0 client JSON Web Key","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/deactivate"},{"label":"List all OAuth 2.0 client secrets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/listoauth2clientsecrets","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/listoauth2clientsecrets","metadata":{"seo":{"title":"List all OAuth 2.0 client secrets","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets"},{"label":"Create an OAuth 2.0 client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/createoauth2clientsecret","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/createoauth2clientsecret","metadata":{"seo":{"title":"Create an OAuth 2.0 client secret","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets"},{"label":"Retrieve an OAuth 2.0 client secret","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/getoauth2clientsecret","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/getoauth2clientsecret","metadata":{"seo":{"title":"Retrieve an OAuth 2.0 client secret","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets/{secretId}"},{"label":"Delete an OAuth 2.0 client secret","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deleteoauth2clientsecret","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deleteoauth2clientsecret","metadata":{"seo":{"title":"Delete an OAuth 2.0 client secret","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets/{secretId}"},{"label":"Activate an OAuth 2.0 client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/activateoauth2clientsecret","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/activateoauth2clientsecret","metadata":{"seo":{"title":"Activate an OAuth 2.0 client secret","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/activate"},{"label":"Deactivate an OAuth 2.0 client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deactivateoauth2clientsecret","routeSlug":"/openapi/okta-management/management/tags/applicationssopublickeys/other/deactivateoauth2clientsecret","metadata":{"seo":{"title":"Deactivate an OAuth 2.0 client secret","description":"
"}},"httpPath":"/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Application Public Keys","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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/client-auth/) or for encrypting ID tokens. Encrypting ID tokens is self-service [Early Access](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/release-lifecycle/#early-access-ea).\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationssofederatedclaims.yaml","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims","label":"Application Federated Claims","items":[{"type":"group","label":"Application Federated Claims","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/applicationssofederatedclaims","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/applicationssofederatedclaims","items":[]},{"label":"List all configured federated claims","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/listfederatedclaims","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/listfederatedclaims","metadata":{"seo":{"title":"List all configured federated claims","description":"
"}},"httpPath":"/api/v1/apps/{appId}/federated-claims"},{"label":"Create a federated claim","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/createfederatedclaim","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/createfederatedclaim","metadata":{"seo":{"title":"Create a federated claim","description":"
"}},"httpPath":"/api/v1/apps/{appId}/federated-claims"},{"label":"Retrieve a federated claim","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/getfederatedclaim","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/getfederatedclaim","metadata":{"seo":{"title":"Retrieve a federated claim","description":"
"}},"httpPath":"/api/v1/apps/{appId}/federated-claims/{claimId}"},{"label":"Replace a federated claim","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/replacefederatedclaim","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/replacefederatedclaim","metadata":{"seo":{"title":"Replace a federated claim","description":"
"}},"httpPath":"/api/v1/apps/{appId}/federated-claims/{claimId}"},{"label":"Delete a federated claim","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/deletefederatedclaim","routeSlug":"/openapi/okta-management/management/tags/applicationssofederatedclaims/other/deletefederatedclaim","metadata":{"seo":{"title":"Delete a federated claim","description":"
"}},"httpPath":"/api/v1/apps/{appId}/federated-claims/{claimId}"}],"metadata":{"type":"openapi","title":"Application Federated Claims","description":"The federated claims for an application\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationtokens.yaml","link":"/openapi/okta-management/management/tags/applicationtokens","routeSlug":"/openapi/okta-management/management/tags/applicationtokens","label":"Application Tokens","items":[{"type":"group","label":"Application Tokens","link":"/openapi/okta-management/management/tags/applicationtokens/applicationtokens","routeSlug":"/openapi/okta-management/management/tags/applicationtokens/applicationtokens","items":[]},{"label":"List all application refresh tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationtokens/other/listoauth2tokensforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationtokens/other/listoauth2tokensforapplication","metadata":{"seo":{"title":"List all application refresh tokens","description":"
"}},"httpPath":"/api/v1/apps/{appId}/tokens"},{"label":"Revoke all application tokens","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationtokens/other/revokeoauth2tokensforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationtokens/other/revokeoauth2tokensforapplication","metadata":{"seo":{"title":"Revoke all application tokens","description":"
"}},"httpPath":"/api/v1/apps/{appId}/tokens"},{"label":"Retrieve an application token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationtokens/other/getoauth2tokenforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationtokens/other/getoauth2tokenforapplication","metadata":{"seo":{"title":"Retrieve an application token","description":"
"}},"httpPath":"/api/v1/apps/{appId}/tokens/{tokenId}"},{"label":"Revoke an application token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationtokens/other/revokeoauth2tokenforapplication","routeSlug":"/openapi/okta-management/management/tags/applicationtokens/other/revokeoauth2tokenforapplication","metadata":{"seo":{"title":"Revoke an application token","description":"
"}},"httpPath":"/api/v1/apps/{appId}/tokens/{tokenId}"}],"metadata":{"type":"openapi","title":"Application Tokens","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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication!path=4/settings/oauthClient/grant_types&t=request)\n> and [refresh_token](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication!path=4/settings/oauthClient/refresh_token&t=request).\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/applicationusers.yaml","link":"/openapi/okta-management/management/tags/applicationusers","routeSlug":"/openapi/okta-management/management/tags/applicationusers","label":"Application Users","items":[{"type":"group","label":"Application Users","link":"/openapi/okta-management/management/tags/applicationusers/applicationusers","routeSlug":"/openapi/okta-management/management/tags/applicationusers/applicationusers","items":[]},{"label":"List all application users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationusers/other/listapplicationusers","routeSlug":"/openapi/okta-management/management/tags/applicationusers/other/listapplicationusers","metadata":{"seo":{"title":"List all application users","description":"
"}},"httpPath":"/api/v1/apps/{appId}/users"},{"label":"Assign an application user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationusers/other/assignusertoapplication","routeSlug":"/openapi/okta-management/management/tags/applicationusers/other/assignusertoapplication","metadata":{"seo":{"title":"Assign an application user","description":"
"}},"httpPath":"/api/v1/apps/{appId}/users"},{"label":"Retrieve an application user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationusers/other/getapplicationuser","routeSlug":"/openapi/okta-management/management/tags/applicationusers/other/getapplicationuser","metadata":{"seo":{"title":"Retrieve an application user","description":"
"}},"httpPath":"/api/v1/apps/{appId}/users/{userId}"},{"label":"Update an application user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationusers/other/updateapplicationuser","routeSlug":"/openapi/okta-management/management/tags/applicationusers/other/updateapplicationuser","metadata":{"seo":{"title":"Update an application user","description":"
"}},"httpPath":"/api/v1/apps/{appId}/users/{userId}"},{"label":"Unassign an application user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/applicationusers/other/unassignuserfromapplication","routeSlug":"/openapi/okta-management/management/tags/applicationusers/other/unassignuserfromapplication","metadata":{"seo":{"title":"Unassign an application user","description":"
"}},"httpPath":"/api/v1/apps/{appId}/users/{userId}"}],"metadata":{"type":"openapi","title":"Application Users","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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/apiserviceintegrations.yaml","link":"/openapi/okta-management/management/tags/apiserviceintegrations","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations","label":"API Service Integrations","items":[{"type":"group","label":"API Service Integrations","link":"/openapi/okta-management/management/tags/apiserviceintegrations/apiserviceintegrations","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/apiserviceintegrations","items":[]},{"label":"List all API service integration instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/listapiserviceintegrationinstances","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/listapiserviceintegrationinstances","metadata":{"seo":{"title":"List all API service integration instances","description":"
"}},"httpPath":"/integrations/api/v1/api-services"},{"label":"Create an API service integration instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/createapiserviceintegrationinstance","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/createapiserviceintegrationinstance","metadata":{"seo":{"title":"Create an API service integration instance","description":"
"}},"httpPath":"/integrations/api/v1/api-services"},{"label":"Retrieve an API service integration instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/getapiserviceintegrationinstance","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/getapiserviceintegrationinstance","metadata":{"seo":{"title":"Retrieve an API service integration instance","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}"},{"label":"Delete an API service integration instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deleteapiserviceintegrationinstance","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deleteapiserviceintegrationinstance","metadata":{"seo":{"title":"Delete an API service integration instance","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}"},{"label":"List all API service integration instance secrets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/listapiserviceintegrationinstancesecrets","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/listapiserviceintegrationinstancesecrets","metadata":{"seo":{"title":"List all API service integration instance secrets","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets"},{"label":"Create an API service integration instance secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/createapiserviceintegrationinstancesecret","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/createapiserviceintegrationinstancesecret","metadata":{"seo":{"title":"Create an API service integration instance secret","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets"},{"label":"Delete an API service integration instance secret","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deleteapiserviceintegrationinstancesecret","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deleteapiserviceintegrationinstancesecret","metadata":{"seo":{"title":"Delete an API service integration instance secret","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}"},{"label":"Activate an API service integration instance secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/activateapiserviceintegrationinstancesecret","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/activateapiserviceintegrationinstancesecret","metadata":{"seo":{"title":"Activate an API service integration instance secret","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activate"},{"label":"Deactivate an API service integration instance secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deactivateapiserviceintegrationinstancesecret","routeSlug":"/openapi/okta-management/management/tags/apiserviceintegrations/other/deactivateapiserviceintegrationinstancesecret","metadata":{"seo":{"title":"Deactivate an API service integration instance secret","description":"
"}},"httpPath":"/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"API Service Integrations","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://okta-www.pixtulate.com/integrations/?capability=api).\n\nSee [Add an API Service Integration](https://okta-help.pixtulate.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://okta-developer.pixtulate.com/docs/guides/oin-api-service-overview/).\n"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/oktaapplicationsettings.yaml","link":"/openapi/okta-management/management/tags/oktaapplicationsettings","routeSlug":"/openapi/okta-management/management/tags/oktaapplicationsettings","label":"Okta Application Settings","items":[{"type":"group","label":"Okta Application Settings","link":"/openapi/okta-management/management/tags/oktaapplicationsettings/oktaapplicationsettings","routeSlug":"/openapi/okta-management/management/tags/oktaapplicationsettings/oktaapplicationsettings","items":[]},{"label":"Retrieve the Okta application settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktaapplicationsettings/other/getfirstpartyappsettings","routeSlug":"/openapi/okta-management/management/tags/oktaapplicationsettings/other/getfirstpartyappsettings","metadata":{"seo":{"title":"Retrieve the Okta application settings","description":"
"}},"httpPath":"/api/v1/first-party-app-settings/{appName}"},{"label":"Replace the Okta application settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktaapplicationsettings/other/replacefirstpartyappsettings","routeSlug":"/openapi/okta-management/management/tags/oktaapplicationsettings/other/replacefirstpartyappsettings","metadata":{"seo":{"title":"Replace the Okta application settings","description":"
"}},"httpPath":"/api/v1/first-party-app-settings/{appName}"}],"metadata":{"type":"openapi","title":"Okta Application Settings","description":"The Okta Application Settings API provides operations to manage settings for Okta apps in your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/grouppushmapping.yaml","link":"/openapi/okta-management/management/tags/grouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping","label":"Group Push Mappings","items":[{"type":"group","label":"Group Push Mappings","link":"/openapi/okta-management/management/tags/grouppushmapping/grouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/grouppushmapping","items":[]},{"label":"List all group push mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouppushmapping/other/listgrouppushmappings","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/other/listgrouppushmappings","metadata":{"seo":{"title":"List all group push mappings","description":"
"}},"httpPath":"/api/v1/apps/{appId}/group-push/mappings"},{"label":"Create a group push mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouppushmapping/other/creategrouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/other/creategrouppushmapping","metadata":{"seo":{"title":"Create a group push mapping","description":"
"}},"httpPath":"/api/v1/apps/{appId}/group-push/mappings"},{"label":"Retrieve a group push mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouppushmapping/other/getgrouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/other/getgrouppushmapping","metadata":{"seo":{"title":"Retrieve a group push mapping","description":"
"}},"httpPath":"/api/v1/apps/{appId}/group-push/mappings/{mappingId}"},{"label":"Update a group push mapping","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouppushmapping/other/updategrouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/other/updategrouppushmapping","metadata":{"seo":{"title":"Update a group push mapping","description":"
"}},"httpPath":"/api/v1/apps/{appId}/group-push/mappings/{mappingId}"},{"label":"Delete a group push mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouppushmapping/other/deletegrouppushmapping","routeSlug":"/openapi/okta-management/management/tags/grouppushmapping/other/deletegrouppushmapping","metadata":{"seo":{"title":"Delete a group push mapping","description":"
"}},"httpPath":"/api/v1/apps/{appId}/group-push/mappings/{mappingId}"}],"metadata":{"type":"openapi","title":"Group Push Mappings","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ext-manage-group-push)."}}]},{"type":"group","label":"Authenticators","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/authenticator.yaml","link":"/openapi/okta-management/management/tags/authenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator","label":"Authenticators","items":[{"type":"link","label":"Passkey (FIDO2 WebAuthn) authenticator","link":"/openapi/okta-management/management/tags/authenticator/section/passkey-(fido2-webauthn)-authenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/section/passkey-(fido2-webauthn)-authenticator"},{"type":"group","label":"Authenticators","link":"/openapi/okta-management/management/tags/authenticator/authenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/authenticator","items":[]},{"label":"Retrieve the well-known app authenticator configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/getwellknownappauthenticatorconfiguration","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/getwellknownappauthenticatorconfiguration","metadata":{"seo":{"title":"Retrieve the well-known app authenticator configuration","description":"Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details."}},"httpPath":"/.well-known/app-authenticator-configuration"},{"label":"List all authenticators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/listauthenticators","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/listauthenticators","metadata":{"seo":{"title":"List all authenticators","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.read
"}},"httpPath":"/api/v1/authenticators"},{"label":"Create an authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/createauthenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/createauthenticator","metadata":{"seo":{"title":"Create an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators"},{"label":"Retrieve an authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/getauthenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/getauthenticator","metadata":{"seo":{"title":"Retrieve an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.read
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}"},{"label":"Replace an authenticator","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/replaceauthenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/replaceauthenticator","metadata":{"seo":{"title":"Replace an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}"},{"label":"List all custom AAGUIDs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/listallcustomaaguids","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/listallcustomaaguids","metadata":{"seo":{"title":"List all custom AAGUIDs","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids"},{"label":"Create a custom AAGUID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/createcustomaaguid","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/createcustomaaguid","metadata":{"seo":{"title":"Create a custom AAGUID","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids"},{"label":"Retrieve a custom AAGUID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/getcustomaaguid","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/getcustomaaguid","metadata":{"seo":{"title":"Retrieve a custom AAGUID","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}"},{"label":"Replace a custom AAGUID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/replacecustomaaguid","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/replacecustomaaguid","metadata":{"seo":{"title":"Replace a custom AAGUID","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}"},{"label":"Update a custom AAGUID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/updatecustomaaguid","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/updatecustomaaguid","metadata":{"seo":{"title":"Update a custom AAGUID","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}"},{"label":"Delete a custom AAGUID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/deletecustomaaguid","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/deletecustomaaguid","metadata":{"seo":{"title":"Delete a custom AAGUID","description":"
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}"},{"label":"Activate an authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/activateauthenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/activateauthenticator","metadata":{"seo":{"title":"Activate an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/lifecycle/activate"},{"label":"Deactivate an authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/deactivateauthenticator","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/deactivateauthenticator","metadata":{"seo":{"title":"Deactivate an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/lifecycle/deactivate"},{"label":"List all methods of an authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/listauthenticatormethods","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/listauthenticatormethods","metadata":{"seo":{"title":"List all methods of an authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.read
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods"},{"label":"Retrieve an authenticator method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/getauthenticatormethod","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/getauthenticatormethod","metadata":{"seo":{"title":"Retrieve an authenticator method","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.read
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods/{methodType}"},{"label":"Replace an authenticator method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/replaceauthenticatormethod","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/replaceauthenticatormethod","metadata":{"seo":{"title":"Replace an authenticator method","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods/{methodType}"},{"label":"Activate an authenticator method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/activateauthenticatormethod","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/activateauthenticatormethod","metadata":{"seo":{"title":"Activate an authenticator method","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate"},{"label":"Deactivate an authenticator method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/deactivateauthenticatormethod","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/deactivateauthenticatormethod","metadata":{"seo":{"title":"Deactivate an authenticator method","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate"},{"label":"Verify a Relying Party ID domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authenticator/other/verifyrpiddomain","routeSlug":"/openapi/okta-management/management/tags/authenticator/other/verifyrpiddomain","metadata":{"seo":{"title":"Verify a Relying Party ID domain","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.authenticators.manage
"}},"httpPath":"/api/v1/authenticators/{authenticatorId}/methods/{webAuthnMethodType}/verify-rp-id-domain"}],"metadata":{"type":"openapi","title":"Authenticators","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://okta-developer.pixtulate.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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=webauthn-compatability)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/webauthnpreregistration.yaml","link":"/openapi/okta-management/management/tags/webauthnpreregistration","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration","label":"WebAuthn Preregistration","items":[{"type":"group","label":"WebAuthn Preregistration","link":"/openapi/okta-management/management/tags/webauthnpreregistration/webauthnpreregistration","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/webauthnpreregistration","items":[]},{"label":"Activate a preregistered WebAuthn factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/activatepreregistrationenrollment","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/activatepreregistrationenrollment","metadata":{"seo":{"title":"Activate a preregistered WebAuthn factor","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/activate"},{"label":"Enroll a preregistered WebAuthn factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/enrollpreregistrationenrollment","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/enrollpreregistrationenrollment","metadata":{"seo":{"title":"Enroll a preregistered WebAuthn factor","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/enroll"},{"label":"Generate a fulfillment request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/generatefulfillmentrequest","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/generatefulfillmentrequest","metadata":{"seo":{"title":"Generate a fulfillment request","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/initiate-fulfillment-request"},{"label":"Send a PIN to user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/sendpin","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/sendpin","metadata":{"seo":{"title":"Send a PIN to user","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/send-pin"},{"label":"List all WebAuthn preregistration factors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/listwebauthnpreregistrationfactors","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/listwebauthnpreregistrationfactors","metadata":{"seo":{"title":"List all WebAuthn preregistration factors","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/webauthn-registration/api/v1/users/{userId}/enrollments"},{"label":"Delete a WebAuthn preregistration factor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/deletewebauthnpreregistrationfactor","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/deletewebauthnpreregistrationfactor","metadata":{"seo":{"title":"Delete a WebAuthn preregistration factor","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/users/{userId}/enrollments/{authenticatorEnrollmentId}"},{"label":"Assign the fulfillment error status to a WebAuthn preregistration factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/webauthnpreregistration/other/assignfulfillmenterrorwebauthnpreregistrationfactor","routeSlug":"/openapi/okta-management/management/tags/webauthnpreregistration/other/assignfulfillmenterrorwebauthnpreregistrationfactor","metadata":{"seo":{"title":"Assign the fulfillment error status to a WebAuthn preregistration factor","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/webauthn-registration/api/v1/users/{userId}/enrollments/{authenticatorEnrollmentId}/mark-error"}],"metadata":{"type":"openapi","title":"WebAuthn Preregistration","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://okta-help.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/WebAuthnPreregistration/#tag/WebAuthnPreregistration/operation/generateFulfillmentRequest)\n 2. [Enroll a preregistered WebAuthn factor](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/WebAuthnPreregistration/#tag/WebAuthnPreregistration/operation/enrollPreregistrationEnrollment)\n 3. [Activate a preregistered WebAuthn factor](https://okta-developer.pixtulate.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)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/pushprovider.yaml","link":"/openapi/okta-management/management/tags/pushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider","label":"Push Providers","items":[{"type":"group","label":"Push Providers","link":"/openapi/okta-management/management/tags/pushprovider/pushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider/pushprovider","items":[]},{"label":"List all push providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/pushprovider/other/listpushproviders","routeSlug":"/openapi/okta-management/management/tags/pushprovider/other/listpushproviders","metadata":{"seo":{"title":"List all push providers","description":"
"}},"httpPath":"/api/v1/push-providers"},{"label":"Create a push provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/pushprovider/other/createpushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider/other/createpushprovider","metadata":{"seo":{"title":"Create a push provider","description":"
"}},"httpPath":"/api/v1/push-providers"},{"label":"Retrieve a push provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/pushprovider/other/getpushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider/other/getpushprovider","metadata":{"seo":{"title":"Retrieve a push provider","description":"
"}},"httpPath":"/api/v1/push-providers/{pushProviderId}"},{"label":"Replace a push provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/pushprovider/other/replacepushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider/other/replacepushprovider","metadata":{"seo":{"title":"Replace a push provider","description":"
"}},"httpPath":"/api/v1/push-providers/{pushProviderId}"},{"label":"Delete a push provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/pushprovider/other/deletepushprovider","routeSlug":"/openapi/okta-management/management/tags/pushprovider/other/deletepushprovider","metadata":{"seo":{"title":"Delete a push provider","description":"
"}},"httpPath":"/api/v1/push-providers/{pushProviderId}"}],"metadata":{"type":"openapi","title":"Push Providers","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://okta-developer.pixtulate.com/docs/reference/core-okta-api/#authentication)\n* Bearer - [OAuth2.0 and OpenID Connect](https://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/guides/authenticators-custom-authenticator/android/main/)."}}]},{"type":"group","label":"Authorization Servers","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserver.yaml","link":"/openapi/okta-management/management/tags/authorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver","label":"Authorization Servers","items":[{"type":"group","label":"Authorization Servers","link":"/openapi/okta-management/management/tags/authorizationserver/authorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/authorizationserver","items":[]},{"label":"List all authorization servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/listauthorizationservers","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/listauthorizationservers","metadata":{"seo":{"title":"List all authorization servers","description":"
"}},"httpPath":"/api/v1/authorizationServers"},{"label":"Create an authorization server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/createauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/createauthorizationserver","metadata":{"seo":{"title":"Create an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers"},{"label":"Retrieve an authorization server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/getauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/getauthorizationserver","metadata":{"seo":{"title":"Retrieve an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}"},{"label":"Replace an authorization server","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/replaceauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/replaceauthorizationserver","metadata":{"seo":{"title":"Replace an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}"},{"label":"Delete an authorization server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/deleteauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/deleteauthorizationserver","metadata":{"seo":{"title":"Delete an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}"},{"label":"Activate an authorization server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/activateauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/activateauthorizationserver","metadata":{"seo":{"title":"Activate an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/lifecycle/activate"},{"label":"Deactivate an authorization server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserver/other/deactivateauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserver/other/deactivateauthorizationserver","metadata":{"seo":{"title":"Deactivate an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Authorization Servers","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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverassoc.yaml","link":"/openapi/okta-management/management/tags/authorizationserverassoc","routeSlug":"/openapi/okta-management/management/tags/authorizationserverassoc","label":"Authorization Server Associated Servers","items":[{"type":"group","label":"Authorization Server Associated Servers","link":"/openapi/okta-management/management/tags/authorizationserverassoc/authorizationserverassoc","routeSlug":"/openapi/okta-management/management/tags/authorizationserverassoc/authorizationserverassoc","items":[]},{"label":"List all associated authorization servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverassoc/other/listassociatedserversbytrustedtype","routeSlug":"/openapi/okta-management/management/tags/authorizationserverassoc/other/listassociatedserversbytrustedtype","metadata":{"seo":{"title":"List all associated authorization servers","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/associatedServers"},{"label":"Create an associated authorization server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverassoc/other/createassociatedservers","routeSlug":"/openapi/okta-management/management/tags/authorizationserverassoc/other/createassociatedservers","metadata":{"seo":{"title":"Create an associated authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/associatedServers"},{"label":"Delete an associated authorization server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverassoc/other/deleteassociatedserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserverassoc/other/deleteassociatedserver","metadata":{"seo":{"title":"Delete an associated authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}"}],"metadata":{"type":"openapi","title":"Authorization Server Associated 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://okta-developer.pixtulate.com/docs/guides/set-up-token-exchange/main/#trusted-servers) between other authorization servers under the same Okta tenant."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverclaims.yaml","link":"/openapi/okta-management/management/tags/authorizationserverclaims","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims","label":"Authorization Server Claims","items":[{"type":"group","label":"Authorization Server Claims","link":"/openapi/okta-management/management/tags/authorizationserverclaims/authorizationserverclaims","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/authorizationserverclaims","items":[]},{"label":"List all custom token claims","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclaims/other/listoauth2claims","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/other/listoauth2claims","metadata":{"seo":{"title":"List all custom token claims","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/claims"},{"label":"Create a custom token claim","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclaims/other/createoauth2claim","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/other/createoauth2claim","metadata":{"seo":{"title":"Create a custom token claim","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/claims"},{"label":"Retrieve a custom token claim","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclaims/other/getoauth2claim","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/other/getoauth2claim","metadata":{"seo":{"title":"Retrieve a custom token claim","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/claims/{claimId}"},{"label":"Replace a custom token claim","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclaims/other/replaceoauth2claim","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/other/replaceoauth2claim","metadata":{"seo":{"title":"Replace a custom token claim","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/claims/{claimId}"},{"label":"Delete a custom token claim","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclaims/other/deleteoauth2claim","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclaims/other/deleteoauth2claim","metadata":{"seo":{"title":"Delete a custom token claim","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/claims/{claimId}"}],"metadata":{"type":"openapi","title":"Authorization Server Claims","description":"Provides operations to manage custom token claims for the given `authServerId` and `claimId`"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverclients.yaml","link":"/openapi/okta-management/management/tags/authorizationserverclients","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients","label":"Authorization Server Clients","items":[{"type":"group","label":"Authorization Server Clients","link":"/openapi/okta-management/management/tags/authorizationserverclients/authorizationserverclients","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/authorizationserverclients","items":[]},{"label":"List all client resources for an authorization server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclients/other/listoauth2clientsforauthorizationserver","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/other/listoauth2clientsforauthorizationserver","metadata":{"seo":{"title":"List all client resources for an authorization server","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/clients"},{"label":"List all refresh tokens for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclients/other/listrefreshtokensforauthorizationserverandclient","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/other/listrefreshtokensforauthorizationserverandclient","metadata":{"seo":{"title":"List all refresh tokens for a client","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens"},{"label":"Revoke all refresh tokens for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclients/other/revokerefreshtokensforauthorizationserverandclient","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/other/revokerefreshtokensforauthorizationserverandclient","metadata":{"seo":{"title":"Revoke all refresh tokens for a client","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens"},{"label":"Retrieve a refresh token for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclients/other/getrefreshtokenforauthorizationserverandclient","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/other/getrefreshtokenforauthorizationserverandclient","metadata":{"seo":{"title":"Retrieve a refresh token for a client","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}"},{"label":"Revoke a refresh token for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverclients/other/revokerefreshtokenforauthorizationserverandclient","routeSlug":"/openapi/okta-management/management/tags/authorizationserverclients/other/revokerefreshtokenforauthorizationserverandclient","metadata":{"seo":{"title":"Revoke a refresh token for a client","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}"}],"metadata":{"type":"openapi","title":"Authorization Server Clients","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://okta-developer.pixtulate.com/docs/guides/validate-access-tokens/dotnet/main/) and [Validate ID tokens](https://okta-developer.pixtulate.com/docs/guides/validate-id-tokens/main/) to understand more about how OAuth 2.0 tokens work."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverkeys.yaml","link":"/openapi/okta-management/management/tags/authorizationserverkeys","routeSlug":"/openapi/okta-management/management/tags/authorizationserverkeys","label":"Authorization Server Keys","items":[{"type":"group","label":"Authorization Server Keys","link":"/openapi/okta-management/management/tags/authorizationserverkeys/authorizationserverkeys","routeSlug":"/openapi/okta-management/management/tags/authorizationserverkeys/authorizationserverkeys","items":[]},{"label":"List all credential keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverkeys/other/listauthorizationserverkeys","routeSlug":"/openapi/okta-management/management/tags/authorizationserverkeys/other/listauthorizationserverkeys","metadata":{"seo":{"title":"List all credential keys","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/credentials/keys"},{"label":"Retrieve an authorization server key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverkeys/other/getauthorizationserverkey","routeSlug":"/openapi/okta-management/management/tags/authorizationserverkeys/other/getauthorizationserverkey","metadata":{"seo":{"title":"Retrieve an authorization server key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/credentials/keys/{keyId}"},{"label":"Rotate all credential keys","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverkeys/other/rotateauthorizationserverkeys","routeSlug":"/openapi/okta-management/management/tags/authorizationserverkeys/other/rotateauthorizationserverkeys","metadata":{"seo":{"title":"Rotate all credential keys","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate"}],"metadata":{"type":"openapi","title":"Authorization Server Keys","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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/oauth/customas/getwellknownopenidconfigurationcustomas) and the [well-known OAuth 2.0 metadata endpoint](https://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/oauth/customas/getwellknownoauthconfigurationcustomas)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/oauth2resourceservercredentialskeys.yaml","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys","label":"Authorization Server Public Keys","items":[{"type":"group","label":"Authorization Server Public Keys","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/oauth2resourceservercredentialskeys","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/oauth2resourceservercredentialskeys","items":[]},{"label":"List all Custom Authorization Server Public JSON Web Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/listoauth2resourceserverjsonwebkeys","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/listoauth2resourceserverjsonwebkeys","metadata":{"seo":{"title":"List all Custom Authorization Server Public JSON Web Keys","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys"},{"label":"Add a JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/addoauth2resourceserverjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/addoauth2resourceserverjsonwebkey","metadata":{"seo":{"title":"Add a JSON Web Key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys"},{"label":"Retrieve a Custom Authorization Server Public JSON Web Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/getoauth2resourceserverjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/getoauth2resourceserverjsonwebkey","metadata":{"seo":{"title":"Retrieve a Custom Authorization Server Public JSON Web Key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}"},{"label":"Delete a Custom Authorization Server Public JSON Web Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/deleteoauth2resourceserverjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/deleteoauth2resourceserverjsonwebkey","metadata":{"seo":{"title":"Delete a Custom Authorization Server Public JSON Web Key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}"},{"label":"Activate a Custom Authorization Server Public JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/activateoauth2resourceserverjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/activateoauth2resourceserverjsonwebkey","metadata":{"seo":{"title":"Activate a Custom Authorization Server Public JSON Web Key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/activate"},{"label":"Deactivate a Custom Authorization Server Public JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/deactivateoauth2resourceserverjsonwebkey","routeSlug":"/openapi/okta-management/management/tags/oauth2resourceservercredentialskeys/other/deactivateoauth2resourceserverjsonwebkey","metadata":{"seo":{"title":"Deactivate a Custom Authorization Server Public JSON Web Key","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Authorization Server Public Keys","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverpolicies.yaml","link":"/openapi/okta-management/management/tags/authorizationserverpolicies","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies","label":"Authorization Server Policies","items":[{"type":"group","label":"Authorization Server Policies","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/authorizationserverpolicies","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/authorizationserverpolicies","items":[]},{"label":"List all policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/listauthorizationserverpolicies","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/listauthorizationserverpolicies","metadata":{"seo":{"title":"List all policies","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies"},{"label":"Create a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/createauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/createauthorizationserverpolicy","metadata":{"seo":{"title":"Create a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies"},{"label":"Retrieve a policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/getauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/getauthorizationserverpolicy","metadata":{"seo":{"title":"Retrieve a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}"},{"label":"Replace a policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/replaceauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/replaceauthorizationserverpolicy","metadata":{"seo":{"title":"Replace a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}"},{"label":"Delete a policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/deleteauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/deleteauthorizationserverpolicy","metadata":{"seo":{"title":"Delete a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}"},{"label":"Activate a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/activateauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/activateauthorizationserverpolicy","metadata":{"seo":{"title":"Activate a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate"},{"label":"Deactivate a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/deactivateauthorizationserverpolicy","routeSlug":"/openapi/okta-management/management/tags/authorizationserverpolicies/other/deactivateauthorizationserverpolicy","metadata":{"seo":{"title":"Deactivate a policy","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Authorization Server Policies","description":"Provides operations to manage policies for the given `authServerId`."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverrules.yaml","link":"/openapi/okta-management/management/tags/authorizationserverrules","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules","label":"Authorization Server Rules","items":[{"type":"group","label":"Authorization Server Rules","link":"/openapi/okta-management/management/tags/authorizationserverrules/authorizationserverrules","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/authorizationserverrules","items":[]},{"label":"List all policy rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/listauthorizationserverpolicyrules","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/listauthorizationserverpolicyrules","metadata":{"seo":{"title":"List all policy rules","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules"},{"label":"Create a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/createauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/createauthorizationserverpolicyrule","metadata":{"seo":{"title":"Create a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules"},{"label":"Retrieve a policy rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/getauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/getauthorizationserverpolicyrule","metadata":{"seo":{"title":"Retrieve a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}"},{"label":"Replace a policy rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/replaceauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/replaceauthorizationserverpolicyrule","metadata":{"seo":{"title":"Replace a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}"},{"label":"Delete a policy rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/deleteauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/deleteauthorizationserverpolicyrule","metadata":{"seo":{"title":"Delete a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}"},{"label":"Activate a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/activateauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/activateauthorizationserverpolicyrule","metadata":{"seo":{"title":"Activate a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate"},{"label":"Deactivate a policy rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverrules/other/deactivateauthorizationserverpolicyrule","routeSlug":"/openapi/okta-management/management/tags/authorizationserverrules/other/deactivateauthorizationserverpolicyrule","metadata":{"seo":{"title":"Deactivate a policy rule","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Authorization Server Rules","description":"Provides operations to manage policy rules for the given `authServerId`, `policyId`, and `ruleId`."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/authorizationserverscopes.yaml","link":"/openapi/okta-management/management/tags/authorizationserverscopes","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes","label":"Authorization Server Scopes","items":[{"type":"group","label":"Authorization Server Scopes","link":"/openapi/okta-management/management/tags/authorizationserverscopes/authorizationserverscopes","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/authorizationserverscopes","items":[]},{"label":"List all custom token scopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverscopes/other/listoauth2scopes","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/other/listoauth2scopes","metadata":{"seo":{"title":"List all custom token scopes","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/scopes"},{"label":"Create a custom token scope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverscopes/other/createoauth2scope","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/other/createoauth2scope","metadata":{"seo":{"title":"Create a custom token scope","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/scopes"},{"label":"Retrieve a custom token scope","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverscopes/other/getoauth2scope","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/other/getoauth2scope","metadata":{"seo":{"title":"Retrieve a custom token scope","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}"},{"label":"Replace a custom token scope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverscopes/other/replaceoauth2scope","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/other/replaceoauth2scope","metadata":{"seo":{"title":"Replace a custom token scope","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}"},{"label":"Delete a custom token scope","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/authorizationserverscopes/other/deleteoauth2scope","routeSlug":"/openapi/okta-management/management/tags/authorizationserverscopes/other/deleteoauth2scope","metadata":{"seo":{"title":"Delete a custom token scope","description":"
"}},"httpPath":"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}"}],"metadata":{"type":"openapi","title":"Authorization Server Scopes","description":"Provides operations to manage custom token scopes for the given `authServerId` and `scopeId`. See [scope properties](https://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/#scope-properties)."}}]},{"type":"group","label":"Customizations","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/associateddomaincustomizations.yaml","link":"/openapi/okta-management/management/tags/associateddomaincustomizations","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations","label":"Associated Domain Customizations","items":[{"type":"group","label":"Associated Domain Customizations","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/associateddomaincustomizations","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/associateddomaincustomizations","items":[]},{"label":"/.well-known/apple-app-site-association","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1apple-app-site-association/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1apple-app-site-association/x-okta-lifecycle","metadata":{"seo":{"title":"/.well-known/apple-app-site-association"}},"httpPath":"/.well-known/apple-app-site-association"},{"label":"Retrieve the customized apple-app-site-association URI content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getappleappsiteassociationwellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getappleappsiteassociationwellknownuri","metadata":{"seo":{"title":"Retrieve the customized apple-app-site-association URI content","description":"Retrieves the content of the apple-app-site-assocation well-known URI"}},"httpPath":"/.well-known/apple-app-site-association"},{"label":"/.well-known/assetlinks.json","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1assetlinks.json/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1assetlinks.json/x-okta-lifecycle","metadata":{"seo":{"title":"/.well-known/assetlinks.json"}},"httpPath":"/.well-known/assetlinks.json"},{"label":"Retrieve the customized assetlinks.json URI content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getassetlinkswellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getassetlinkswellknownuri","metadata":{"seo":{"title":"Retrieve the customized assetlinks.json URI content","description":"Retrieves the content of the assetlinks.json well-known URI"}},"httpPath":"/.well-known/assetlinks.json"},{"label":"/.well-known/webauthn","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1webauthn/x-okta-lifecycle","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/paths/~1.well-known~1webauthn/x-okta-lifecycle","metadata":{"seo":{"title":"/.well-known/webauthn"}},"httpPath":"/.well-known/webauthn"},{"label":"Retrieve the customized webauthn URI content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getwebauthnwellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getwebauthnwellknownuri","metadata":{"seo":{"title":"Retrieve the customized webauthn URI content","description":"Retrieves the content of the webauthn well-known URI"}},"httpPath":"/.well-known/webauthn"},{"label":"Retrieve all the well-known URIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getallwellknownuris","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getallwellknownuris","metadata":{"seo":{"title":"Retrieve all the well-known URIs","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.brands.read
"}},"httpPath":"/api/v1/brands/{brandId}/well-known-uris"},{"label":"Retrieve the well-known URI of a specific brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getrootbrandwellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getrootbrandwellknownuri","metadata":{"seo":{"title":"Retrieve the well-known URI of a specific brand","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.brands.read
"}},"httpPath":"/api/v1/brands/{brandId}/well-known-uris/{path}"},{"label":"Retrieve the customized content of the specified well-known URI","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getbrandwellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/getbrandwellknownuri","metadata":{"seo":{"title":"Retrieve the customized content of the specified well-known URI","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.brands.read
"}},"httpPath":"/api/v1/brands/{brandId}/well-known-uris/{path}/customized"},{"label":"Replace the customized well-known URI of the specific path","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/replacebrandwellknownuri","routeSlug":"/openapi/okta-management/management/tags/associateddomaincustomizations/other/replacebrandwellknownuri","metadata":{"seo":{"title":"Replace the customized well-known URI of the specific path","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.brands.manage
"}},"httpPath":"/api/v1/brands/{brandId}/well-known-uris/{path}/customized"}],"metadata":{"type":"openapi","title":"Associated Domain Customizations","description":"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://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/brands.yaml","link":"/openapi/okta-management/management/tags/brands","routeSlug":"/openapi/okta-management/management/tags/brands","label":"Brands","items":[{"type":"group","label":"Brands","link":"/openapi/okta-management/management/tags/brands/brands","routeSlug":"/openapi/okta-management/management/tags/brands/brands","items":[]},{"label":"List all brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/listbrands","routeSlug":"/openapi/okta-management/management/tags/brands/other/listbrands","metadata":{"seo":{"title":"List all brands","description":"
"}},"httpPath":"/api/v1/brands"},{"label":"Create a brand","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/createbrand","routeSlug":"/openapi/okta-management/management/tags/brands/other/createbrand","metadata":{"seo":{"title":"Create a brand","description":"
"}},"httpPath":"/api/v1/brands"},{"label":"Retrieve a brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/getbrand","routeSlug":"/openapi/okta-management/management/tags/brands/other/getbrand","metadata":{"seo":{"title":"Retrieve a brand","description":"
"}},"httpPath":"/api/v1/brands/{brandId}"},{"label":"Replace a brand","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/replacebrand","routeSlug":"/openapi/okta-management/management/tags/brands/other/replacebrand","metadata":{"seo":{"title":"Replace a brand","description":"
"}},"httpPath":"/api/v1/brands/{brandId}"},{"label":"Delete a brand","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/deletebrand","routeSlug":"/openapi/okta-management/management/tags/brands/other/deletebrand","metadata":{"seo":{"title":"Delete a brand","description":"
"}},"httpPath":"/api/v1/brands/{brandId}"},{"label":"List all domains associated with a brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/brands/other/listbranddomains","routeSlug":"/openapi/okta-management/management/tags/brands/other/listbranddomains","metadata":{"seo":{"title":"List all domains associated with a brand","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/domains"}],"metadata":{"type":"openapi","title":"Brands","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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [The sign-out page](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [Error pages](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [Email templates](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/CustomTemplates/)\n* [The Okta End-User Dashboard](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/customdomain.yaml","link":"/openapi/okta-management/management/tags/customdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain","label":"Custom Domains","items":[{"type":"group","label":"Custom Domains","link":"/openapi/okta-management/management/tags/customdomain/customdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/customdomain","items":[]},{"label":"List all custom domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/listcustomdomains","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/listcustomdomains","metadata":{"seo":{"title":"List all custom domains","description":"
"}},"httpPath":"/api/v1/domains"},{"label":"Create a custom domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/createcustomdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/createcustomdomain","metadata":{"seo":{"title":"Create a custom domain","description":"
"}},"httpPath":"/api/v1/domains"},{"label":"Retrieve a custom domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/getcustomdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/getcustomdomain","metadata":{"seo":{"title":"Retrieve a custom domain","description":"
"}},"httpPath":"/api/v1/domains/{domainId}"},{"label":"Replace a custom domain's brand","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/replacecustomdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/replacecustomdomain","metadata":{"seo":{"title":"Replace a custom domain's brand","description":"
"}},"httpPath":"/api/v1/domains/{domainId}"},{"label":"Delete a custom domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/deletecustomdomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/deletecustomdomain","metadata":{"seo":{"title":"Delete a custom domain","description":"
"}},"httpPath":"/api/v1/domains/{domainId}"},{"label":"Upsert the custom domain's certificate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/upsertcertificate","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/upsertcertificate","metadata":{"seo":{"title":"Upsert the custom domain's certificate","description":"
"}},"httpPath":"/api/v1/domains/{domainId}/certificate"},{"label":"Verify a custom domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customdomain/other/verifydomain","routeSlug":"/openapi/okta-management/management/tags/customdomain/other/verifydomain","metadata":{"seo":{"title":"Verify a custom domain","description":"
"}},"httpPath":"/api/v1/domains/{domainId}/verify"}],"metadata":{"type":"openapi","title":"Custom Domains","description":"The Custom Domains API provides operations to manage custom domains for your organization."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/custompages.yaml","link":"/openapi/okta-management/management/tags/custompages","routeSlug":"/openapi/okta-management/management/tags/custompages","label":"Custom Pages","items":[{"type":"group","label":"Custom Pages","link":"/openapi/okta-management/management/tags/custompages/custompages","routeSlug":"/openapi/okta-management/management/tags/custompages/custompages","items":[]},{"label":"Retrieve the error page sub-resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/geterrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/geterrorpage","metadata":{"seo":{"title":"Retrieve the error page sub-resources","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error"},{"label":"Retrieve the customized error page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getcustomizederrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getcustomizederrorpage","metadata":{"seo":{"title":"Retrieve the customized error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/customized"},{"label":"Replace the customized error page","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/replacecustomizederrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/replacecustomizederrorpage","metadata":{"seo":{"title":"Replace the customized error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/customized"},{"label":"Delete the customized error page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/deletecustomizederrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/deletecustomizederrorpage","metadata":{"seo":{"title":"Delete the customized error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/customized"},{"label":"Retrieve the default error page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getdefaulterrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getdefaulterrorpage","metadata":{"seo":{"title":"Retrieve the default error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/default"},{"label":"Retrieve the preview error page preview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getpreviewerrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getpreviewerrorpage","metadata":{"seo":{"title":"Retrieve the preview error page preview","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/preview"},{"label":"Replace the preview error page","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/replacepreviewerrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/replacepreviewerrorpage","metadata":{"seo":{"title":"Replace the preview error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/preview"},{"label":"Delete the preview error page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/deletepreviewerrorpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/deletepreviewerrorpage","metadata":{"seo":{"title":"Delete the preview error page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/error/preview"},{"label":"Retrieve the sign-in page sub-resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getsigninpage","metadata":{"seo":{"title":"Retrieve the sign-in page sub-resources","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in"},{"label":"Retrieve the customized sign-in page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getcustomizedsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getcustomizedsigninpage","metadata":{"seo":{"title":"Retrieve the customized sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/customized"},{"label":"Replace the customized sign-in page","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/replacecustomizedsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/replacecustomizedsigninpage","metadata":{"seo":{"title":"Replace the customized sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/customized"},{"label":"Delete the customized sign-in page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/deletecustomizedsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/deletecustomizedsigninpage","metadata":{"seo":{"title":"Delete the customized sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/customized"},{"label":"Retrieve the default sign-in page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getdefaultsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getdefaultsigninpage","metadata":{"seo":{"title":"Retrieve the default sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/default"},{"label":"Retrieve the preview sign-in page preview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getpreviewsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getpreviewsigninpage","metadata":{"seo":{"title":"Retrieve the preview sign-in page preview","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/preview"},{"label":"Replace the preview sign-in page","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/replacepreviewsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/replacepreviewsigninpage","metadata":{"seo":{"title":"Replace the preview sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/preview"},{"label":"Delete the preview sign-in page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/deletepreviewsigninpage","routeSlug":"/openapi/okta-management/management/tags/custompages/other/deletepreviewsigninpage","metadata":{"seo":{"title":"Delete the preview sign-in page","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/preview"},{"label":"List all Sign-In Widget versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/listallsigninwidgetversions","routeSlug":"/openapi/okta-management/management/tags/custompages/other/listallsigninwidgetversions","metadata":{"seo":{"title":"List all Sign-In Widget versions","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-in/widget-versions"},{"label":"Retrieve the sign-out page settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/getsignoutpagesettings","routeSlug":"/openapi/okta-management/management/tags/custompages/other/getsignoutpagesettings","metadata":{"seo":{"title":"Retrieve the sign-out page settings","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-out/customized"},{"label":"Replace the sign-out page settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/custompages/other/replacesignoutpagesettings","routeSlug":"/openapi/okta-management/management/tags/custompages/other/replacesignoutpagesettings","metadata":{"seo":{"title":"Replace the sign-out page settings","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/pages/sign-out/customized"}],"metadata":{"type":"openapi","title":"Custom Pages","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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/customtelephonyprovider.yaml","link":"/openapi/okta-management/management/tags/customtelephonyprovider","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider","label":"Custom Telephony Provider","items":[{"type":"group","label":"Custom Telephony Provider","link":"/openapi/okta-management/management/tags/customtelephonyprovider/customtelephonyprovider","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/customtelephonyprovider","items":[]},{"label":"List all custom telephony providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/listallcustomtelephonyprovidercredentials","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/listallcustomtelephonyprovidercredentials","metadata":{"seo":{"title":"List all custom telephony providers","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.read
"}},"httpPath":"/api/v1/telephony-providers"},{"label":"Create a custom telephony provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/createcustomtelephonyprovidercredentials","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/createcustomtelephonyprovidercredentials","metadata":{"seo":{"title":"Create a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers"},{"label":"Retrieve a custom telephony provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/getcustomtelephonyprovidercredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/getcustomtelephonyprovidercredential","metadata":{"seo":{"title":"Retrieve a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.read
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}"},{"label":"Update a custom telephony provider credential","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/updatecustomtelephonyprovidercredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/updatecustomtelephonyprovidercredential","metadata":{"seo":{"title":"Update a custom telephony provider credential","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}"},{"label":"Delete a custom telephony provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/deletecustomtelephonyprovidercredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/deletecustomtelephonyprovidercredential","metadata":{"seo":{"title":"Delete a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}"},{"label":"Activate a custom telephony provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/activatecustomtelephonycredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/activatecustomtelephonycredential","metadata":{"seo":{"title":"Activate a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}/lifecycle/activate"},{"label":"Deactivate a custom telephony provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/deactivatecustomtelephonycredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/deactivatecustomtelephonycredential","metadata":{"seo":{"title":"Deactivate a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}/lifecycle/deactivate"},{"label":"Set a custom telephony provider as a primary telephony provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/setasprimarycustomtelephonycredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/setasprimarycustomtelephonycredential","metadata":{"seo":{"title":"Set a custom telephony provider as a primary telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}/setAsPrimary"},{"label":"Send a test message from a custom telephony provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtelephonyprovider/other/sendtestcustomtelephonyprovidercredential","routeSlug":"/openapi/okta-management/management/tags/customtelephonyprovider/other/sendtestcustomtelephonyprovidercredential","metadata":{"seo":{"title":"Send a test message from a custom telephony provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.customTelephonyProvider.manage
"}},"httpPath":"/api/v1/telephony-providers/{customTelephonyProviderId}/test"}],"metadata":{"type":"openapi","title":"Custom Telephony Provider","description":"\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://okta-help.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/customtemplates.yaml","link":"/openapi/okta-management/management/tags/customtemplates","routeSlug":"/openapi/okta-management/management/tags/customtemplates","label":"Custom Email Templates","items":[{"type":"link","label":"Enable other locales","link":"/openapi/okta-management/management/tags/customtemplates/section/enable-other-locales","routeSlug":"/openapi/okta-management/management/tags/customtemplates/section/enable-other-locales"},{"type":"group","label":"Custom Email Templates","link":"/openapi/okta-management/management/tags/customtemplates/customtemplates","routeSlug":"/openapi/okta-management/management/tags/customtemplates/customtemplates","items":[]},{"label":"List all email templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/listemailtemplates","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/listemailtemplates","metadata":{"seo":{"title":"List all email templates","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email"},{"label":"Retrieve an email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getemailtemplate","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getemailtemplate","metadata":{"seo":{"title":"Retrieve an email template","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}"},{"label":"List all email customizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/listemailcustomizations","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/listemailcustomizations","metadata":{"seo":{"title":"List all email customizations","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations"},{"label":"Create an email customization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/createemailcustomization","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/createemailcustomization","metadata":{"seo":{"title":"Create an email customization","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations"},{"label":"Delete all email customizations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/deleteallcustomizations","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/deleteallcustomizations","metadata":{"seo":{"title":"Delete all email customizations","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations"},{"label":"Retrieve an email customization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getemailcustomization","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getemailcustomization","metadata":{"seo":{"title":"Retrieve an email customization","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}"},{"label":"Replace an email customization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/replaceemailcustomization","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/replaceemailcustomization","metadata":{"seo":{"title":"Replace an email customization","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}"},{"label":"Delete an email customization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/deleteemailcustomization","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/deleteemailcustomization","metadata":{"seo":{"title":"Delete an email customization","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}"},{"label":"Retrieve a preview of an email customization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getcustomizationpreview","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getcustomizationpreview","metadata":{"seo":{"title":"Retrieve a preview of an email customization","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview"},{"label":"Retrieve an email template default content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getemaildefaultcontent","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getemaildefaultcontent","metadata":{"seo":{"title":"Retrieve an email template default content","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/default-content"},{"label":"Retrieve a preview of the email template default content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getemaildefaultpreview","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getemaildefaultpreview","metadata":{"seo":{"title":"Retrieve a preview of the email template default content","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview"},{"label":"Retrieve the email template settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/getemailsettings","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/getemailsettings","metadata":{"seo":{"title":"Retrieve the email template settings","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/settings"},{"label":"Replace the email template settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/replaceemailsettings","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/replaceemailsettings","metadata":{"seo":{"title":"Replace the email template settings","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/settings"},{"label":"Send a test email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/customtemplates/other/sendtestemail","routeSlug":"/openapi/okta-management/management/tags/customtemplates/other/sendtestemail","metadata":{"seo":{"title":"Send a test email","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/templates/email/{templateName}/test"}],"metadata":{"type":"openapi","title":"Custom Email Templates","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://okta-developer.pixtulate.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://okta-developer.pixtulate.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\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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/emaildomain.yaml","link":"/openapi/okta-management/management/tags/emaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain","label":"Email Domains","items":[{"type":"group","label":"Email Domains","link":"/openapi/okta-management/management/tags/emaildomain/emaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/emaildomain","items":[]},{"label":"List all email domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/listemaildomains","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/listemaildomains","metadata":{"seo":{"title":"List all email domains","description":"
"}},"httpPath":"/api/v1/email-domains"},{"label":"Create an email domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/createemaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/createemaildomain","metadata":{"seo":{"title":"Create an email domain","description":"
"}},"httpPath":"/api/v1/email-domains"},{"label":"Retrieve an email domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/getemaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/getemaildomain","metadata":{"seo":{"title":"Retrieve an email domain","description":"
"}},"httpPath":"/api/v1/email-domains/{emailDomainId}"},{"label":"Replace an email domain","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/replaceemaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/replaceemaildomain","metadata":{"seo":{"title":"Replace an email domain","description":"
"}},"httpPath":"/api/v1/email-domains/{emailDomainId}"},{"label":"Delete an email domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/deleteemaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/deleteemaildomain","metadata":{"seo":{"title":"Delete an email domain","description":"
"}},"httpPath":"/api/v1/email-domains/{emailDomainId}"},{"label":"Verify an email domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emaildomain/other/verifyemaildomain","routeSlug":"/openapi/okta-management/management/tags/emaildomain/other/verifyemaildomain","metadata":{"seo":{"title":"Verify an email domain","description":"
"}},"httpPath":"/api/v1/email-domains/{emailDomainId}/verify"}],"metadata":{"type":"openapi","title":"Email Domains","description":"The Email Domains API provides operations to manage email domains for your organization."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/emailserver.yaml","link":"/openapi/okta-management/management/tags/emailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver","label":"Email Servers","items":[{"type":"group","label":"Email Servers","link":"/openapi/okta-management/management/tags/emailserver/emailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/emailserver","items":[]},{"label":"List all enrolled SMTP servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/listemailservers","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/listemailservers","metadata":{"seo":{"title":"List all enrolled SMTP servers","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.read
"}},"httpPath":"/api/v1/email-servers"},{"label":"Create a custom SMTP server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/createemailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/createemailserver","metadata":{"seo":{"title":"Create a custom SMTP server","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.manage
"}},"httpPath":"/api/v1/email-servers"},{"label":"Retrieve an SMTP server configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/getemailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/getemailserver","metadata":{"seo":{"title":"Retrieve an SMTP server configuration","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.read
"}},"httpPath":"/api/v1/email-servers/{emailServerId}"},{"label":"Update an SMTP server configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/updateemailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/updateemailserver","metadata":{"seo":{"title":"Update an SMTP server configuration","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.manage
"}},"httpPath":"/api/v1/email-servers/{emailServerId}"},{"label":"Delete an SMTP server configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/deleteemailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/deleteemailserver","metadata":{"seo":{"title":"Delete an SMTP server configuration","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.manage
"}},"httpPath":"/api/v1/email-servers/{emailServerId}"},{"label":"Test an SMTP server configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailserver/other/testemailserver","routeSlug":"/openapi/okta-management/management/tags/emailserver/other/testemailserver","metadata":{"seo":{"title":"Test an SMTP server configuration","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.emailServers.manage
"}},"httpPath":"/api/v1/email-servers/{emailServerId}/test"}],"metadata":{"type":"openapi","title":"Email Servers","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://okta-developer.pixtulate.com/docs/guides/custom-smtp/main/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/template.yaml","link":"/openapi/okta-management/management/tags/template","routeSlug":"/openapi/okta-management/management/tags/template","label":"SMS Templates","items":[{"type":"link","label":"SMS Template macros","link":"/openapi/okta-management/management/tags/template/section/sms-template-macros","routeSlug":"/openapi/okta-management/management/tags/template/section/sms-template-macros"},{"type":"group","label":"SMS Templates","link":"/openapi/okta-management/management/tags/template/template","routeSlug":"/openapi/okta-management/management/tags/template/template","items":[]},{"label":"List all SMS templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/listsmstemplates","routeSlug":"/openapi/okta-management/management/tags/template/other/listsmstemplates","metadata":{"seo":{"title":"List all SMS templates","description":"
"}},"httpPath":"/api/v1/templates/sms"},{"label":"Create an SMS template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/createsmstemplate","routeSlug":"/openapi/okta-management/management/tags/template/other/createsmstemplate","metadata":{"seo":{"title":"Create an SMS template","description":"
"}},"httpPath":"/api/v1/templates/sms"},{"label":"Retrieve an SMS template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/getsmstemplate","routeSlug":"/openapi/okta-management/management/tags/template/other/getsmstemplate","metadata":{"seo":{"title":"Retrieve an SMS template","description":"
"}},"httpPath":"/api/v1/templates/sms/{templateId}"},{"label":"Update an SMS template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/updatesmstemplate","routeSlug":"/openapi/okta-management/management/tags/template/other/updatesmstemplate","metadata":{"seo":{"title":"Update an SMS template","description":"
"}},"httpPath":"/api/v1/templates/sms/{templateId}"},{"label":"Replace an SMS template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/replacesmstemplate","routeSlug":"/openapi/okta-management/management/tags/template/other/replacesmstemplate","metadata":{"seo":{"title":"Replace an SMS template","description":"
"}},"httpPath":"/api/v1/templates/sms/{templateId}"},{"label":"Delete an SMS template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/template/other/deletesmstemplate","routeSlug":"/openapi/okta-management/management/tags/template/other/deletesmstemplate","metadata":{"seo":{"title":"Delete an SMS template","description":"
"}},"httpPath":"/api/v1/templates/sms/{templateId}"}],"metadata":{"type":"openapi","title":"SMS Templates","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|
Type
| 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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/themes.yaml","link":"/openapi/okta-management/management/tags/themes","routeSlug":"/openapi/okta-management/management/tags/themes","label":"Themes","items":[{"type":"group","label":"Themes","link":"/openapi/okta-management/management/tags/themes/themes","routeSlug":"/openapi/okta-management/management/tags/themes/themes","items":[]},{"label":"List all themes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/listbrandthemes","routeSlug":"/openapi/okta-management/management/tags/themes/other/listbrandthemes","metadata":{"seo":{"title":"List all themes","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes"},{"label":"Retrieve a theme","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/getbrandtheme","routeSlug":"/openapi/okta-management/management/tags/themes/other/getbrandtheme","metadata":{"seo":{"title":"Retrieve a theme","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}"},{"label":"Replace a theme","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/replacebrandtheme","routeSlug":"/openapi/okta-management/management/tags/themes/other/replacebrandtheme","metadata":{"seo":{"title":"Replace a theme","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}"},{"label":"Upload the background image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemebackgroundimage","routeSlug":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemebackgroundimage","metadata":{"seo":{"title":"Upload the background image","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/background-image"},{"label":"Delete the background image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/deletebrandthemebackgroundimage","routeSlug":"/openapi/okta-management/management/tags/themes/other/deletebrandthemebackgroundimage","metadata":{"seo":{"title":"Delete the background image","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/background-image"},{"label":"Upload the favicon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemefavicon","routeSlug":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemefavicon","metadata":{"seo":{"title":"Upload the favicon","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/favicon"},{"label":"Delete the favicon","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/deletebrandthemefavicon","routeSlug":"/openapi/okta-management/management/tags/themes/other/deletebrandthemefavicon","metadata":{"seo":{"title":"Delete the favicon","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/favicon"},{"label":"Upload the logo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemelogo","routeSlug":"/openapi/okta-management/management/tags/themes/other/uploadbrandthemelogo","metadata":{"seo":{"title":"Upload the logo","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/logo"},{"label":"Delete the logo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/themes/other/deletebrandthemelogo","routeSlug":"/openapi/okta-management/management/tags/themes/other/deletebrandthemelogo","metadata":{"seo":{"title":"Delete the logo","description":"
"}},"httpPath":"/api/v1/brands/{brandId}/themes/{themeId}/logo"}],"metadata":{"type":"openapi","title":"Themes","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://okta-developer.pixtulate.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."}}]},{"type":"group","label":"Devices","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/device.yaml","link":"/openapi/okta-management/management/tags/device","routeSlug":"/openapi/okta-management/management/tags/device","label":"Devices","items":[{"type":"group","label":"Devices","link":"/openapi/okta-management/management/tags/device/device","routeSlug":"/openapi/okta-management/management/tags/device/device","items":[]},{"label":"List all devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/listdevices","routeSlug":"/openapi/okta-management/management/tags/device/other/listdevices","metadata":{"seo":{"title":"List all devices","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices"},{"label":"Retrieve a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/getdevice","routeSlug":"/openapi/okta-management/management/tags/device/other/getdevice","metadata":{"seo":{"title":"Retrieve a device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices/{deviceId}"},{"label":"Delete a device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/deletedevice","routeSlug":"/openapi/okta-management/management/tags/device/other/deletedevice","metadata":{"seo":{"title":"Delete a device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.manage
"}},"httpPath":"/api/v1/devices/{deviceId}"},{"label":"List all enrollment authenticators for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/listdeviceenrollmentauthenticators","routeSlug":"/openapi/okta-management/management/tags/device/other/listdeviceenrollmentauthenticators","metadata":{"seo":{"title":"List all enrollment authenticators for a device","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices/{deviceId}/authenticator-enrollments"},{"label":"Activate a device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/activatedevice","routeSlug":"/openapi/okta-management/management/tags/device/other/activatedevice","metadata":{"seo":{"title":"Activate a device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.manage
"}},"httpPath":"/api/v1/devices/{deviceId}/lifecycle/activate"},{"label":"Deactivate a device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/deactivatedevice","routeSlug":"/openapi/okta-management/management/tags/device/other/deactivatedevice","metadata":{"seo":{"title":"Deactivate a device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.manage
"}},"httpPath":"/api/v1/devices/{deviceId}/lifecycle/deactivate"},{"label":"Suspend a Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/suspenddevice","routeSlug":"/openapi/okta-management/management/tags/device/other/suspenddevice","metadata":{"seo":{"title":"Suspend a Device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.manage
"}},"httpPath":"/api/v1/devices/{deviceId}/lifecycle/suspend"},{"label":"Unsuspend a Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/unsuspenddevice","routeSlug":"/openapi/okta-management/management/tags/device/other/unsuspenddevice","metadata":{"seo":{"title":"Unsuspend a Device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.manage
"}},"httpPath":"/api/v1/devices/{deviceId}/lifecycle/unsuspend"},{"label":"List all OS accounts for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/listdeviceosaccounts","routeSlug":"/openapi/okta-management/management/tags/device/other/listdeviceosaccounts","metadata":{"seo":{"title":"List all OS accounts for a device","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices/{deviceId}/os-accounts"},{"label":"Retrieve an OS account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/getdeviceosaccount","routeSlug":"/openapi/okta-management/management/tags/device/other/getdeviceosaccount","metadata":{"seo":{"title":"Retrieve an OS account","description":"
Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices/{deviceId}/os-accounts/{osAccountId}"},{"label":"List all users for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/device/other/listdeviceusers","routeSlug":"/openapi/okta-management/management/tags/device/other/listdeviceusers","metadata":{"seo":{"title":"List all users for a device","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devices.read
"}},"httpPath":"/api/v1/devices/{deviceId}/users"}],"metadata":{"type":"openapi","title":"Devices","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://okta-developer.pixtulate.com/docs/reference/core-okta-api/#authentication)\n* Bearer: [OAuth2.0 and OpenID Connect](https://okta-developer.pixtulate.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://okta-help.pixtulate.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://okta-help.pixtulate.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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=csh-device-registration) and [Login Using Okta Verify](https://okta-help.pixtulate.com/okta_help.htm?type=eu&id=ext-ov-user-overview)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/deviceassurance.yaml","link":"/openapi/okta-management/management/tags/deviceassurance","routeSlug":"/openapi/okta-management/management/tags/deviceassurance","label":"Device Assurance Policies","items":[{"type":"group","label":"Device Assurance Policies","link":"/openapi/okta-management/management/tags/deviceassurance/deviceassurance","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/deviceassurance","items":[]},{"label":"List all device assurance policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceassurance/other/listdeviceassurancepolicies","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/other/listdeviceassurancepolicies","metadata":{"seo":{"title":"List all device assurance policies","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.deviceAssurance.read
"}},"httpPath":"/api/v1/device-assurances"},{"label":"Create a device assurance policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceassurance/other/createdeviceassurancepolicy","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/other/createdeviceassurancepolicy","metadata":{"seo":{"title":"Create a device assurance policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.deviceAssurance.manage
"}},"httpPath":"/api/v1/device-assurances"},{"label":"Retrieve a device assurance policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceassurance/other/getdeviceassurancepolicy","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/other/getdeviceassurancepolicy","metadata":{"seo":{"title":"Retrieve a device assurance policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.deviceAssurance.read
"}},"httpPath":"/api/v1/device-assurances/{deviceAssuranceId}"},{"label":"Replace a device assurance policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceassurance/other/replacedeviceassurancepolicy","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/other/replacedeviceassurancepolicy","metadata":{"seo":{"title":"Replace a device assurance policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.deviceAssurance.manage
"}},"httpPath":"/api/v1/device-assurances/{deviceAssuranceId}"},{"label":"Delete a device assurance policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceassurance/other/deletedeviceassurancepolicy","routeSlug":"/openapi/okta-management/management/tags/deviceassurance/other/deletedeviceassurancepolicy","metadata":{"seo":{"title":"Delete a device assurance policy","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.deviceAssurance.manage
"}},"httpPath":"/api/v1/device-assurances/{deviceAssuranceId}"}],"metadata":{"type":"openapi","title":"Device Assurance Policies","description":"The Device Assurance Policies API provides operations to manage device assurance policies in your organization."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/deviceintegrations.yaml","link":"/openapi/okta-management/management/tags/deviceintegrations","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations","label":"Device Integrations","items":[{"type":"group","label":"Device Integrations","link":"/openapi/okta-management/management/tags/deviceintegrations/deviceintegrations","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations/deviceintegrations","items":[]},{"label":"List all device integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceintegrations/other/listdeviceintegrations","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations/other/listdeviceintegrations","metadata":{"seo":{"title":"List all device integrations","description":"
"}},"httpPath":"/api/v1/device-integrations"},{"label":"Retrieve a device integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceintegrations/other/getdeviceintegration","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations/other/getdeviceintegration","metadata":{"seo":{"title":"Retrieve a device integration","description":"
"}},"httpPath":"/api/v1/device-integrations/{deviceIntegrationId}"},{"label":"Activate a device integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceintegrations/other/activatedeviceintegration","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations/other/activatedeviceintegration","metadata":{"seo":{"title":"Activate a device integration","description":"
"}},"httpPath":"/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/activate"},{"label":"Deactivate a device integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceintegrations/other/deactivatedeviceintegration","routeSlug":"/openapi/okta-management/management/tags/deviceintegrations/other/deactivatedeviceintegration","metadata":{"seo":{"title":"Deactivate a device integration","description":"
"}},"httpPath":"/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Device Integrations","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"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/deviceposturecheck.yaml","link":"/openapi/okta-management/management/tags/deviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck","label":"Device Posture Checks","items":[{"type":"group","label":"Device Posture Checks","link":"/openapi/okta-management/management/tags/deviceposturecheck/deviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/deviceposturecheck","items":[]},{"label":"List all device posture checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/listdeviceposturechecks","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/listdeviceposturechecks","metadata":{"seo":{"title":"List all device posture checks","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devicePostureChecks.read
"}},"httpPath":"/api/v1/device-posture-checks"},{"label":"Create a device posture check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/createdeviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/createdeviceposturecheck","metadata":{"seo":{"title":"Create a device posture check","description":"
"}},"httpPath":"/api/v1/device-posture-checks"},{"label":"List all default device posture checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/listdefaultdeviceposturechecks","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/listdefaultdeviceposturechecks","metadata":{"seo":{"title":"List all default device posture checks","description":"
"}},"httpPath":"/api/v1/device-posture-checks/default"},{"label":"Retrieve a device posture check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/getdeviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/getdeviceposturecheck","metadata":{"seo":{"title":"Retrieve a device posture check","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devicePostureChecks.read
"}},"httpPath":"/api/v1/device-posture-checks/{postureCheckId}"},{"label":"Replace a device posture check","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/replacedeviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/replacedeviceposturecheck","metadata":{"seo":{"title":"Replace a device posture check","description":"
"}},"httpPath":"/api/v1/device-posture-checks/{postureCheckId}"},{"label":"Delete a device posture check","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/deviceposturecheck/other/deletedeviceposturecheck","routeSlug":"/openapi/okta-management/management/tags/deviceposturecheck/other/deletedeviceposturecheck","metadata":{"seo":{"title":"Delete a device posture check","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.devicePostureChecks.manage
"}},"httpPath":"/api/v1/device-posture-checks/{postureCheckId}"}],"metadata":{"type":"openapi","title":"Device Posture Checks","description":"The Device Posture Checks API provides operations to manage custom device posture checks for use in device assurance policies in your organization."}}]},{"type":"group","label":"External Identity Sources","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/agentpools.yaml","link":"/openapi/okta-management/management/tags/agentpools","routeSlug":"/openapi/okta-management/management/tags/agentpools","label":"Directory Agent Pools","items":[{"type":"group","label":"Directory Agent Pools","link":"/openapi/okta-management/management/tags/agentpools/agentpools","routeSlug":"/openapi/okta-management/management/tags/agentpools/agentpools","items":[]},{"label":"List all agent pools","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/listagentpools","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/listagentpools","metadata":{"seo":{"title":"List all agent pools","description":"
"}},"httpPath":"/api/v1/agentPools"},{"label":"List all agent pool updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/listagentpoolsupdates","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/listagentpoolsupdates","metadata":{"seo":{"title":"List all agent pool updates","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates"},{"label":"Create an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/createagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/createagentpoolsupdate","metadata":{"seo":{"title":"Create an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates"},{"label":"Retrieve an agent pool update's settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/getagentpoolsupdatesettings","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/getagentpoolsupdatesettings","metadata":{"seo":{"title":"Retrieve an agent pool update's settings","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/settings"},{"label":"Update an agent pool update settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/updateagentpoolsupdatesettings","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/updateagentpoolsupdatesettings","metadata":{"seo":{"title":"Update an agent pool update settings","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/settings"},{"label":"Retrieve an agent pool update by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/getagentpoolsupdateinstance","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/getagentpoolsupdateinstance","metadata":{"seo":{"title":"Retrieve an agent pool update by ID","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}"},{"label":"Update an agent pool update by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/updateagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/updateagentpoolsupdate","metadata":{"seo":{"title":"Update an agent pool update by ID","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}"},{"label":"Delete an agent pool update","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/deleteagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/deleteagentpoolsupdate","metadata":{"seo":{"title":"Delete an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}"},{"label":"Activate an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/activateagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/activateagentpoolsupdate","metadata":{"seo":{"title":"Activate an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/activate"},{"label":"Deactivate an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/deactivateagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/deactivateagentpoolsupdate","metadata":{"seo":{"title":"Deactivate an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/deactivate"},{"label":"Pause an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/pauseagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/pauseagentpoolsupdate","metadata":{"seo":{"title":"Pause an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/pause"},{"label":"Resume an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/resumeagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/resumeagentpoolsupdate","metadata":{"seo":{"title":"Resume an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/resume"},{"label":"Retry an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/retryagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/retryagentpoolsupdate","metadata":{"seo":{"title":"Retry an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/retry"},{"label":"Stop an agent pool update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/agentpools/other/stopagentpoolsupdate","routeSlug":"/openapi/okta-management/management/tags/agentpools/other/stopagentpoolsupdate","metadata":{"seo":{"title":"Stop an agent pool update","description":"
"}},"httpPath":"/api/v1/agentPools/{poolId}/updates/{updateId}/stop"}],"metadata":{"type":"openapi","title":"Directory Agent Pools","description":"The Agent Pools API provides operations to manage the update settings of the directory agents for your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/directoriesintegration.yaml","link":"/openapi/okta-management/management/tags/directoriesintegration","routeSlug":"/openapi/okta-management/management/tags/directoriesintegration","label":"Directories Integration","items":[{"type":"group","label":"Directories Integration","link":"/openapi/okta-management/management/tags/directoriesintegration/directoriesintegration","routeSlug":"/openapi/okta-management/management/tags/directoriesintegration/directoriesintegration","items":[]},{"label":"Update an external directory group membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/directoriesintegration/other/updategroupmembership","routeSlug":"/openapi/okta-management/management/tags/directoriesintegration/other/updategroupmembership","metadata":{"seo":{"title":"Update an external directory group membership","description":"
"}},"httpPath":"/api/v1/directories/{appInstanceId}/groups/modify"},{"label":"Submit a query for AD Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/directoriesintegration/other/submitgroupattributequery","routeSlug":"/openapi/okta-management/management/tags/directoriesintegration/other/submitgroupattributequery","metadata":{"seo":{"title":"Submit a query for AD Group","description":"
"}},"httpPath":"/api/v1/directories/{appInstanceId}/groups/{groupId}/query"},{"label":"Retrieve the results of an AD group query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/directoriesintegration/other/getgroupattributequeryresult","routeSlug":"/openapi/okta-management/management/tags/directoriesintegration/other/getgroupattributequeryresult","metadata":{"seo":{"title":"Retrieve the results of an AD group query","description":"
"}},"httpPath":"/api/v1/directories/{appInstanceId}/groups/{groupId}/query/{resultId}"}],"metadata":{"type":"openapi","title":"Directories Integration","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/identityprovider.yaml","link":"/openapi/okta-management/management/tags/identityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider","label":"Identity Providers","items":[{"type":"group","label":"Identity Providers","link":"/openapi/okta-management/management/tags/identityprovider/identityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/identityprovider","items":[]},{"label":"List all IdPs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/listidentityproviders","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/listidentityproviders","metadata":{"seo":{"title":"List all IdPs","description":"
"}},"httpPath":"/api/v1/idps"},{"label":"Create an IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/createidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/createidentityprovider","metadata":{"seo":{"title":"Create an IdP","description":"
"}},"httpPath":"/api/v1/idps"},{"label":"Retrieve an IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/getidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/getidentityprovider","metadata":{"seo":{"title":"Retrieve an IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}"},{"label":"Replace an IdP","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/replaceidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/replaceidentityprovider","metadata":{"seo":{"title":"Replace an IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}"},{"label":"Delete an IdP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/deleteidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/deleteidentityprovider","metadata":{"seo":{"title":"Delete an IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}"},{"label":"Activate an IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/activateidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/activateidentityprovider","metadata":{"seo":{"title":"Activate an IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/lifecycle/activate"},{"label":"Deactivate an IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovider/other/deactivateidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovider/other/deactivateidentityprovider","metadata":{"seo":{"title":"Deactivate an IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Identity Providers","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/identityproviderkeys.yaml","link":"/openapi/okta-management/management/tags/identityproviderkeys","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys","label":"Identity Provider Keys","items":[{"type":"group","label":"Identity Provider Keys","link":"/openapi/okta-management/management/tags/identityproviderkeys/identityproviderkeys","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/identityproviderkeys","items":[]},{"label":"List all IdP key credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderkeys/other/listidentityproviderkeys","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/other/listidentityproviderkeys","metadata":{"seo":{"title":"List all IdP key credentials","description":"
"}},"httpPath":"/api/v1/idps/credentials/keys"},{"label":"Create an IdP key credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderkeys/other/createidentityproviderkey","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/other/createidentityproviderkey","metadata":{"seo":{"title":"Create an IdP key credential","description":"
"}},"httpPath":"/api/v1/idps/credentials/keys"},{"label":"Retrieve an IdP key credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderkeys/other/getidentityproviderkey","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/other/getidentityproviderkey","metadata":{"seo":{"title":"Retrieve an IdP key credential","description":"
"}},"httpPath":"/api/v1/idps/credentials/keys/{kid}"},{"label":"Replace an IdP key credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderkeys/other/replaceidentityproviderkey","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/other/replaceidentityproviderkey","metadata":{"seo":{"title":"Replace an IdP key credential","description":"
"}},"httpPath":"/api/v1/idps/credentials/keys/{kid}"},{"label":"Delete an IdP key credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderkeys/other/deleteidentityproviderkey","routeSlug":"/openapi/okta-management/management/tags/identityproviderkeys/other/deleteidentityproviderkey","metadata":{"seo":{"title":"Delete an IdP key credential","description":"
"}},"httpPath":"/api/v1/idps/credentials/keys/{kid}"}],"metadata":{"type":"openapi","title":"Identity Provider Keys","description":"The Identity Provider Keys API provides operations to manage key credentials for identity providers (IdPs)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/identityprovidersigningkeys.yaml","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys","label":"Identity Provider Signing Keys","items":[{"type":"group","label":"Identity Provider Signing Keys","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/identityprovidersigningkeys","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/identityprovidersigningkeys","items":[]},{"label":"List all certificate signing requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listcsrsforidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listcsrsforidentityprovider","metadata":{"seo":{"title":"List all certificate signing requests","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/csrs"},{"label":"Generate a certificate signing request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/generatecsrforidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/generatecsrforidentityprovider","metadata":{"seo":{"title":"Generate a certificate signing request","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/csrs"},{"label":"Retrieve a certificate signing request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/getcsrforidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/getcsrforidentityprovider","metadata":{"seo":{"title":"Retrieve a certificate signing request","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}"},{"label":"Revoke a certificate signing request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/revokecsrforidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/revokecsrforidentityprovider","metadata":{"seo":{"title":"Revoke a certificate signing request","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}"},{"label":"Publish a certificate signing request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/publishcsrforidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/publishcsrforidentityprovider","metadata":{"seo":{"title":"Publish a certificate signing request","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish"},{"label":"List all signing key credentials for IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listidentityprovidersigningkeys","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listidentityprovidersigningkeys","metadata":{"seo":{"title":"List all signing key credentials for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/keys"},{"label":"List the active signing key credential for IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listactiveidentityprovidersigningkey","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/listactiveidentityprovidersigningkey","metadata":{"seo":{"title":"List the active signing key credential for IdP","description":"
CORS
OAuth 2.0 scope:
  • okta.idps.read
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/keys/active"},{"label":"Generate a new signing key credential for IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/generateidentityprovidersigningkey","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/generateidentityprovidersigningkey","metadata":{"seo":{"title":"Generate a new signing key credential for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/keys/generate"},{"label":"Retrieve a signing key credential for IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/getidentityprovidersigningkey","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/getidentityprovidersigningkey","metadata":{"seo":{"title":"Retrieve a signing key credential for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/keys/{kid}"},{"label":"Clone a signing key credential for IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/cloneidentityproviderkey","routeSlug":"/openapi/okta-management/management/tags/identityprovidersigningkeys/other/cloneidentityproviderkey","metadata":{"seo":{"title":"Clone a signing key credential for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/credentials/keys/{kid}/clone"}],"metadata":{"type":"openapi","title":"Identity Provider Signing 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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/identityproviderusers.yaml","link":"/openapi/okta-management/management/tags/identityproviderusers","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers","label":"Identity Provider Users","items":[{"type":"group","label":"Identity Provider Users","link":"/openapi/okta-management/management/tags/identityproviderusers/identityproviderusers","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/identityproviderusers","items":[]},{"label":"List all users for IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/listidentityproviderapplicationusers","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/listidentityproviderapplicationusers","metadata":{"seo":{"title":"List all users for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/users"},{"label":"Retrieve a user for IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/getidentityproviderapplicationuser","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/getidentityproviderapplicationuser","metadata":{"seo":{"title":"Retrieve a user for IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/users/{userId}"},{"label":"Link a user to IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/linkusertoidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/linkusertoidentityprovider","metadata":{"seo":{"title":"Link a user to IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/users/{userId}"},{"label":"Unlink a user from IdP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/unlinkuserfromidentityprovider","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/unlinkuserfromidentityprovider","metadata":{"seo":{"title":"Unlink a user from IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/users/{userId}"},{"label":"List all tokens from OIDC IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/listsocialauthtokens","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/listsocialauthtokens","metadata":{"seo":{"title":"List all tokens from OIDC IdP","description":"
"}},"httpPath":"/api/v1/idps/{idpId}/users/{userId}/credentials/tokens"},{"label":"List all IdPs for user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identityproviderusers/other/listuseridentityproviders","routeSlug":"/openapi/okta-management/management/tags/identityproviderusers/other/listuseridentityproviders","metadata":{"seo":{"title":"List all IdPs for user","description":"
"}},"httpPath":"/api/v1/users/{id}/idps"}],"metadata":{"type":"openapi","title":"Identity Provider Users","description":"The Identity Provider Users API provides operations to manage identity provider (IdP) users."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/identitysource.yaml","link":"/openapi/okta-management/management/tags/identitysource","routeSlug":"/openapi/okta-management/management/tags/identitysource","label":"Identity Sources","items":[{"type":"group","label":"Identity Sources","link":"/openapi/okta-management/management/tags/identitysource/identitysource","routeSlug":"/openapi/okta-management/management/tags/identitysource/identitysource","items":[]},{"label":"Create an identity source group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcegroups","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcegroups","metadata":{"seo":{"title":"Create an identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups"},{"label":"Retrieve an identity source group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcegroup","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcegroup","metadata":{"seo":{"title":"Retrieve an identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}"},{"label":"Update an identity source group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/updateidentitysourcegroups","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/updateidentitysourcegroups","metadata":{"seo":{"title":"Update an identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}"},{"label":"Delete an identity source group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcegroup","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcegroup","metadata":{"seo":{"title":"Delete an identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}"},{"label":"Retrieve the memberships for the given identity source group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcegroupmemberships","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcegroupmemberships","metadata":{"seo":{"title":"Retrieve the memberships for the given identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership"},{"label":"Create the memberships for the given identity source group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcegroupsmemberships","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcegroupsmemberships","metadata":{"seo":{"title":"Create the memberships for the given identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership"},{"label":"Delete the memberships for the specified identity source group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcegroupmemberships","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcegroupmemberships","metadata":{"seo":{"title":"Delete the memberships for the specified identity source group","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership/{memberExternalId}"},{"label":"List all identity source sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/listidentitysourcesessions","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/listidentitysourcesessions","metadata":{"seo":{"title":"List all identity source sessions","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions"},{"label":"Create an identity source session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcesession","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourcesession","metadata":{"seo":{"title":"Create an identity source session","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions"},{"label":"Retrieve an identity source session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcesession","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourcesession","metadata":{"seo":{"title":"Retrieve an identity source session","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}"},{"label":"Delete an identity source session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcesession","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourcesession","metadata":{"seo":{"title":"Delete an identity source session","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}"},{"label":"Upload the data to be deleted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedatafordelete","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedatafordelete","metadata":{"seo":{"title":"Upload the data to be deleted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete"},{"label":"Upload the device external IDs to be deleted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedevicesfordelete","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedevicesfordelete","metadata":{"seo":{"title":"Upload the device external IDs to be deleted in Okta","description":"
Early Access
OAuth 2.0 scope:
  • okta.identitySources.manage
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-devices-delete"},{"label":"Upload the device profiles to be upserted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedevicesforupsert","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedevicesforupsert","metadata":{"seo":{"title":"Upload the device profiles to be upserted in Okta","description":"
Early Access
OAuth 2.0 scope:
  • okta.identitySources.manage
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-devices-upsert"},{"label":"Upload the group memberships to be deleted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupmembershipsfordelete","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupmembershipsfordelete","metadata":{"seo":{"title":"Upload the group memberships to be deleted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-delete"},{"label":"Upload the group memberships to be upserted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupmembershipsforupsert","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupmembershipsforupsert","metadata":{"seo":{"title":"Upload the group memberships to be upserted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-upsert"},{"label":"Upload the group external IDs to be deleted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupsdatafordelete","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupsdatafordelete","metadata":{"seo":{"title":"Upload the group external IDs to be deleted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-delete"},{"label":"Upload the group profiles without memberships to be upserted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupsforupsert","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcegroupsforupsert","metadata":{"seo":{"title":"Upload the group profiles without memberships to be upserted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-upsert"},{"label":"Upload the data to be upserted in Okta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedataforupsert","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/uploadidentitysourcedataforupsert","metadata":{"seo":{"title":"Upload the data to be upserted in Okta","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert"},{"label":"Start the import from the identity source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/startimportfromidentitysource","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/startimportfromidentitysource","metadata":{"seo":{"title":"Start the import from the identity source","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import"},{"label":"Create an identity source user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourceuser","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/createidentitysourceuser","metadata":{"seo":{"title":"Create an identity source user","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/users"},{"label":"Retrieve an identity source user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourceuser","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/getidentitysourceuser","metadata":{"seo":{"title":"Retrieve an identity source user","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/users/{externalId}"},{"label":"Replace an existing identity source user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/replaceexistingidentitysourceuser","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/replaceexistingidentitysourceuser","metadata":{"seo":{"title":"Replace an existing identity source user","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/users/{externalId}"},{"label":"Update an identity source user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/updateidentitysourceusers","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/updateidentitysourceusers","metadata":{"seo":{"title":"Update an identity source user","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/users/{externalId}"},{"label":"Delete an identity source user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourceuser","routeSlug":"/openapi/okta-management/management/tags/identitysource/other/deleteidentitysourceuser","metadata":{"seo":{"title":"Delete an identity source user","description":"
"}},"httpPath":"/api/v1/identity-sources/{identitySourceId}/users/{externalId}"}],"metadata":{"type":"openapi","title":"Identity Sources","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://okta-developer.pixtulate.com/docs/guides/anything-as-a-source/)."}}]},{"type":"group","label":"Groups","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/group.yaml","link":"/openapi/okta-management/management/tags/group","routeSlug":"/openapi/okta-management/management/tags/group","label":"Groups","items":[{"type":"group","label":"Groups","link":"/openapi/okta-management/management/tags/group/group","routeSlug":"/openapi/okta-management/management/tags/group/group","items":[]},{"label":"List all groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/listgroups","routeSlug":"/openapi/okta-management/management/tags/group/other/listgroups","metadata":{"seo":{"title":"List all groups","description":"
"}},"httpPath":"/api/v1/groups"},{"label":"Add a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/addgroup","routeSlug":"/openapi/okta-management/management/tags/group/other/addgroup","metadata":{"seo":{"title":"Add a group","description":"
"}},"httpPath":"/api/v1/groups"},{"label":"Retrieve a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/getgroup","routeSlug":"/openapi/okta-management/management/tags/group/other/getgroup","metadata":{"seo":{"title":"Retrieve a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}"},{"label":"Replace a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/replacegroup","routeSlug":"/openapi/okta-management/management/tags/group/other/replacegroup","metadata":{"seo":{"title":"Replace a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}"},{"label":"Delete a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/deletegroup","routeSlug":"/openapi/okta-management/management/tags/group/other/deletegroup","metadata":{"seo":{"title":"Delete a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}"},{"label":"List all assigned apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/listassignedapplicationsforgroup","routeSlug":"/openapi/okta-management/management/tags/group/other/listassignedapplicationsforgroup","metadata":{"seo":{"title":"List all assigned apps","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/apps"},{"label":"List all member users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/listgroupusers","routeSlug":"/openapi/okta-management/management/tags/group/other/listgroupusers","metadata":{"seo":{"title":"List all member users","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/users"},{"label":"Assign a user to a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/assignusertogroup","routeSlug":"/openapi/okta-management/management/tags/group/other/assignusertogroup","metadata":{"seo":{"title":"Assign a user to a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/users/{userId}"},{"label":"Unassign a user from a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/unassignuserfromgroup","routeSlug":"/openapi/okta-management/management/tags/group/other/unassignuserfromgroup","metadata":{"seo":{"title":"Unassign a user from a group","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/users/{userId}"},{"label":"List all group rules for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/group/other/listgrouprulesforuseringroup","routeSlug":"/openapi/okta-management/management/tags/group/other/listgrouprulesforuseringroup","metadata":{"seo":{"title":"List all group rules for a user","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/users/{userId}/group-rules"}],"metadata":{"type":"openapi","title":"Groups","description":"The Groups API provides operations to manage Okta groups and their user members in your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/groupowner.yaml","link":"/openapi/okta-management/management/tags/groupowner","routeSlug":"/openapi/okta-management/management/tags/groupowner","label":"Group Owners","items":[{"type":"group","label":"Group Owners","link":"/openapi/okta-management/management/tags/groupowner/groupowner","routeSlug":"/openapi/okta-management/management/tags/groupowner/groupowner","items":[]},{"label":"List all group owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/groupowner/other/listgroupowners","routeSlug":"/openapi/okta-management/management/tags/groupowner/other/listgroupowners","metadata":{"seo":{"title":"List all group owners","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/owners"},{"label":"Assign a group owner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/groupowner/other/assigngroupowner","routeSlug":"/openapi/okta-management/management/tags/groupowner/other/assigngroupowner","metadata":{"seo":{"title":"Assign a group owner","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/owners"},{"label":"Delete a group owner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/groupowner/other/deletegroupowner","routeSlug":"/openapi/okta-management/management/tags/groupowner/other/deletegroupowner","metadata":{"seo":{"title":"Delete a group owner","description":"
"}},"httpPath":"/api/v1/groups/{groupId}/owners/{ownerId}"}],"metadata":{"type":"openapi","title":"Group Owners","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/grouprule.yaml","link":"/openapi/okta-management/management/tags/grouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule","label":"Group Rules","items":[{"type":"group","label":"Group Rules","link":"/openapi/okta-management/management/tags/grouprule/grouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/grouprule","items":[]},{"label":"List all group rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/listgrouprules","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/listgrouprules","metadata":{"seo":{"title":"List all group rules","description":"
"}},"httpPath":"/api/v1/groups/rules"},{"label":"Create a group rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/creategrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/creategrouprule","metadata":{"seo":{"title":"Create a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules"},{"label":"Retrieve a group rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/getgrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/getgrouprule","metadata":{"seo":{"title":"Retrieve a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules/{groupRuleId}"},{"label":"Replace a group rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/replacegrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/replacegrouprule","metadata":{"seo":{"title":"Replace a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules/{groupRuleId}"},{"label":"Delete a group rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/deletegrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/deletegrouprule","metadata":{"seo":{"title":"Delete a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules/{groupRuleId}"},{"label":"Activate a group rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/activategrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/activategrouprule","metadata":{"seo":{"title":"Activate a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules/{groupRuleId}/lifecycle/activate"},{"label":"Deactivate a group rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/grouprule/other/deactivategrouprule","routeSlug":"/openapi/okta-management/management/tags/grouprule/other/deactivategrouprule","metadata":{"seo":{"title":"Deactivate a group rule","description":"
"}},"httpPath":"/api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Group Rules","description":"The Group Rules API provides operations to manage rules for Okta groups in your org."}}]},{"type":"group","label":"Hooks","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/eventhook.yaml","link":"/openapi/okta-management/management/tags/eventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook","label":"Event Hooks","items":[{"type":"group","label":"Event Hooks","link":"/openapi/okta-management/management/tags/eventhook/eventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/eventhook","items":[]},{"label":"List all event hooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/listeventhooks","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/listeventhooks","metadata":{"seo":{"title":"List all event hooks","description":"
"}},"httpPath":"/api/v1/eventHooks"},{"label":"Create an event hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/createeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/createeventhook","metadata":{"seo":{"title":"Create an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks"},{"label":"Retrieve an event hook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/geteventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/geteventhook","metadata":{"seo":{"title":"Retrieve an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}"},{"label":"Replace an event hook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/replaceeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/replaceeventhook","metadata":{"seo":{"title":"Replace an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}"},{"label":"Delete an event hook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/deleteeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/deleteeventhook","metadata":{"seo":{"title":"Delete an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}"},{"label":"Activate an event hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/activateeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/activateeventhook","metadata":{"seo":{"title":"Activate an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}/lifecycle/activate"},{"label":"Deactivate an event hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/deactivateeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/deactivateeventhook","metadata":{"seo":{"title":"Deactivate an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}/lifecycle/deactivate"},{"label":"Verify an event hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/eventhook/other/verifyeventhook","routeSlug":"/openapi/okta-management/management/tags/eventhook/other/verifyeventhook","metadata":{"seo":{"title":"Verify an event hook","description":"
"}},"httpPath":"/api/v1/eventHooks/{eventHookId}/lifecycle/verify"}],"metadata":{"type":"openapi","title":"Event Hooks","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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/reference/api/event-types/#catalog) catalog and search with the parameter `event-hook-eligible`."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/hookkey.yaml","link":"/openapi/okta-management/management/tags/hookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey","label":"Hook Keys","items":[{"type":"group","label":"Hook Keys","link":"/openapi/okta-management/management/tags/hookkey/hookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey/hookkey","items":[]},{"label":"List all keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/listhookkeys","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/listhookkeys","metadata":{"seo":{"title":"List all keys","description":"
"}},"httpPath":"/api/v1/hook-keys"},{"label":"Create a key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/createhookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/createhookkey","metadata":{"seo":{"title":"Create a key","description":"
"}},"httpPath":"/api/v1/hook-keys"},{"label":"Retrieve a public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/getpublickey","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/getpublickey","metadata":{"seo":{"title":"Retrieve a public key","description":"
"}},"httpPath":"/api/v1/hook-keys/public/{keyId}"},{"label":"Retrieve a key by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/gethookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/gethookkey","metadata":{"seo":{"title":"Retrieve a key by ID","description":"
"}},"httpPath":"/api/v1/hook-keys/{id}"},{"label":"Replace a key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/replacehookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/replacehookkey","metadata":{"seo":{"title":"Replace a key","description":"
"}},"httpPath":"/api/v1/hook-keys/{id}"},{"label":"Delete a key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/hookkey/other/deletehookkey","routeSlug":"/openapi/okta-management/management/tags/hookkey/other/deletehookkey","metadata":{"seo":{"title":"Delete a key","description":"
"}},"httpPath":"/api/v1/hook-keys/{id}"}],"metadata":{"type":"openapi","title":"Hook Keys","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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/inlinehook.yaml","link":"/openapi/okta-management/management/tags/inlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook","label":"Inline Hooks","items":[{"type":"group","label":"Inline Hooks","link":"/openapi/okta-management/management/tags/inlinehook/inlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/inlinehook","items":[]},{"label":"List all inline hooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/listinlinehooks","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/listinlinehooks","metadata":{"seo":{"title":"List all inline hooks","description":"
"}},"httpPath":"/api/v1/inlineHooks"},{"label":"Create an inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/createinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/createinlinehook","metadata":{"seo":{"title":"Create an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks"},{"label":"Retrieve an inline hook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/getinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/getinlinehook","metadata":{"seo":{"title":"Retrieve an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}"},{"label":"Update an inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/updateinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/updateinlinehook","metadata":{"seo":{"title":"Update an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}"},{"label":"Replace an inline hook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/replaceinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/replaceinlinehook","metadata":{"seo":{"title":"Replace an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}"},{"label":"Delete an inline hook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/deleteinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/deleteinlinehook","metadata":{"seo":{"title":"Delete an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}"},{"label":"Execute an inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/executeinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/executeinlinehook","metadata":{"seo":{"title":"Execute an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}/execute"},{"label":"Activate an inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/activateinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/activateinlinehook","metadata":{"seo":{"title":"Activate an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}/lifecycle/activate"},{"label":"Deactivate an inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/other/deactivateinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/other/deactivateinlinehook","metadata":{"seo":{"title":"Deactivate an inline hook","description":"
"}},"httpPath":"/api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate"},{"type":"group","label":"webhooks","link":"/openapi/okta-management/management/tags/inlinehook/webhooks","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks","items":[{"label":"Create a telephony inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/createtelephonyinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/createtelephonyinlinehook","metadata":{"seo":{"title":"Create a telephony inline hook","description":"
"}},"httpPath":"CreateTelephonyInlineHook"},{"label":"Create a password import inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/createpasswordimportinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/createpasswordimportinlinehook","metadata":{"seo":{"title":"Create a password import inline hook","description":"
"}},"httpPath":"CreatePasswordImportInlineHook"},{"label":"Create a registration inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/create-registration-hook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/create-registration-hook","metadata":{"seo":{"title":"Create a registration inline hook","description":"
"}},"httpPath":"create-registration-hook"},{"label":"Create a user import inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/createuserimportinlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/createuserimportinlinehook","metadata":{"seo":{"title":"Create a user import inline hook","description":"
"}},"httpPath":"CreateUserImportInlineHook"},{"label":"Create a SAML assertion inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/createsamlassertioninlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/createsamlassertioninlinehook","metadata":{"seo":{"title":"Create a SAML assertion inline hook","description":"
"}},"httpPath":"create-saml-hook"},{"label":"Create a token inline hook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/okta-management/management/tags/inlinehook/webhooks/createtokeninlinehook","routeSlug":"/openapi/okta-management/management/tags/inlinehook/webhooks/createtokeninlinehook","metadata":{"seo":{"title":"Create a token inline hook","description":"
"}},"httpPath":"create-token-hook"}]}],"metadata":{"type":"openapi","title":"Inline Hooks","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://okta-developer.pixtulate.com/docs/concepts/inline-hooks/). The following documentation is only for the management API, which provides a CRUD interface for registering inline hooks."}}]},{"type":"group","label":"Org Management","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/oktapersonalsettings.yaml","link":"/openapi/okta-management/management/tags/oktapersonalsettings","routeSlug":"/openapi/okta-management/management/tags/oktapersonalsettings","label":"Okta Personal Settings","items":[{"type":"group","label":"Okta Personal Settings","link":"/openapi/okta-management/management/tags/oktapersonalsettings/oktapersonalsettings","routeSlug":"/openapi/okta-management/management/tags/oktapersonalsettings/oktapersonalsettings","items":[]},{"label":"Replace the Okta Personal admin settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktapersonalsettings/other/replaceoktapersonaladminsettings","routeSlug":"/openapi/okta-management/management/tags/oktapersonalsettings/other/replaceoktapersonaladminsettings","metadata":{"seo":{"title":"Replace the Okta Personal admin settings","description":"
"}},"httpPath":"/okta-personal-settings/api/v1/edit-feature"},{"label":"List all blocked email domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktapersonalsettings/other/listpersonalappsexportblocklist","routeSlug":"/openapi/okta-management/management/tags/oktapersonalsettings/other/listpersonalappsexportblocklist","metadata":{"seo":{"title":"List all blocked email domains","description":"
"}},"httpPath":"/okta-personal-settings/api/v1/export-blocklists"},{"label":"Replace the blocked email domains","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktapersonalsettings/other/replaceblockedemaildomains","routeSlug":"/openapi/okta-management/management/tags/oktapersonalsettings/other/replaceblockedemaildomains","metadata":{"seo":{"title":"Replace the blocked email domains","description":"
"}},"httpPath":"/okta-personal-settings/api/v1/export-blocklists"}],"metadata":{"type":"openapi","title":"Okta Personal Settings","description":"The Okta Personal Settings API provides operations to manage the [Okta Personal](https://okta-www.pixtulate.com/products/okta-personal/workforce) settings of your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingadmin.yaml","link":"/openapi/okta-management/management/tags/orgsettingadmin","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin","label":"Org Admin Settings","items":[{"type":"group","label":"Org Admin Settings","link":"/openapi/okta-management/management/tags/orgsettingadmin/orgsettingadmin","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/orgsettingadmin","items":[]},{"label":"Retrieve the org third-party admin setting","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/getthirdpartyadminsetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/getthirdpartyadminsetting","metadata":{"seo":{"title":"Retrieve the org third-party admin setting","description":"
"}},"httpPath":"/api/v1/org/orgSettings/thirdPartyAdminSetting"},{"label":"Update the org third-party admin setting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/updatethirdpartyadminsetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/updatethirdpartyadminsetting","metadata":{"seo":{"title":"Update the org third-party admin setting","description":"
"}},"httpPath":"/api/v1/org/orgSettings/thirdPartyAdminSetting"},{"label":"Retrieve the Okta Admin Console assignment setting","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/getautoassignadminappsetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/getautoassignadminappsetting","metadata":{"seo":{"title":"Retrieve the Okta Admin Console assignment setting","description":"
"}},"httpPath":"/api/v1/org/settings/autoAssignAdminAppSetting"},{"label":"Update the Okta Admin Console assignment setting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/updateautoassignadminappsetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/updateautoassignadminappsetting","metadata":{"seo":{"title":"Update the Okta Admin Console assignment setting","description":"
"}},"httpPath":"/api/v1/org/settings/autoAssignAdminAppSetting"},{"label":"Retrieve the default public client app role setting","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/getclientprivilegessetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/getclientprivilegessetting","metadata":{"seo":{"title":"Retrieve the default public client app role setting","description":"
"}},"httpPath":"/api/v1/org/settings/clientPrivilegesSetting"},{"label":"Assign the default public client app role setting","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingadmin/other/assignclientprivilegessetting","routeSlug":"/openapi/okta-management/management/tags/orgsettingadmin/other/assignclientprivilegessetting","metadata":{"seo":{"title":"Assign the default public client app role setting","description":"
"}},"httpPath":"/api/v1/org/settings/clientPrivilegesSetting"}],"metadata":{"type":"openapi","title":"Org Admin Settings","description":"The Org Admin Settings API provides operations to manage the admin settings for your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingcommunication.yaml","link":"/openapi/okta-management/management/tags/orgsettingcommunication","routeSlug":"/openapi/okta-management/management/tags/orgsettingcommunication","label":"Org Communication Settings","items":[{"type":"group","label":"Org Communication Settings","link":"/openapi/okta-management/management/tags/orgsettingcommunication/orgsettingcommunication","routeSlug":"/openapi/okta-management/management/tags/orgsettingcommunication/orgsettingcommunication","items":[]},{"label":"Retrieve the Okta communication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcommunication/other/getoktacommunicationsettings","routeSlug":"/openapi/okta-management/management/tags/orgsettingcommunication/other/getoktacommunicationsettings","metadata":{"seo":{"title":"Retrieve the Okta communication settings","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaCommunication"},{"label":"Opt in to Okta user communication emails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcommunication/other/optinuserstooktacommunicationemails","routeSlug":"/openapi/okta-management/management/tags/orgsettingcommunication/other/optinuserstooktacommunicationemails","metadata":{"seo":{"title":"Opt in to Okta user communication emails","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaCommunication/optIn"},{"label":"Opt out of Okta user communication emails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcommunication/other/optoutusersfromoktacommunicationemails","routeSlug":"/openapi/okta-management/management/tags/orgsettingcommunication/other/optoutusersfromoktacommunicationemails","metadata":{"seo":{"title":"Opt out of Okta user communication emails","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaCommunication/optOut"}],"metadata":{"type":"openapi","title":"Org Communication 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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingcontact.yaml","link":"/openapi/okta-management/management/tags/orgsettingcontact","routeSlug":"/openapi/okta-management/management/tags/orgsettingcontact","label":"Org Contacts","items":[{"type":"group","label":"Org Contacts","link":"/openapi/okta-management/management/tags/orgsettingcontact/orgsettingcontact","routeSlug":"/openapi/okta-management/management/tags/orgsettingcontact/orgsettingcontact","items":[]},{"label":"List all org contact types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcontact/other/listorgcontacttypes","routeSlug":"/openapi/okta-management/management/tags/orgsettingcontact/other/listorgcontacttypes","metadata":{"seo":{"title":"List all org contact types","description":"
"}},"httpPath":"/api/v1/org/contacts"},{"label":"Retrieve the contact type user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcontact/other/getorgcontactuser","routeSlug":"/openapi/okta-management/management/tags/orgsettingcontact/other/getorgcontactuser","metadata":{"seo":{"title":"Retrieve the contact type user","description":"
"}},"httpPath":"/api/v1/org/contacts/{contactType}"},{"label":"Replace the contact type user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcontact/other/replaceorgcontactuser","routeSlug":"/openapi/okta-management/management/tags/orgsettingcontact/other/replaceorgcontactuser","metadata":{"seo":{"title":"Replace the contact type user","description":"
"}},"httpPath":"/api/v1/org/contacts/{contactType}"}],"metadata":{"type":"openapi","title":"Org Contacts","description":"The Org Contacts API provides operations to manage the contact types of your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingcustomization.yaml","link":"/openapi/okta-management/management/tags/orgsettingcustomization","routeSlug":"/openapi/okta-management/management/tags/orgsettingcustomization","label":"Org Customization","items":[{"type":"group","label":"Org Customization","link":"/openapi/okta-management/management/tags/orgsettingcustomization/orgsettingcustomization","routeSlug":"/openapi/okta-management/management/tags/orgsettingcustomization/orgsettingcustomization","items":[]},{"label":"Retrieve the org preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcustomization/other/getorgpreferences","routeSlug":"/openapi/okta-management/management/tags/orgsettingcustomization/other/getorgpreferences","metadata":{"seo":{"title":"Retrieve the org preferences","description":"
"}},"httpPath":"/api/v1/org/preferences"},{"label":"Set the hide dashboard footer preference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcustomization/other/setorghideoktauifooter","routeSlug":"/openapi/okta-management/management/tags/orgsettingcustomization/other/setorghideoktauifooter","metadata":{"seo":{"title":"Set the hide dashboard footer preference","description":"
"}},"httpPath":"/api/v1/org/preferences/hideEndUserFooter"},{"label":"Set the show dashboard footer preference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingcustomization/other/setorgshowoktauifooter","routeSlug":"/openapi/okta-management/management/tags/orgsettingcustomization/other/setorgshowoktauifooter","metadata":{"seo":{"title":"Set the show dashboard footer preference","description":"
"}},"httpPath":"/api/v1/org/preferences/showEndUserFooter"}],"metadata":{"type":"openapi","title":"Org Customization","description":"The Org Customization API provides operations to retrieve and modify custom settings for your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettinggeneral.yaml","link":"/openapi/okta-management/management/tags/orgsettinggeneral","routeSlug":"/openapi/okta-management/management/tags/orgsettinggeneral","label":"Org General Settings","items":[{"type":"group","label":"Org General Settings","link":"/openapi/okta-management/management/tags/orgsettinggeneral/orgsettinggeneral","routeSlug":"/openapi/okta-management/management/tags/orgsettinggeneral/orgsettinggeneral","items":[]},{"label":"Retrieve the Org general settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettinggeneral/other/getorgsettings","routeSlug":"/openapi/okta-management/management/tags/orgsettinggeneral/other/getorgsettings","metadata":{"seo":{"title":"Retrieve the Org general settings","description":"
"}},"httpPath":"/api/v1/org"},{"label":"Update the Org general settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettinggeneral/other/updateorgsettings","routeSlug":"/openapi/okta-management/management/tags/orgsettinggeneral/other/updateorgsettings","metadata":{"seo":{"title":"Update the Org general settings","description":"
"}},"httpPath":"/api/v1/org"},{"label":"Replace the Org general settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettinggeneral/other/replaceorgsettings","routeSlug":"/openapi/okta-management/management/tags/orgsettinggeneral/other/replaceorgsettings","metadata":{"seo":{"title":"Replace the Org general settings","description":"
"}},"httpPath":"/api/v1/org"}],"metadata":{"type":"openapi","title":"Org General Settings","description":"The Org General Settings API provides operations to manage the general settings of your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingmetadata.yaml","link":"/openapi/okta-management/management/tags/orgsettingmetadata","routeSlug":"/openapi/okta-management/management/tags/orgsettingmetadata","label":"Org Metadata","items":[{"type":"group","label":"Org Metadata","link":"/openapi/okta-management/management/tags/orgsettingmetadata/orgsettingmetadata","routeSlug":"/openapi/okta-management/management/tags/orgsettingmetadata/orgsettingmetadata","items":[]},{"label":"Retrieve the Org metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingmetadata/other/getwellknownorgmetadata","routeSlug":"/openapi/okta-management/management/tags/orgsettingmetadata/other/getwellknownorgmetadata","metadata":{"seo":{"title":"Retrieve the Org metadata","description":"
CORS
"}},"httpPath":"/.well-known/okta-organization"}],"metadata":{"type":"openapi","title":"Org Metadata","description":"The Org Metadata API provides operation to fetch metadata for your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgsettingsupport.yaml","link":"/openapi/okta-management/management/tags/orgsettingsupport","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport","label":"Org Support Settings","items":[{"type":"group","label":"Org Support Settings","link":"/openapi/okta-management/management/tags/orgsettingsupport/orgsettingsupport","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/orgsettingsupport","items":[]},{"label":"Retrieve Okta Aerial consent for your org","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/getaerialconsent","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/getaerialconsent","metadata":{"seo":{"title":"Retrieve Okta Aerial consent for your org","description":"
"}},"httpPath":"/api/v1/org/privacy/aerial"},{"label":"Grant Okta Aerial access to your org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/grantaerialconsent","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/grantaerialconsent","metadata":{"seo":{"title":"Grant Okta Aerial access to your org","description":"
"}},"httpPath":"/api/v1/org/privacy/aerial/grant"},{"label":"Revoke Okta Aerial access to your org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/revokeaerialconsent","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/revokeaerialconsent","metadata":{"seo":{"title":"Revoke Okta Aerial access to your org","description":"
"}},"httpPath":"/api/v1/org/privacy/aerial/revoke"},{"label":"Retrieve the Okta Support settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/getorgoktasupportsettings","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/getorgoktasupportsettings","metadata":{"seo":{"title":"Retrieve the Okta Support settings","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport"},{"label":"List all Okta Support cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/listoktasupportcases","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/listoktasupportcases","metadata":{"seo":{"title":"List all Okta Support cases","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport/cases"},{"label":"Update an Okta Support case","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase","metadata":{"seo":{"title":"Update an Okta Support case","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport/cases/{caseNumber}"},{"label":"Extend Okta Support access","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/extendoktasupport","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/extendoktasupport","metadata":{"seo":{"title":"Extend Okta Support access","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport/extend"},{"label":"Grant Okta Support access","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/grantoktasupport","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/grantoktasupport","metadata":{"seo":{"title":"Grant Okta Support access","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport/grant"},{"label":"Revoke Okta Support access","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgsettingsupport/other/revokeoktasupport","routeSlug":"/openapi/okta-management/management/tags/orgsettingsupport/other/revokeoktasupport","metadata":{"seo":{"title":"Revoke Okta Support access","description":"
"}},"httpPath":"/api/v1/org/privacy/oktaSupport/revoke"}],"metadata":{"type":"openapi","title":"Org Support Settings","description":"The Org Support Settings API provides operations to manage the support settings for your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/feature.yaml","link":"/openapi/okta-management/management/tags/feature","routeSlug":"/openapi/okta-management/management/tags/feature","label":"Features","items":[{"type":"group","label":"Features","link":"/openapi/okta-management/management/tags/feature/feature","routeSlug":"/openapi/okta-management/management/tags/feature/feature","items":[]},{"label":"List all features","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/feature/other/listfeatures","routeSlug":"/openapi/okta-management/management/tags/feature/other/listfeatures","metadata":{"seo":{"title":"List all features","description":"
"}},"httpPath":"/api/v1/features"},{"label":"Retrieve a feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/feature/other/getfeature","routeSlug":"/openapi/okta-management/management/tags/feature/other/getfeature","metadata":{"seo":{"title":"Retrieve a feature","description":"
"}},"httpPath":"/api/v1/features/{featureId}"},{"label":"List all dependencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/feature/other/listfeaturedependencies","routeSlug":"/openapi/okta-management/management/tags/feature/other/listfeaturedependencies","metadata":{"seo":{"title":"List all dependencies","description":"
"}},"httpPath":"/api/v1/features/{featureId}/dependencies"},{"label":"List all dependents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/feature/other/listfeaturedependents","routeSlug":"/openapi/okta-management/management/tags/feature/other/listfeaturedependents","metadata":{"seo":{"title":"List all dependents","description":"
"}},"httpPath":"/api/v1/features/{featureId}/dependents"},{"label":"Update a feature lifecycle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/feature/other/updatefeaturelifecycle","routeSlug":"/openapi/okta-management/management/tags/feature/other/updatefeaturelifecycle","metadata":{"seo":{"title":"Update a feature lifecycle","description":"
"}},"httpPath":"/api/v1/features/{featureId}/{lifecycle}"}],"metadata":{"type":"openapi","title":"Features","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://okta-developer.pixtulate.com/docs/concepts/feature-lifecycle-management/) page."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/emailcustomization.yaml","link":"/openapi/okta-management/management/tags/emailcustomization","routeSlug":"/openapi/okta-management/management/tags/emailcustomization","label":"Org Email Settings","items":[{"type":"group","label":"Org Email Settings","link":"/openapi/okta-management/management/tags/emailcustomization/emailcustomization","routeSlug":"/openapi/okta-management/management/tags/emailcustomization/emailcustomization","items":[]},{"label":"Remove bounced emails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/emailcustomization/other/bulkremoveemailaddressbounces","routeSlug":"/openapi/okta-management/management/tags/emailcustomization/other/bulkremoveemailaddressbounces","metadata":{"seo":{"title":"Remove bounced emails","description":"
"}},"httpPath":"/api/v1/org/email/bounces/remove-list"}],"metadata":{"type":"openapi","title":"Org Email Settings","description":"The Org Email Settings API provides operations to modify the email bounce list for your Okta org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/orgcreator.yaml","link":"/openapi/okta-management/management/tags/orgcreator","routeSlug":"/openapi/okta-management/management/tags/orgcreator","label":"Org Creator","items":[{"type":"group","label":"Org Creator","link":"/openapi/okta-management/management/tags/orgcreator/orgcreator","routeSlug":"/openapi/okta-management/management/tags/orgcreator/orgcreator","items":[]},{"label":"Create an org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/orgcreator/other/createchildorg","routeSlug":"/openapi/okta-management/management/tags/orgcreator/other/createchildorg","metadata":{"seo":{"title":"Create an org","description":"
"}},"httpPath":"/api/v1/orgs"}],"metadata":{"type":"openapi","title":"Org Creator","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://okta-developer.pixtulate.com/docs/concepts/org-creator/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/disasterrecovery.yaml","link":"/openapi/okta-management/management/tags/disasterrecovery","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery","label":"Enhanced Disaster Recovery","items":[{"type":"group","label":"Enhanced Disaster Recovery","link":"/openapi/okta-management/management/tags/disasterrecovery/disasterrecovery","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery/disasterrecovery","items":[]},{"label":"Start the failback of your org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/disasterrecovery/other/startorgfailback","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery/other/startorgfailback","metadata":{"seo":{"title":"Start the failback of your org","description":"
Early Access
OAuth 2.0 scope:
  • okta.dr.manage
"}},"httpPath":"/api/v1/dr/failback"},{"label":"Start the failover of your org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/disasterrecovery/other/startorgfailover","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery/other/startorgfailover","metadata":{"seo":{"title":"Start the failover of your org","description":"
Early Access
OAuth 2.0 scope:
  • okta.dr.manage
"}},"httpPath":"/api/v1/dr/failover"},{"label":"Retrieve the disaster recovery status for all domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/disasterrecovery/other/getdrstatus","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery/other/getdrstatus","metadata":{"seo":{"title":"Retrieve the disaster recovery status for all domains","description":"
Early Access
OAuth 2.0 scope:
  • okta.dr.read
"}},"httpPath":"/api/v1/dr/status"},{"label":"Retrieve the disaster recovery status for a domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/disasterrecovery/other/getdrstatusfordomain","routeSlug":"/openapi/okta-management/management/tags/disasterrecovery/other/getdrstatusfordomain","metadata":{"seo":{"title":"Retrieve the disaster recovery status for a domain","description":"
Early Access
OAuth 2.0 scope:
  • okta.dr.read
"}},"httpPath":"/api/v1/dr/status/{domain}"}],"metadata":{"type":"openapi","title":"Enhanced Disaster Recovery","description":"
\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://okta-help.pixtulate.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://okta-example.pixtulate.com`, use `https://drapp.okta-example.pixtulate.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://okta-developer.pixtulate.com/docs/concepts/oauth-openid/)\n\nSee also:\n* [Manage org recovery with Okta Enhanced Disaster Recovery](https://okta-developer.pixtulate.com/docs/guides/manage-orgs-okta-edr/main/)\n* [Enhanced Disaster Recovery](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=enhanced-disaster-recovery)"}}]},{"type":"group","label":"Rate Limits","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/ratelimitsettings.yaml","link":"/openapi/okta-management/management/tags/ratelimitsettings","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings","label":"Rate Limit Settings","items":[{"type":"group","label":"Rate Limit Settings","link":"/openapi/okta-management/management/tags/ratelimitsettings/ratelimitsettings","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/ratelimitsettings","items":[]},{"label":"Retrieve the rate limit admin notification settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingsadminnotifications","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingsadminnotifications","metadata":{"seo":{"title":"Retrieve the rate limit admin notification settings","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/admin-notifications"},{"label":"Replace the rate limit admin notification settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingsadminnotifications","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingsadminnotifications","metadata":{"seo":{"title":"Replace the rate limit admin notification settings","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/admin-notifications"},{"label":"Retrieve the per-client rate limit settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingsperclient","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingsperclient","metadata":{"seo":{"title":"Retrieve the per-client rate limit settings","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/per-client"},{"label":"Replace the per-client rate limit settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingsperclient","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingsperclient","metadata":{"seo":{"title":"Replace the per-client rate limit settings","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/per-client"},{"label":"Retrieve the rate limit warning threshold percentage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingswarningthreshold","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/getratelimitsettingswarningthreshold","metadata":{"seo":{"title":"Retrieve the rate limit warning threshold percentage","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/warning-threshold"},{"label":"Replace the rate limit warning threshold percentage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingswarningthreshold","routeSlug":"/openapi/okta-management/management/tags/ratelimitsettings/other/replaceratelimitsettingswarningthreshold","metadata":{"seo":{"title":"Replace the rate limit warning threshold percentage","description":"
"}},"httpPath":"/api/v1/rate-limit-settings/warning-threshold"}],"metadata":{"type":"openapi","title":"Rate Limit Settings","description":"The Rate Limit Settings APIs provide operations to manage settings and configurations surrounding rate limiting in your Okta organization."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/principalratelimit.yaml","link":"/openapi/okta-management/management/tags/principalratelimit","routeSlug":"/openapi/okta-management/management/tags/principalratelimit","label":"Principal Rate Limits","items":[{"type":"group","label":"Principal Rate Limits","link":"/openapi/okta-management/management/tags/principalratelimit/principalratelimit","routeSlug":"/openapi/okta-management/management/tags/principalratelimit/principalratelimit","items":[]},{"label":"List all principal rate limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/principalratelimit/other/listprincipalratelimitentities","routeSlug":"/openapi/okta-management/management/tags/principalratelimit/other/listprincipalratelimitentities","metadata":{"seo":{"title":"List all principal rate limits","description":"
"}},"httpPath":"/api/v1/principal-rate-limits"},{"label":"Create a principal rate limit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/principalratelimit/other/createprincipalratelimitentity","routeSlug":"/openapi/okta-management/management/tags/principalratelimit/other/createprincipalratelimitentity","metadata":{"seo":{"title":"Create a principal rate limit","description":"
"}},"httpPath":"/api/v1/principal-rate-limits"},{"label":"Retrieve a principal rate limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/principalratelimit/other/getprincipalratelimitentity","routeSlug":"/openapi/okta-management/management/tags/principalratelimit/other/getprincipalratelimitentity","metadata":{"seo":{"title":"Retrieve a principal rate limit","description":"
"}},"httpPath":"/api/v1/principal-rate-limits/{principalRateLimitId}"},{"label":"Replace a principal rate limit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/principalratelimit/other/replaceprincipalratelimitentity","routeSlug":"/openapi/okta-management/management/tags/principalratelimit/other/replaceprincipalratelimitentity","metadata":{"seo":{"title":"Replace a principal rate limit","description":"
"}},"httpPath":"/api/v1/principal-rate-limits/{principalRateLimitId}"}],"metadata":{"type":"openapi","title":"Principal Rate Limits","description":"The Principal Rate Limits API provides operations to manage Principal Rate Limits for your organization."}}]},{"type":"group","label":"Realms","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/realm.yaml","link":"/openapi/okta-management/management/tags/realm","routeSlug":"/openapi/okta-management/management/tags/realm","label":"Realms","items":[{"type":"group","label":"Realms","link":"/openapi/okta-management/management/tags/realm/realm","routeSlug":"/openapi/okta-management/management/tags/realm/realm","items":[]},{"label":"List all realms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realm/other/listrealms","routeSlug":"/openapi/okta-management/management/tags/realm/other/listrealms","metadata":{"seo":{"title":"List all realms","description":"
"}},"httpPath":"/api/v1/realms"},{"label":"Create a realm","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realm/other/createrealm","routeSlug":"/openapi/okta-management/management/tags/realm/other/createrealm","metadata":{"seo":{"title":"Create a realm","description":"
"}},"httpPath":"/api/v1/realms"},{"label":"Retrieve a realm","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realm/other/getrealm","routeSlug":"/openapi/okta-management/management/tags/realm/other/getrealm","metadata":{"seo":{"title":"Retrieve a realm","description":"
"}},"httpPath":"/api/v1/realms/{realmId}"},{"label":"Replace the realm profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realm/other/replacerealm","routeSlug":"/openapi/okta-management/management/tags/realm/other/replacerealm","metadata":{"seo":{"title":"Replace the realm profile","description":"
"}},"httpPath":"/api/v1/realms/{realmId}"},{"label":"Delete a realm","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realm/other/deleterealm","routeSlug":"/openapi/okta-management/management/tags/realm/other/deleterealm","metadata":{"seo":{"title":"Delete a realm","description":"
"}},"httpPath":"/api/v1/realms/{realmId}"}],"metadata":{"type":"openapi","title":"Realms","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=csh-realms)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/realmassignment.yaml","link":"/openapi/okta-management/management/tags/realmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment","label":"Realm Assignments","items":[{"type":"group","label":"Realm Assignments","link":"/openapi/okta-management/management/tags/realmassignment/realmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/realmassignment","items":[]},{"label":"List all realm assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/listrealmassignments","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/listrealmassignments","metadata":{"seo":{"title":"List all realm assignments","description":"
"}},"httpPath":"/api/v1/realm-assignments"},{"label":"Create a realm assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/createrealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/createrealmassignment","metadata":{"seo":{"title":"Create a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments"},{"label":"List all realm assignment operations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/listrealmassignmentoperations","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/listrealmassignmentoperations","metadata":{"seo":{"title":"List all realm assignment operations","description":"
"}},"httpPath":"/api/v1/realm-assignments/operations"},{"label":"Execute a realm assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/executerealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/executerealmassignment","metadata":{"seo":{"title":"Execute a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/operations"},{"label":"Retrieve a realm assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/getrealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/getrealmassignment","metadata":{"seo":{"title":"Retrieve a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/{assignmentId}"},{"label":"Replace a realm assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/replacerealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/replacerealmassignment","metadata":{"seo":{"title":"Replace a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/{assignmentId}"},{"label":"Delete a realm assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/deleterealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/deleterealmassignment","metadata":{"seo":{"title":"Delete a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/{assignmentId}"},{"label":"Activate a realm assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/activaterealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/activaterealmassignment","metadata":{"seo":{"title":"Activate a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/{assignmentId}/lifecycle/activate"},{"label":"Deactivate a realm assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/realmassignment/other/deactivaterealmassignment","routeSlug":"/openapi/okta-management/management/tags/realmassignment/other/deactivaterealmassignment","metadata":{"seo":{"title":"Deactivate a realm assignment","description":"
"}},"httpPath":"/api/v1/realm-assignments/{assignmentId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Realm Assignments","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=csh-realms-assignment) and [Manage realms](https://okta-help.pixtulate.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."}}]},{"type":"group","label":"Schemas","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/schema.yaml","link":"/openapi/okta-management/management/tags/schema","routeSlug":"/openapi/okta-management/management/tags/schema","label":"Schemas","items":[{"type":"link","label":"Unique Attributes","link":"/openapi/okta-management/management/tags/schema/section/unique-attributes","routeSlug":"/openapi/okta-management/management/tags/schema/section/unique-attributes"},{"type":"link","label":"Add new unique custom property","link":"/openapi/okta-management/management/tags/schema/section/add-new-unique-custom-property","routeSlug":"/openapi/okta-management/management/tags/schema/section/add-new-unique-custom-property"},{"type":"link","label":"Update existing custom property to be unique","link":"/openapi/okta-management/management/tags/schema/section/update-existing-custom-property-to-be-unique","routeSlug":"/openapi/okta-management/management/tags/schema/section/update-existing-custom-property-to-be-unique"},{"type":"link","label":"Update existing unique custom property to be non-unique","link":"/openapi/okta-management/management/tags/schema/section/update-existing-unique-custom-property-to-be-non-unique","routeSlug":"/openapi/okta-management/management/tags/schema/section/update-existing-unique-custom-property-to-be-non-unique"},{"type":"group","label":"Schemas","link":"/openapi/okta-management/management/tags/schema/schema","routeSlug":"/openapi/okta-management/management/tags/schema/schema","items":[]},{"label":"Retrieve the default app user schema for an app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/getapplicationuserschema","routeSlug":"/openapi/okta-management/management/tags/schema/other/getapplicationuserschema","metadata":{"seo":{"title":"Retrieve the default app user schema for an app","description":"
"}},"httpPath":"/api/v1/meta/schemas/apps/{appId}/default"},{"label":"Update the app user profile schema for an app","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/updateapplicationuserprofile","routeSlug":"/openapi/okta-management/management/tags/schema/other/updateapplicationuserprofile","metadata":{"seo":{"title":"Update the app user profile schema for an app","description":"
"}},"httpPath":"/api/v1/meta/schemas/apps/{appId}/default"},{"label":"Retrieve the default group schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/getgroupschema","routeSlug":"/openapi/okta-management/management/tags/schema/other/getgroupschema","metadata":{"seo":{"title":"Retrieve the default group schema","description":"
"}},"httpPath":"/api/v1/meta/schemas/group/default"},{"label":"Update the group profile schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/updategroupschema","routeSlug":"/openapi/okta-management/management/tags/schema/other/updategroupschema","metadata":{"seo":{"title":"Update the group profile schema","description":"
"}},"httpPath":"/api/v1/meta/schemas/group/default"},{"label":"List the log stream schemas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/listlogstreamschemas","routeSlug":"/openapi/okta-management/management/tags/schema/other/listlogstreamschemas","metadata":{"seo":{"title":"List the log stream schemas","description":"
"}},"httpPath":"/api/v1/meta/schemas/logStream"},{"label":"Retrieve the log stream schema for the schema type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/getlogstreamschema","routeSlug":"/openapi/okta-management/management/tags/schema/other/getlogstreamschema","metadata":{"seo":{"title":"Retrieve the log stream schema for the schema type","description":"
"}},"httpPath":"/api/v1/meta/schemas/logStream/{logStreamType}"},{"label":"Retrieve a user schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/getuserschema","routeSlug":"/openapi/okta-management/management/tags/schema/other/getuserschema","metadata":{"seo":{"title":"Retrieve a user schema","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/{schemaId}"},{"label":"Update a user schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/schema/other/updateuserprofile","routeSlug":"/openapi/okta-management/management/tags/schema/other/updateuserprofile","metadata":{"seo":{"title":"Update a user schema","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/{schemaId}"}],"metadata":{"type":"openapi","title":"Schemas","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://okta-help.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [add property to group profile schema](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [update group profile schema property](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [update group profile schema property](https://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/linkedobject.yaml","link":"/openapi/okta-management/management/tags/linkedobject","routeSlug":"/openapi/okta-management/management/tags/linkedobject","label":"Linked Objects","items":[{"type":"link","label":"Example usage","link":"/openapi/okta-management/management/tags/linkedobject/section/example-usage","routeSlug":"/openapi/okta-management/management/tags/linkedobject/section/example-usage"},{"type":"link","label":"Links between user types","link":"/openapi/okta-management/management/tags/linkedobject/section/links-between-user-types","routeSlug":"/openapi/okta-management/management/tags/linkedobject/section/links-between-user-types"},{"type":"link","label":"Link definition operations","link":"/openapi/okta-management/management/tags/linkedobject/section/link-definition-operations","routeSlug":"/openapi/okta-management/management/tags/linkedobject/section/link-definition-operations"},{"type":"group","label":"Linked Objects","link":"/openapi/okta-management/management/tags/linkedobject/linkedobject","routeSlug":"/openapi/okta-management/management/tags/linkedobject/linkedobject","items":[]},{"label":"List all linked object definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/linkedobject/other/listlinkedobjectdefinitions","routeSlug":"/openapi/okta-management/management/tags/linkedobject/other/listlinkedobjectdefinitions","metadata":{"seo":{"title":"List all linked object definitions","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/linkedObjects"},{"label":"Create a linked object definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/linkedobject/other/createlinkedobjectdefinition","routeSlug":"/openapi/okta-management/management/tags/linkedobject/other/createlinkedobjectdefinition","metadata":{"seo":{"title":"Create a linked object definition","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/linkedObjects"},{"label":"Retrieve a linked object definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/linkedobject/other/getlinkedobjectdefinition","routeSlug":"/openapi/okta-management/management/tags/linkedobject/other/getlinkedobjectdefinition","metadata":{"seo":{"title":"Retrieve a linked object definition","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}"},{"label":"Delete a linked object definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/linkedobject/other/deletelinkedobjectdefinition","routeSlug":"/openapi/okta-management/management/tags/linkedobject/other/deletelinkedobjectdefinition","metadata":{"seo":{"title":"Delete a linked object definition","description":"
"}},"httpPath":"/api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}"}],"metadata":{"type":"openapi","title":"Linked Objects","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://okta-developer.pixtulate.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://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/uischema.yaml","link":"/openapi/okta-management/management/tags/uischema","routeSlug":"/openapi/okta-management/management/tags/uischema","label":"UI Schema","items":[{"type":"group","label":"UI Schema","link":"/openapi/okta-management/management/tags/uischema/uischema","routeSlug":"/openapi/okta-management/management/tags/uischema/uischema","items":[]},{"label":"List all UI schemas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/uischema/other/listuischemas","routeSlug":"/openapi/okta-management/management/tags/uischema/other/listuischemas","metadata":{"seo":{"title":"List all UI schemas","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.uischemas.read
"}},"httpPath":"/api/v1/meta/uischemas"},{"label":"Create a UI schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/uischema/other/createuischema","routeSlug":"/openapi/okta-management/management/tags/uischema/other/createuischema","metadata":{"seo":{"title":"Create a UI schema","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.uischemas.manage
"}},"httpPath":"/api/v1/meta/uischemas"},{"label":"Retrieve a UI schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/uischema/other/getuischema","routeSlug":"/openapi/okta-management/management/tags/uischema/other/getuischema","metadata":{"seo":{"title":"Retrieve a UI schema","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.uischemas.read
"}},"httpPath":"/api/v1/meta/uischemas/{id}"},{"label":"Replace a UI schema","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/uischema/other/replaceuischemas","routeSlug":"/openapi/okta-management/management/tags/uischema/other/replaceuischemas","metadata":{"seo":{"title":"Replace a UI schema","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.uischemas.manage
"}},"httpPath":"/api/v1/meta/uischemas/{id}"},{"label":"Delete a UI schema","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/uischema/other/deleteuischemas","routeSlug":"/openapi/okta-management/management/tags/uischema/other/deleteuischemas","metadata":{"seo":{"title":"Delete a UI schema","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.uischemas.manage
"}},"httpPath":"/api/v1/meta/uischemas/{id}"}],"metadata":{"type":"openapi","title":"UI Schema","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."}}]},{"type":"group","label":"Service Accounts","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/serviceaccount.yaml","link":"/openapi/okta-management/management/tags/serviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount","label":"Service Accounts","items":[{"type":"group","label":"Service Accounts","link":"/openapi/okta-management/management/tags/serviceaccount/serviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/serviceaccount","items":[]},{"label":"List all app service accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/serviceaccount/other/listappserviceaccounts","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/other/listappserviceaccounts","metadata":{"seo":{"title":"List all app service accounts","description":"
"}},"httpPath":"/privileged-access/api/v1/service-accounts"},{"label":"Create an app service account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/serviceaccount/other/createappserviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/other/createappserviceaccount","metadata":{"seo":{"title":"Create an app service account","description":"
"}},"httpPath":"/privileged-access/api/v1/service-accounts"},{"label":"Retrieve an app service account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/serviceaccount/other/getappserviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/other/getappserviceaccount","metadata":{"seo":{"title":"Retrieve an app service account","description":"
"}},"httpPath":"/privileged-access/api/v1/service-accounts/{id}"},{"label":"Update an existing app service account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/serviceaccount/other/updateappserviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/other/updateappserviceaccount","metadata":{"seo":{"title":"Update an existing app service account","description":"
"}},"httpPath":"/privileged-access/api/v1/service-accounts/{id}"},{"label":"Delete an app service account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/serviceaccount/other/deleteappserviceaccount","routeSlug":"/openapi/okta-management/management/tags/serviceaccount/other/deleteappserviceaccount","metadata":{"seo":{"title":"Delete an app service account","description":"
"}},"httpPath":"/privileged-access/api/v1/service-accounts/{id}"}],"metadata":{"type":"openapi","title":"Service Accounts","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://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ud-privileged-acnt)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/oktamanageduseraccount.yaml","link":"/openapi/okta-management/management/tags/oktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount","label":"Okta Managed User Accounts","items":[{"type":"group","label":"Okta Managed User Accounts","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/oktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/oktamanageduseraccount","items":[]},{"label":"List all Okta managed user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/listoktamanageduseraccounts","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/listoktamanageduseraccounts","metadata":{"seo":{"title":"List all Okta managed user accounts","description":"
"}},"httpPath":"/privileged-access/api/v1/okta-service-accounts"},{"label":"Create an Okta managed user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/createoktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/createoktamanageduseraccount","metadata":{"seo":{"title":"Create an Okta managed user account","description":"
"}},"httpPath":"/privileged-access/api/v1/okta-service-accounts"},{"label":"Retrieve an Okta managed user account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/getoktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/getoktamanageduseraccount","metadata":{"seo":{"title":"Retrieve an Okta managed user account","description":"
"}},"httpPath":"/privileged-access/api/v1/okta-service-accounts/{id}"},{"label":"Update an Okta managed user account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/updateoktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/updateoktamanageduseraccount","metadata":{"seo":{"title":"Update an Okta managed user account","description":"
"}},"httpPath":"/privileged-access/api/v1/okta-service-accounts/{id}"},{"label":"Delete an Okta managed user account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/deleteoktamanageduseraccount","routeSlug":"/openapi/okta-management/management/tags/oktamanageduseraccount/other/deleteoktamanageduseraccount","metadata":{"seo":{"title":"Delete an Okta managed user account","description":"
"}},"httpPath":"/privileged-access/api/v1/okta-service-accounts/{id}"}],"metadata":{"type":"openapi","title":"Okta Managed User Accounts","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://okta-help.pixtulate.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."}}]},{"type":"group","label":"Signal Sharing","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/ssfreceiver.yaml","link":"/openapi/okta-management/management/tags/ssfreceiver","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver","label":"SSF Receiver","items":[{"type":"group","label":"SSF Receiver","link":"/openapi/okta-management/management/tags/ssfreceiver/ssfreceiver","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/ssfreceiver","items":[]},{"label":"List all security events providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/listsecurityeventsproviderinstances","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/listsecurityeventsproviderinstances","metadata":{"seo":{"title":"List all security events providers","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.read
"}},"httpPath":"/api/v1/security-events-providers"},{"label":"Create a security events provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/createsecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/createsecurityeventsproviderinstance","metadata":{"seo":{"title":"Create a security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.manage
"}},"httpPath":"/api/v1/security-events-providers"},{"label":"Retrieve the security events provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/getsecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/getsecurityeventsproviderinstance","metadata":{"seo":{"title":"Retrieve the security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.read
"}},"httpPath":"/api/v1/security-events-providers/{securityEventProviderId}"},{"label":"Replace a security events provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/replacesecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/replacesecurityeventsproviderinstance","metadata":{"seo":{"title":"Replace a security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.manage
"}},"httpPath":"/api/v1/security-events-providers/{securityEventProviderId}"},{"label":"Delete a security events provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/deletesecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/deletesecurityeventsproviderinstance","metadata":{"seo":{"title":"Delete a security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.manage
"}},"httpPath":"/api/v1/security-events-providers/{securityEventProviderId}"},{"label":"Activate a security events provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/activatesecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/activatesecurityeventsproviderinstance","metadata":{"seo":{"title":"Activate a security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.manage
"}},"httpPath":"/api/v1/security-events-providers/{securityEventProviderId}/lifecycle/activate"},{"label":"Deactivate a security events provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfreceiver/other/deactivatesecurityeventsproviderinstance","routeSlug":"/openapi/okta-management/management/tags/ssfreceiver/other/deactivatesecurityeventsproviderinstance","metadata":{"seo":{"title":"Deactivate a security events provider","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.securityEventsProviders.manage
"}},"httpPath":"/api/v1/security-events-providers/{securityEventProviderId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"SSF Receiver","description":"\n> This is a feature of Identity Threat Protection. 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://okta-developer.pixtulate.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://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/ssfsecurityeventtoken.yaml","link":"/openapi/okta-management/management/tags/ssfsecurityeventtoken","routeSlug":"/openapi/okta-management/management/tags/ssfsecurityeventtoken","label":"SSF Security Event Tokens","items":[{"type":"group","label":"SSF Security Event Tokens","link":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken","routeSlug":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken","items":[{"type":"link","label":"Security event token JWT body payload","link":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken/securityeventtokenrequestjwtbody","routeSlug":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken/securityeventtokenrequestjwtbody","httpVerb":"schema"},{"type":"link","label":"Security event token JWT header","link":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken/securityeventtokenrequestjwtheader","routeSlug":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/ssfsecurityeventtoken/securityeventtokenrequestjwtheader","httpVerb":"schema"}]},{"label":"Publish a security event token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/other/publishsecurityeventtokens","routeSlug":"/openapi/okta-management/management/tags/ssfsecurityeventtoken/other/publishsecurityeventtokens","metadata":{"seo":{"title":"Publish a security event token","description":"
Identity Engine
"}},"httpPath":"/security/api/v1/security-events"}],"metadata":{"type":"openapi","title":"SSF Security Event Tokens","description":"\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://okta-developer.pixtulate.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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/ssftransmitter.yaml","link":"/openapi/okta-management/management/tags/ssftransmitter","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter","label":"SSF Transmitter","items":[{"type":"group","label":"SSF Transmitter","link":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter","items":[{"type":"link","label":"Security event token JWT body payload","link":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter/securityeventtokenjwtbody","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter/securityeventtokenjwtbody","httpVerb":"schema"},{"type":"link","label":"Security event token JWT header","link":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter/securityeventtokenjwtheader","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/ssftransmitter/securityeventtokenjwtheader","httpVerb":"schema"}]},{"label":"Retrieve the SSF transmitter metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/getwellknownssfmetadata","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/getwellknownssfmetadata","metadata":{"seo":{"title":"Retrieve the SSF transmitter metadata","description":"
Identity Engine
"}},"httpPath":"/.well-known/ssf-configuration"},{"label":"Retrieve the SSF stream configuration(s)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/getssfstreams","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/getssfstreams","metadata":{"seo":{"title":"Retrieve the SSF stream configuration(s)","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream"},{"label":"Create an SSF stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/createssfstream","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/createssfstream","metadata":{"seo":{"title":"Create an SSF stream","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream"},{"label":"Replace an SSF stream","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/replacessfstream","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/replacessfstream","metadata":{"seo":{"title":"Replace an SSF stream","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream"},{"label":"Update an SSF stream","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/updatessfstream","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/updatessfstream","metadata":{"seo":{"title":"Update an SSF stream","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream"},{"label":"Delete an SSF stream","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/deletessfstream","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/deletessfstream","metadata":{"seo":{"title":"Delete an SSF stream","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream"},{"label":"Retrieve the SSF stream status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/getssfstreamstatus","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/getssfstreamstatus","metadata":{"seo":{"title":"Retrieve the SSF stream status","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream/status"},{"label":"Verify an SSF stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/ssftransmitter/other/verifyssfstream","routeSlug":"/openapi/okta-management/management/tags/ssftransmitter/other/verifyssfstream","metadata":{"seo":{"title":"Verify an SSF stream","description":"
Identity Engine
"}},"httpPath":"/api/v1/ssf/stream/verification"}],"metadata":{"type":"openapi","title":"SSF Transmitter","description":"\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."}}]},{"type":"group","label":"System Log","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/systemlog.yaml","link":"/openapi/okta-management/management/tags/systemlog","routeSlug":"/openapi/okta-management/management/tags/systemlog","label":"System Log","items":[{"type":"group","label":"System Log","link":"/openapi/okta-management/management/tags/systemlog/systemlog","routeSlug":"/openapi/okta-management/management/tags/systemlog/systemlog","items":[]},{"label":"List all System Log events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/systemlog/other/listlogevents","routeSlug":"/openapi/okta-management/management/tags/systemlog/other/listlogevents","metadata":{"seo":{"title":"List all System Log events","description":"
CORS
OAuth 2.0 scope:
  • okta.logs.read
"}},"httpPath":"/api/v1/logs"}],"metadata":{"type":"openapi","title":"System Log","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://okta-help.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/).\n\nFor further details and examples, see [System Log query](https://okta-developer.pixtulate.com/docs/reference/system-log-query/)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/logstream.yaml","link":"/openapi/okta-management/management/tags/logstream","routeSlug":"/openapi/okta-management/management/tags/logstream","label":"Log Streaming","items":[{"type":"group","label":"Log Streaming","link":"/openapi/okta-management/management/tags/logstream/logstream","routeSlug":"/openapi/okta-management/management/tags/logstream/logstream","items":[]},{"label":"List all log streams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/listlogstreams","routeSlug":"/openapi/okta-management/management/tags/logstream/other/listlogstreams","metadata":{"seo":{"title":"List all log streams","description":"
"}},"httpPath":"/api/v1/logStreams"},{"label":"Create a log stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/createlogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/createlogstream","metadata":{"seo":{"title":"Create a log stream","description":"
"}},"httpPath":"/api/v1/logStreams"},{"label":"Retrieve a log stream","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/getlogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/getlogstream","metadata":{"seo":{"title":"Retrieve a log stream","description":"
"}},"httpPath":"/api/v1/logStreams/{logStreamId}"},{"label":"Replace a log stream","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/replacelogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/replacelogstream","metadata":{"seo":{"title":"Replace a log stream","description":"
"}},"httpPath":"/api/v1/logStreams/{logStreamId}"},{"label":"Delete a log stream","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/deletelogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/deletelogstream","metadata":{"seo":{"title":"Delete a log stream","description":"
"}},"httpPath":"/api/v1/logStreams/{logStreamId}"},{"label":"Activate a log stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/activatelogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/activatelogstream","metadata":{"seo":{"title":"Activate a log stream","description":"
"}},"httpPath":"/api/v1/logStreams/{logStreamId}/lifecycle/activate"},{"label":"Deactivate a log stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/logstream/other/deactivatelogstream","routeSlug":"/openapi/okta-management/management/tags/logstream/other/deactivatelogstream","metadata":{"seo":{"title":"Deactivate a log stream","description":"
"}},"httpPath":"/api/v1/logStreams/{logStreamId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Log Streaming","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."}}]},{"type":"group","label":"Users","items":[{"type":"group","fsPath":"openapi/okta-management/management/tags/user.yaml","link":"/openapi/okta-management/management/tags/user","routeSlug":"/openapi/okta-management/management/tags/user","label":"Users","items":[{"type":"link","label":"User status","link":"/openapi/okta-management/management/tags/user/section/user-status","routeSlug":"/openapi/okta-management/management/tags/user/section/user-status"},{"type":"link","label":"User creation scenarios","link":"/openapi/okta-management/management/tags/user/section/user-creation-scenarios","routeSlug":"/openapi/okta-management/management/tags/user/section/user-creation-scenarios"},{"type":"link","label":"Create user with optional password","link":"/openapi/okta-management/management/tags/user/section/create-user-with-optional-password","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-optional-password"},{"type":"link","label":"Create user without credentials","link":"/openapi/okta-management/management/tags/user/section/create-user-without-credentials","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-without-credentials"},{"type":"link","label":"Create user with recovery question","link":"/openapi/okta-management/management/tags/user/section/create-user-with-recovery-question","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-recovery-question"},{"type":"link","label":"Create user with password","link":"/openapi/okta-management/management/tags/user/section/create-user-with-password","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-password"},{"type":"link","label":"Create user with imported hashed password","link":"/openapi/okta-management/management/tags/user/section/create-user-with-imported-hashed-password","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-imported-hashed-password"},{"type":"link","label":"Create user with password import inline hook","link":"/openapi/okta-management/management/tags/user/section/create-user-with-password-import-inline-hook","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-password-import-inline-hook"},{"type":"link","label":"Create user with password and recovery question","link":"/openapi/okta-management/management/tags/user/section/create-user-with-password-and-recovery-question","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-password-and-recovery-question"},{"type":"link","label":"Create user with authentication provider","link":"/openapi/okta-management/management/tags/user/section/create-user-with-authentication-provider","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-authentication-provider"},{"type":"link","label":"Create user in group","link":"/openapi/okta-management/management/tags/user/section/create-user-in-group","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-in-group"},{"type":"link","label":"Create user with non-default user type","link":"/openapi/okta-management/management/tags/user/section/create-user-with-non-default-user-type","routeSlug":"/openapi/okta-management/management/tags/user/section/create-user-with-non-default-user-type"},{"type":"link","label":"Links object","link":"/openapi/okta-management/management/tags/user/section/links-object","routeSlug":"/openapi/okta-management/management/tags/user/section/links-object"},{"type":"link","label":"Individual users versus collection of users","link":"/openapi/okta-management/management/tags/user/section/individual-users-versus-collection-of-users","routeSlug":"/openapi/okta-management/management/tags/user/section/individual-users-versus-collection-of-users"},{"type":"group","label":"Users","link":"/openapi/okta-management/management/tags/user/user","routeSlug":"/openapi/okta-management/management/tags/user/user","items":[]},{"label":"List all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/listusers","routeSlug":"/openapi/okta-management/management/tags/user/other/listusers","metadata":{"seo":{"title":"List all users","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/createuser","routeSlug":"/openapi/okta-management/management/tags/user/other/createuser","metadata":{"seo":{"title":"Create a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/getuser","routeSlug":"/openapi/okta-management/management/tags/user/other/getuser","metadata":{"seo":{"title":"Retrieve a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/updateuser","routeSlug":"/openapi/okta-management/management/tags/user/other/updateuser","metadata":{"seo":{"title":"Update a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}"},{"label":"Replace a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/replaceuser","routeSlug":"/openapi/okta-management/management/tags/user/other/replaceuser","metadata":{"seo":{"title":"Replace a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/deleteuser","routeSlug":"/openapi/okta-management/management/tags/user/other/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}"},{"label":"List all user blocks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/listuserblocks","routeSlug":"/openapi/okta-management/management/tags/user/other/listuserblocks","metadata":{"seo":{"title":"List all user blocks","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{id}/blocks"},{"label":"Clear the managed Chrome profile browsing data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/user/other/clearchromedata","routeSlug":"/openapi/okta-management/management/tags/user/other/clearchromedata","metadata":{"seo":{"title":"Clear the managed Chrome profile browsing data","description":"
"}},"httpPath":"/api/v1/users/{id}/clear-chrome-data"}],"metadata":{"type":"openapi","title":"Users","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://okta-developer.pixtulate.com/docs/api/openapi/okta-oauth/guides/overview/).\n\n### User status\nThe following diagram shows the flow of user status:\n\n\"Example\"\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://okta-developer.pixtulate.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://okta-help.pixtulate.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://okta-help.pixtulate.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://okta-support.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/user/listusers) and [List all member users](https://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/userlifecycle/activateuser) |\n|deactivate |\tLifecycle action to [deactivate the user](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/deactivateUser) |\n|suspend |\tLifecycle action to [suspend the user](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/suspendUser) |\n|unsuspend |\tLifecycle action to [unsuspend the user](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/unsuspendUser) |\n|resetPassword |\tLifecycle action to [trigger a password reset](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/usercred/resetpassword) |\n|expirePassword |\tLifecycle action to [expire the user's password](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/expirePassword) |\n|resetFactors |\tLifecycle action to [reset all MFA factors](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/resetFactors) |\n|unlock |\tLifecycle action to [unlock a locked-out user](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/unlockUser) |\n|forgotPassword |\t[Resets a user's password](https://okta-developer.pixtulate.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://okta-developer.pixtulate.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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/changeRecoveryQuestion) by validating the user's current password |"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userauthenticatorenrollments.yaml","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments","label":"User Authenticator Enrollments","items":[{"type":"group","label":"User Authenticator Enrollments","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/userauthenticatorenrollments","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/userauthenticatorenrollments","items":[]},{"label":"List all authenticator enrollments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/listauthenticatorenrollments","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/listauthenticatorenrollments","metadata":{"seo":{"title":"List all authenticator enrollments","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/authenticator-enrollments"},{"label":"Create an auto-activated Phone authenticator enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/createauthenticatorenrollment","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/createauthenticatorenrollment","metadata":{"seo":{"title":"Create an auto-activated Phone authenticator enrollment","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/authenticator-enrollments/phone"},{"label":"Create an auto-activated TAC authenticator enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/createtacauthenticatorenrollment","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/createtacauthenticatorenrollment","metadata":{"seo":{"title":"Create an auto-activated TAC authenticator enrollment","description":"
"}},"httpPath":"/api/v1/users/{userId}/authenticator-enrollments/tac"},{"label":"Retrieve an authenticator enrollment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/getauthenticatorenrollment","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/getauthenticatorenrollment","metadata":{"seo":{"title":"Retrieve an authenticator enrollment","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/authenticator-enrollments/{enrollmentId}"},{"label":"Delete an authenticator enrollment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/deleteauthenticatorenrollment","routeSlug":"/openapi/okta-management/management/tags/userauthenticatorenrollments/other/deleteauthenticatorenrollment","metadata":{"seo":{"title":"Delete an authenticator enrollment","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/authenticator-enrollments/{enrollmentId}"}],"metadata":{"type":"openapi","title":"User Authenticator Enrollments","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userclassification.yaml","link":"/openapi/okta-management/management/tags/userclassification","routeSlug":"/openapi/okta-management/management/tags/userclassification","label":"User Classification","items":[{"type":"group","label":"User Classification","link":"/openapi/okta-management/management/tags/userclassification/userclassification","routeSlug":"/openapi/okta-management/management/tags/userclassification/userclassification","items":[]},{"label":"Retrieve a user's classification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userclassification/other/getuserclassification","routeSlug":"/openapi/okta-management/management/tags/userclassification/other/getuserclassification","metadata":{"seo":{"title":"Retrieve a user's classification","description":"
Early AccessCORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/classification"},{"label":"Replace the user's classification","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userclassification/other/replaceuserclassification","routeSlug":"/openapi/okta-management/management/tags/userclassification/other/replaceuserclassification","metadata":{"seo":{"title":"Replace the user's classification","description":"
Early AccessCORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/classification"}],"metadata":{"type":"openapi","title":"User Classification","description":"The User Classification API provides operations to manage user classifications in your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/usercred.yaml","link":"/openapi/okta-management/management/tags/usercred","routeSlug":"/openapi/okta-management/management/tags/usercred","label":"User Credentials","items":[{"type":"group","label":"User Credentials","link":"/openapi/okta-management/management/tags/usercred/usercred","routeSlug":"/openapi/okta-management/management/tags/usercred/usercred","items":[]},{"label":"Expire the password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/expirepassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/expirepassword","metadata":{"seo":{"title":"Expire the password","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/expire_password"},{"label":"Expire the password with a temporary password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/expirepasswordwithtemppassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/expirepasswordwithtemppassword","metadata":{"seo":{"title":"Expire the password with a temporary password","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/expire_password_with_temp_password"},{"label":"Reset a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/resetpassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/resetpassword","metadata":{"seo":{"title":"Reset a password","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/reset_password"},{"label":"Update password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/changepassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/changepassword","metadata":{"seo":{"title":"Update password","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/credentials/change_password"},{"label":"Update recovery question","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/changerecoveryquestion","routeSlug":"/openapi/okta-management/management/tags/usercred/other/changerecoveryquestion","metadata":{"seo":{"title":"Update recovery question","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/credentials/change_recovery_question"},{"label":"Start forgot password flow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/forgotpassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/forgotpassword","metadata":{"seo":{"title":"Start forgot password flow","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/credentials/forgot_password"},{"label":"Reset password with recovery question","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usercred/other/forgotpasswordsetnewpassword","routeSlug":"/openapi/okta-management/management/tags/usercred/other/forgotpasswordsetnewpassword","metadata":{"seo":{"title":"Reset password with recovery question","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/credentials/forgot_password_recovery_question"}],"metadata":{"type":"openapi","title":"User Credentials","description":"The User Credentials API provides operations to manage user credentials in your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userfactor.yaml","link":"/openapi/okta-management/management/tags/userfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor","label":"User Factors","items":[{"type":"group","label":"User Factors","link":"/openapi/okta-management/management/tags/userfactor/userfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/userfactor","items":[]},{"label":"List all YubiKey OTP tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/listyubikeyotptokens","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/listyubikeyotptokens","metadata":{"seo":{"title":"List all YubiKey OTP tokens","description":"
"}},"httpPath":"/api/v1/org/factors/yubikey_token/tokens"},{"label":"Upload a YubiKey OTP seed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/uploadyubikeyotptokenseed","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/uploadyubikeyotptokenseed","metadata":{"seo":{"title":"Upload a YubiKey OTP seed","description":"
"}},"httpPath":"/api/v1/org/factors/yubikey_token/tokens"},{"label":"Retrieve a YubiKey OTP token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/getyubikeyotptokenbyid","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/getyubikeyotptokenbyid","metadata":{"seo":{"title":"Retrieve a YubiKey OTP token","description":"
"}},"httpPath":"/api/v1/org/factors/yubikey_token/tokens/{tokenId}"},{"label":"List all enrolled factors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/listfactors","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/listfactors","metadata":{"seo":{"title":"List all enrolled factors","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors"},{"label":"Enroll a factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/enrollfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/enrollfactor","metadata":{"seo":{"title":"Enroll a factor","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors"},{"label":"List all supported factors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/listsupportedfactors","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/listsupportedfactors","metadata":{"seo":{"title":"List all supported factors","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/catalog"},{"label":"List all supported security questions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/listsupportedsecurityquestions","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/listsupportedsecurityquestions","metadata":{"seo":{"title":"List all supported security questions","description":"
CORS
"}},"httpPath":"/api/v1/users/{userId}/factors/questions"},{"label":"Retrieve a factor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/getfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/getfactor","metadata":{"seo":{"title":"Retrieve a factor","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}"},{"label":"Unenroll a factor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/unenrollfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/unenrollfactor","metadata":{"seo":{"title":"Unenroll a factor","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}"},{"label":"Activate a factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/activatefactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/activatefactor","metadata":{"seo":{"title":"Activate a factor","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}/lifecycle/activate"},{"label":"Resend a factor enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/resendenrollfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/resendenrollfactor","metadata":{"seo":{"title":"Resend a factor enrollment","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}/resend"},{"label":"Retrieve a factor transaction status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/getfactortransactionstatus","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/getfactortransactionstatus","metadata":{"seo":{"title":"Retrieve a factor transaction status","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}"},{"label":"Verify a factor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userfactor/other/verifyfactor","routeSlug":"/openapi/okta-management/management/tags/userfactor/other/verifyfactor","metadata":{"seo":{"title":"Verify a factor","description":"
"}},"httpPath":"/api/v1/users/{userId}/factors/{factorId}/verify"}],"metadata":{"type":"openapi","title":"User Factors","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://okta-www.pixtulate.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://okta-developer.pixtulate.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)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/usergrant.yaml","link":"/openapi/okta-management/management/tags/usergrant","routeSlug":"/openapi/okta-management/management/tags/usergrant","label":"User Grants","items":[{"type":"group","label":"User Grants","link":"/openapi/okta-management/management/tags/usergrant/usergrant","routeSlug":"/openapi/okta-management/management/tags/usergrant/usergrant","items":[]},{"label":"List all grants for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/listgrantsforuserandclient","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/listgrantsforuserandclient","metadata":{"seo":{"title":"List all grants for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/grants"},{"label":"Revoke all grants for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/revokegrantsforuserandclient","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/revokegrantsforuserandclient","metadata":{"seo":{"title":"Revoke all grants for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/grants"},{"label":"List all user grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/listusergrants","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/listusergrants","metadata":{"seo":{"title":"List all user grants","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/grants"},{"label":"Revoke all user grants","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/revokeusergrants","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/revokeusergrants","metadata":{"seo":{"title":"Revoke all user grants","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/grants"},{"label":"Retrieve a user grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/getusergrant","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/getusergrant","metadata":{"seo":{"title":"Retrieve a user grant","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/grants/{grantId}"},{"label":"Revoke a user grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usergrant/other/revokeusergrant","routeSlug":"/openapi/okta-management/management/tags/usergrant/other/revokeusergrant","metadata":{"seo":{"title":"Revoke a user grant","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/grants/{grantId}"}],"metadata":{"type":"openapi","title":"User Grants","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://okta-support.pixtulate.com/help/s/article/FAQ-How-Blocking-Third-Party-Cookies-Can-Potentially-Impact-Your-Okta-Environment)."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userlifecycle.yaml","link":"/openapi/okta-management/management/tags/userlifecycle","routeSlug":"/openapi/okta-management/management/tags/userlifecycle","label":"User Lifecycle","items":[{"type":"group","label":"User Lifecycle","link":"/openapi/okta-management/management/tags/userlifecycle/userlifecycle","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/userlifecycle","items":[]},{"label":"Activate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/activateuser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/activateuser","metadata":{"seo":{"title":"Activate a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/activate"},{"label":"Deactivate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/deactivateuser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/deactivateuser","metadata":{"seo":{"title":"Deactivate a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/deactivate"},{"label":"Reactivate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/reactivateuser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/reactivateuser","metadata":{"seo":{"title":"Reactivate a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/reactivate"},{"label":"Reset the factors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/resetfactors","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/resetfactors","metadata":{"seo":{"title":"Reset the factors","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/reset_factors"},{"label":"Suspend a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/suspenduser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/suspenduser","metadata":{"seo":{"title":"Suspend a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/suspend"},{"label":"Unlock a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/unlockuser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/unlockuser","metadata":{"seo":{"title":"Unlock a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/unlock"},{"label":"Unsuspend a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlifecycle/other/unsuspenduser","routeSlug":"/openapi/okta-management/management/tags/userlifecycle/other/unsuspenduser","metadata":{"seo":{"title":"Unsuspend a user","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{id}/lifecycle/unsuspend"}],"metadata":{"type":"openapi","title":"User Lifecycle","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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userlinkedobject.yaml","link":"/openapi/okta-management/management/tags/userlinkedobject","routeSlug":"/openapi/okta-management/management/tags/userlinkedobject","label":"User Linked Objects","items":[{"type":"group","label":"User Linked Objects","link":"/openapi/okta-management/management/tags/userlinkedobject/userlinkedobject","routeSlug":"/openapi/okta-management/management/tags/userlinkedobject/userlinkedobject","items":[]},{"label":"Assign a linked object value for primary","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlinkedobject/other/assignlinkedobjectvalueforprimary","routeSlug":"/openapi/okta-management/management/tags/userlinkedobject/other/assignlinkedobjectvalueforprimary","metadata":{"seo":{"title":"Assign a linked object value for primary","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userIdOrLogin}/linkedObjects/{primaryRelationshipName}/{primaryUserId}"},{"label":"List the primary or all of the associated linked object values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlinkedobject/other/listlinkedobjectsforuser","routeSlug":"/openapi/okta-management/management/tags/userlinkedobject/other/listlinkedobjectsforuser","metadata":{"seo":{"title":"List the primary or all of the associated linked object values","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName}"},{"label":"Delete a linked object value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userlinkedobject/other/deletelinkedobjectforuser","routeSlug":"/openapi/okta-management/management/tags/userlinkedobject/other/deletelinkedobjectforuser","metadata":{"seo":{"title":"Delete a linked object value","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName}"}],"metadata":{"type":"openapi","title":"User Linked Objects","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://okta-developer.pixtulate.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`"}},{"type":"group","fsPath":"openapi/okta-management/management/tags/useroauth.yaml","link":"/openapi/okta-management/management/tags/useroauth","routeSlug":"/openapi/okta-management/management/tags/useroauth","label":"User OAuth 2.0 Token Management","items":[{"type":"group","label":"User OAuth 2.0 Token Management","link":"/openapi/okta-management/management/tags/useroauth/useroauth","routeSlug":"/openapi/okta-management/management/tags/useroauth/useroauth","items":[]},{"label":"List all refresh tokens for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/useroauth/other/listrefreshtokensforuserandclient","routeSlug":"/openapi/okta-management/management/tags/useroauth/other/listrefreshtokensforuserandclient","metadata":{"seo":{"title":"List all refresh tokens for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/tokens"},{"label":"Revoke all refresh tokens for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/useroauth/other/revoketokensforuserandclient","routeSlug":"/openapi/okta-management/management/tags/useroauth/other/revoketokensforuserandclient","metadata":{"seo":{"title":"Revoke all refresh tokens for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/tokens"},{"label":"Retrieve a refresh token for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/useroauth/other/getrefreshtokenforuserandclient","routeSlug":"/openapi/okta-management/management/tags/useroauth/other/getrefreshtokenforuserandclient","metadata":{"seo":{"title":"Retrieve a refresh token for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}"},{"label":"Revoke a token for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/useroauth/other/revoketokenforuserandclient","routeSlug":"/openapi/okta-management/management/tags/useroauth/other/revoketokenforuserandclient","metadata":{"seo":{"title":"Revoke a token for a client","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}"}],"metadata":{"type":"openapi","title":"User OAuth 2.0 Token Management","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://okta-developer.pixtulate.com/docs/guides/revoke-tokens/main/) or [manage tokens at the authorization server level](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/AuthorizationServer/).\n\nRead [Validate Access Tokens](https://okta-developer.pixtulate.com/docs/guides/validate-access-tokens/) to understand more about how OAuth 2.0 tokens work."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userresources.yaml","link":"/openapi/okta-management/management/tags/userresources","routeSlug":"/openapi/okta-management/management/tags/userresources","label":"User Resources","items":[{"type":"group","label":"User Resources","link":"/openapi/okta-management/management/tags/userresources/userresources","routeSlug":"/openapi/okta-management/management/tags/userresources/userresources","items":[]},{"label":"List all assigned app links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userresources/other/listapplinks","routeSlug":"/openapi/okta-management/management/tags/userresources/other/listapplinks","metadata":{"seo":{"title":"List all assigned app links","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{id}/appLinks"},{"label":"List all groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userresources/other/listusergroups","routeSlug":"/openapi/okta-management/management/tags/userresources/other/listusergroups","metadata":{"seo":{"title":"List all groups","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{id}/groups"},{"label":"List all clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userresources/other/listuserclients","routeSlug":"/openapi/okta-management/management/tags/userresources/other/listuserclients","metadata":{"seo":{"title":"List all clients","description":"
CORS
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/clients"},{"label":"List all devices for an enrolled user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userresources/other/listuserdevices","routeSlug":"/openapi/okta-management/management/tags/userresources/other/listuserdevices","metadata":{"seo":{"title":"List all devices for an enrolled user","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.users.read
"}},"httpPath":"/api/v1/users/{userId}/devices"}],"metadata":{"type":"openapi","title":"User Resources","description":"The User Resources API provides operations related to user resources."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/userrisk.yaml","link":"/openapi/okta-management/management/tags/userrisk","routeSlug":"/openapi/okta-management/management/tags/userrisk","label":"User Risk","items":[{"type":"group","label":"User Risk","link":"/openapi/okta-management/management/tags/userrisk/userrisk","routeSlug":"/openapi/okta-management/management/tags/userrisk/userrisk","items":[]},{"label":"Retrieve the user's risk","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userrisk/other/getuserrisk","routeSlug":"/openapi/okta-management/management/tags/userrisk/other/getuserrisk","metadata":{"seo":{"title":"Retrieve the user's risk","description":"
"}},"httpPath":"/api/v1/users/{userId}/risk"},{"label":"Upsert the user's risk","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/userrisk/other/upsertuserrisk","routeSlug":"/openapi/okta-management/management/tags/userrisk/other/upsertuserrisk","metadata":{"seo":{"title":"Upsert the user's risk","description":"
"}},"httpPath":"/api/v1/users/{userId}/risk"}],"metadata":{"type":"openapi","title":"User Risk","description":"\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."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/usersessions.yaml","link":"/openapi/okta-management/management/tags/usersessions","routeSlug":"/openapi/okta-management/management/tags/usersessions","label":"User Sessions","items":[{"type":"group","label":"User Sessions","link":"/openapi/okta-management/management/tags/usersessions/usersessions","routeSlug":"/openapi/okta-management/management/tags/usersessions/usersessions","items":[]},{"label":"Revoke all user sessions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usersessions/other/revokeusersessions","routeSlug":"/openapi/okta-management/management/tags/usersessions/other/revokeusersessions","metadata":{"seo":{"title":"Revoke all user sessions","description":"
CORS
OAuth 2.0 scope:
  • okta.users.manage
"}},"httpPath":"/api/v1/users/{userId}/sessions"}],"metadata":{"type":"openapi","title":"User Sessions","description":"The User Sessions API provides operations to manage user sessions in your org."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/usertype.yaml","link":"/openapi/okta-management/management/tags/usertype","routeSlug":"/openapi/okta-management/management/tags/usertype","label":"User Types","items":[{"type":"group","label":"User Types","link":"/openapi/okta-management/management/tags/usertype/usertype","routeSlug":"/openapi/okta-management/management/tags/usertype/usertype","items":[]},{"label":"List all user types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/listusertypes","routeSlug":"/openapi/okta-management/management/tags/usertype/other/listusertypes","metadata":{"seo":{"title":"List all user types","description":"
"}},"httpPath":"/api/v1/meta/types/user"},{"label":"Create a user type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/createusertype","routeSlug":"/openapi/okta-management/management/tags/usertype/other/createusertype","metadata":{"seo":{"title":"Create a user type","description":"
"}},"httpPath":"/api/v1/meta/types/user"},{"label":"Retrieve a user type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/getusertype","routeSlug":"/openapi/okta-management/management/tags/usertype/other/getusertype","metadata":{"seo":{"title":"Retrieve a user type","description":"
"}},"httpPath":"/api/v1/meta/types/user/{typeId}"},{"label":"Update a user type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/updateusertype","routeSlug":"/openapi/okta-management/management/tags/usertype/other/updateusertype","metadata":{"seo":{"title":"Update a user type","description":"
"}},"httpPath":"/api/v1/meta/types/user/{typeId}"},{"label":"Replace a user type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/replaceusertype","routeSlug":"/openapi/okta-management/management/tags/usertype/other/replaceusertype","metadata":{"seo":{"title":"Replace a user type","description":"
"}},"httpPath":"/api/v1/meta/types/user/{typeId}"},{"label":"Delete a user type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/usertype/other/deleteusertype","routeSlug":"/openapi/okta-management/management/tags/usertype/other/deleteusertype","metadata":{"seo":{"title":"Delete a user type","description":"
"}},"httpPath":"/api/v1/meta/types/user/{typeId}"}],"metadata":{"type":"openapi","title":"User Types","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://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=type&t=request) property and the [Schemas](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/management/tag/Schema/) API."}},{"type":"group","fsPath":"openapi/okta-management/management/tags/profilemapping.yaml","link":"/openapi/okta-management/management/tags/profilemapping","routeSlug":"/openapi/okta-management/management/tags/profilemapping","label":"Profile Mappings","items":[{"type":"group","label":"Profile Mappings","link":"/openapi/okta-management/management/tags/profilemapping/profilemapping","routeSlug":"/openapi/okta-management/management/tags/profilemapping/profilemapping","items":[]},{"label":"List all profile mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/profilemapping/other/listprofilemappings","routeSlug":"/openapi/okta-management/management/tags/profilemapping/other/listprofilemappings","metadata":{"seo":{"title":"List all profile mappings","description":"
"}},"httpPath":"/api/v1/mappings"},{"label":"Retrieve a profile mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/profilemapping/other/getprofilemapping","routeSlug":"/openapi/okta-management/management/tags/profilemapping/other/getprofilemapping","metadata":{"seo":{"title":"Retrieve a profile mapping","description":"
"}},"httpPath":"/api/v1/mappings/{mappingId}"},{"label":"Update a profile mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-management/management/tags/profilemapping/other/updateprofilemapping","routeSlug":"/openapi/okta-management/management/tags/profilemapping/other/updateprofilemapping","metadata":{"seo":{"title":"Update a profile mapping","description":"
"}},"httpPath":"/api/v1/mappings/{mappingId}"}],"metadata":{"type":"openapi","title":"Profile Mappings","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://okta-developer.pixtulate.com/docs/reference/okta-expression-language). You can find more information on Okta user and app user profiles in Okta's [User profiles](https://okta-developer.pixtulate.com/docs/concepts/user-profiles/#what-is-the-okta-universal-directory)."}}]}]},{"type":"group","label":"MyAccount Management","items":[{"type":"link","fsPath":"openapi/okta-myaccount/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/okta-myaccount/guides/overview","routeSlug":"/openapi/okta-myaccount/guides/overview"},{"type":"link","label":"MyAccount Management","link":"/openapi/okta-myaccount/myaccount","routeSlug":"/openapi/okta-myaccount/myaccount"},{"type":"group","label":"App Authenticators","link":"/openapi/okta-myaccount/myaccount/appauthenticator","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/appauthenticator/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/api-versioning"},{"label":"Create an App Authenticator Enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/createappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/createappauthenticatorenrollment","metadata":{"seo":{"title":"Create an App Authenticator Enrollment","description":"
"}},"httpPath":"/idp/myaccount/app-authenticators"},{"label":"Verify a Push Notification Challenge Response from the App Authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/verifyappauthenticatorpushnotificationchallenge","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/verifyappauthenticatorpushnotificationchallenge","metadata":{"seo":{"title":"Verify a Push Notification Challenge Response from the App Authenticator","description":"Verifies a push notification challenge from the app authenticator"}},"httpPath":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify"},{"label":"Update an App Authenticator Enrollment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/updateappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/updateappauthenticatorenrollment","metadata":{"seo":{"title":"Update an App Authenticator Enrollment","description":"
"}},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}"},{"label":"Delete an App Authenticator Enrollment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/deleteappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/deleteappauthenticatorenrollment","metadata":{"seo":{"title":"Delete an App Authenticator Enrollment","description":"
"}},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}"},{"label":"List all pending Push Notification Challenges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/listappauthenticatorpendingpushnotificationchallenges","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/listappauthenticatorpendingpushnotificationchallenges","metadata":{"seo":{"title":"List all pending Push Notification Challenges","description":"
"}},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications"},{"type":"link","label":"PushNotificationChallengeRequestJwt","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwt","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwt","httpVerb":"schema"},{"type":"link","label":"PushNotificationChallengeRequestJwtHeader","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwtheader","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwtheader","httpVerb":"schema"},{"type":"link","label":"PushNotificationChallengeResponseJwt","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwt","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwt","httpVerb":"schema"},{"type":"link","label":"PushNotificationChallengeResponseJwtHeader","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwtheader","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwtheader","httpVerb":"schema"}]},{"type":"group","label":"Authenticators","link":"/openapi/okta-myaccount/myaccount/authenticators","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/authenticators/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/api-versioning"},{"label":"List all Authenticators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/listauthenticators","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/listauthenticators","metadata":{"seo":{"title":"List all Authenticators","description":"
"}},"httpPath":"/idp/myaccount/authenticators"},{"label":"Retrieve an Authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/getauthenticator","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/getauthenticator","metadata":{"seo":{"title":"Retrieve an Authenticator","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.myAccount.authenticators.read
"}},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}"},{"label":"List all Enrollments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/listenrollments","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/listenrollments","metadata":{"seo":{"title":"List all Enrollments","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.myAccount.authenticators.read
"}},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments"},{"label":"Retrieve an Enrollment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/getenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/getenrollment","metadata":{"seo":{"title":"Retrieve an Enrollment","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.myAccount.authenticators.read
"}},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}"},{"label":"Update an enrollment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/updateenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/updateenrollment","metadata":{"seo":{"title":"Update an enrollment","description":"
Identity Engine
OAuth 2.0 scope:
  • okta.myAccount.authenticators.manage
"}},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}"}]},{"type":"group","label":"Email","link":"/openapi/okta-myaccount/myaccount/email","routeSlug":"/openapi/okta-myaccount/myaccount/email","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/email/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/email/api-versioning"},{"label":"List all Emails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/listemails","routeSlug":"/openapi/okta-myaccount/myaccount/email/listemails","metadata":{"seo":{"title":"List all Emails","description":"
"}},"httpPath":"/idp/myaccount/emails"},{"label":"Create an Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/createemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/createemail","metadata":{"seo":{"title":"Create an Email","description":"
"}},"httpPath":"/idp/myaccount/emails"},{"label":"Retrieve an Email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/getemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/getemail","metadata":{"seo":{"title":"Retrieve an Email","description":"
"}},"httpPath":"/idp/myaccount/emails/{id}"},{"label":"Delete an Email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/deleteemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/deleteemail","metadata":{"seo":{"title":"Delete an Email","description":"
"}},"httpPath":"/idp/myaccount/emails/{id}"},{"label":"Send an Email Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/sendemailchallenge","routeSlug":"/openapi/okta-myaccount/myaccount/email/sendemailchallenge","metadata":{"seo":{"title":"Send an Email Challenge","description":"
"}},"httpPath":"/idp/myaccount/emails/{id}/challenge"},{"label":"Poll the Challenge for Email Magic Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/pollchallengeforemailmagiclink","routeSlug":"/openapi/okta-myaccount/myaccount/email/pollchallengeforemailmagiclink","metadata":{"seo":{"title":"Poll the Challenge for Email Magic Link","description":"
"}},"httpPath":"/idp/myaccount/emails/{id}/challenge/{challengeId}"},{"label":"Verify an Email OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/verifyemailotp","routeSlug":"/openapi/okta-myaccount/myaccount/email/verifyemailotp","metadata":{"seo":{"title":"Verify an Email OTP","description":"
"}},"httpPath":"/idp/myaccount/emails/{id}/challenge/{challengeId}/verify"}]},{"type":"group","label":"Okta Applications","link":"/openapi/okta-myaccount/myaccount/oktaapplications","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/oktaapplications/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications/api-versioning"},{"label":"List all Okta Apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/oktaapplications/listoktaapplications","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications/listoktaapplications","metadata":{"seo":{"title":"List all Okta Apps","description":"
"}},"httpPath":"/idp/myaccount/okta-applications"}]},{"type":"group","label":"Organization","link":"/openapi/okta-myaccount/myaccount/organization","routeSlug":"/openapi/okta-myaccount/myaccount/organization","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/organization/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/organization/api-versioning"},{"label":"Retrieve the Org Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/organization/getorganization","routeSlug":"/openapi/okta-myaccount/myaccount/organization/getorganization","metadata":{"seo":{"title":"Retrieve the Org Details","description":"
"}},"httpPath":"/idp/myaccount/organization"}]},{"type":"group","label":"Password","link":"/openapi/okta-myaccount/myaccount/password","routeSlug":"/openapi/okta-myaccount/myaccount/password","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/password/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/password/api-versioning"},{"label":"Retrieve a Password","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/getpassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/getpassword","metadata":{"seo":{"title":"Retrieve a Password","description":"
"}},"httpPath":"/idp/myaccount/password"},{"label":"Create a Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/createpassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/createpassword","metadata":{"seo":{"title":"Create a Password","description":"
"}},"httpPath":"/idp/myaccount/password"},{"label":"Replace a Password","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/replacepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/replacepassword","metadata":{"seo":{"title":"Replace a Password","description":"
"}},"httpPath":"/idp/myaccount/password"},{"label":"Delete a Password","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/deletepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/deletepassword","metadata":{"seo":{"title":"Delete a Password","description":"
"}},"httpPath":"/idp/myaccount/password"},{"label":"Update a Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/updatepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/updatepassword","metadata":{"seo":{"title":"Update a Password","description":"
"}},"httpPath":"/idp/myaccount/password/change-password"},{"label":"Retrieve the Password Complexity Requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/getpasswordrequirements","routeSlug":"/openapi/okta-myaccount/myaccount/password/getpasswordrequirements","metadata":{"seo":{"title":"Retrieve the Password Complexity Requirements","description":"
"}},"httpPath":"/idp/myaccount/password/complexity-requirements"}]},{"type":"group","label":"Phone","link":"/openapi/okta-myaccount/myaccount/phone","routeSlug":"/openapi/okta-myaccount/myaccount/phone","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/phone/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/phone/api-versioning"},{"label":"List all Phones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/listphones","routeSlug":"/openapi/okta-myaccount/myaccount/phone/listphones","metadata":{"seo":{"title":"List all Phones","description":"
"}},"httpPath":"/idp/myaccount/phones"},{"label":"Create a Phone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/createphone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/createphone","metadata":{"seo":{"title":"Create a Phone","description":"
"}},"httpPath":"/idp/myaccount/phones"},{"label":"Retrieve a Phone","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/getphone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/getphone","metadata":{"seo":{"title":"Retrieve a Phone","description":"
"}},"httpPath":"/idp/myaccount/phones/{id}"},{"label":"Delete a Phone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/deletephone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/deletephone","metadata":{"seo":{"title":"Delete a Phone","description":"
"}},"httpPath":"/idp/myaccount/phones/{id}"},{"label":"Send a Phone Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/sendphonechallenge","routeSlug":"/openapi/okta-myaccount/myaccount/phone/sendphonechallenge","metadata":{"seo":{"title":"Send a Phone Challenge","description":"
"}},"httpPath":"/idp/myaccount/phones/{id}/challenge"},{"label":"Verify a Phone Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/verifyphonechallenge","routeSlug":"/openapi/okta-myaccount/myaccount/phone/verifyphonechallenge","metadata":{"seo":{"title":"Verify a Phone Challenge","description":"
"}},"httpPath":"/idp/myaccount/phones/{id}/verify"}]},{"type":"group","label":"Profile","link":"/openapi/okta-myaccount/myaccount/profile","routeSlug":"/openapi/okta-myaccount/myaccount/profile","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/profile/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/profile/api-versioning"},{"label":"Retrieve my Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/getprofile","routeSlug":"/openapi/okta-myaccount/myaccount/profile/getprofile","metadata":{"seo":{"title":"Retrieve my Profile","description":"
"}},"httpPath":"/idp/myaccount/profile"},{"label":"Replace my User Profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/replaceprofile","routeSlug":"/openapi/okta-myaccount/myaccount/profile/replaceprofile","metadata":{"seo":{"title":"Replace my User Profile","description":"
"}},"httpPath":"/idp/myaccount/profile"},{"label":"Retrieve my Profile Schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/getprofileschema","routeSlug":"/openapi/okta-myaccount/myaccount/profile/getprofileschema","metadata":{"seo":{"title":"Retrieve my Profile Schema","description":"
"}},"httpPath":"/idp/myaccount/profile/schema"}]},{"type":"group","label":"Sessions","link":"/openapi/okta-myaccount/myaccount/sessions","routeSlug":"/openapi/okta-myaccount/myaccount/sessions","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/sessions/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/sessions/api-versioning"},{"label":"Delete all Sessions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/sessions/deletesessions","routeSlug":"/openapi/okta-myaccount/myaccount/sessions/deletesessions","metadata":{"seo":{"title":"Delete all Sessions","description":"
"}},"httpPath":"/idp/myaccount/sessions"}]},{"type":"group","label":"WebAuthn","link":"/openapi/okta-myaccount/myaccount/webauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/webauthn/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/api-versioning"},{"label":"List all WebAuthn enrollments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/listwebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/listwebauthn","metadata":{"seo":{"title":"List all WebAuthn enrollments","description":"
"}},"httpPath":"/idp/myaccount/webauthn"},{"label":"Create a WebAuthn enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/createwebauthnenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/createwebauthnenrollment","metadata":{"seo":{"title":"Create a WebAuthn enrollment","description":"
"}},"httpPath":"/idp/myaccount/webauthn"},{"label":"Start a WebAuthn enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/startwebauthnenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/startwebauthnenrollment","metadata":{"seo":{"title":"Start a WebAuthn enrollment","description":"
"}},"httpPath":"/idp/myaccount/webauthn/registration"},{"label":"Retrieve a WebAuthn enrollment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/getwebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/getwebauthn","metadata":{"seo":{"title":"Retrieve a WebAuthn enrollment","description":"
"}},"httpPath":"/idp/myaccount/webauthn/{id}"},{"label":"Delete a WebAuthn enrollment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/deletewebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/deletewebauthn","metadata":{"seo":{"title":"Delete a WebAuthn enrollment","description":"
"}},"httpPath":"/idp/myaccount/webauthn/{id}"}]},{"label":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeid}~1verify/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeid}~1verify/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify"}},"httpPath":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify"},{"label":"/idp/myaccount/authenticators","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1authenticators/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1authenticators/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/authenticators"}},"httpPath":"/idp/myaccount/authenticators"},{"label":"/idp/myaccount/okta-applications","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1okta-applications/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1okta-applications/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/okta-applications"}},"httpPath":"/idp/myaccount/okta-applications"},{"label":"/idp/myaccount/organization","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1organization/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1organization/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/organization"}},"httpPath":"/idp/myaccount/organization"},{"label":"/idp/myaccount/password/change-password","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1password~1change-password/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1password~1change-password/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/password/change-password"}},"httpPath":"/idp/myaccount/password/change-password"},{"label":"/idp/myaccount/password/complexity-requirements","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1password~1complexity-requirements/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1password~1complexity-requirements/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/password/complexity-requirements"}},"httpPath":"/idp/myaccount/password/complexity-requirements"},{"label":"/idp/myaccount/sessions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1sessions/x-okta-lifecycle","routeSlug":"/openapi/okta-myaccount/myaccount/paths/~1idp~1myaccount~1sessions/x-okta-lifecycle","metadata":{"seo":{"title":"/idp/myaccount/sessions"}},"httpPath":"/idp/myaccount/sessions"}]},{"type":"group","label":"Sign-in Experience Management","items":[{"type":"link","fsPath":"openapi/okta-signin-experience-management/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/okta-signin-experience-management/guides/overview","routeSlug":"/openapi/okta-signin-experience-management/guides/overview"},{"type":"link","label":"Sign-in Experience Management","link":"/openapi/okta-signin-experience-management/signin-experience","routeSlug":"/openapi/okta-signin-experience-management/signin-experience"},{"type":"group","label":"End-user Enrollments","link":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments","routeSlug":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments","items":[{"label":"Enroll an authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments/enrollauthenticator","routeSlug":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments/enrollauthenticator","metadata":{"seo":{"title":"Enroll an authenticator","description":"
Identity Engine
"}},"httpPath":"/idp/bootstrap/enroll-authenticator/{authenticatorId}"},{"label":"Unenroll an authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments/unenrollauthenticator","routeSlug":"/openapi/okta-signin-experience-management/signin-experience/enduserenrollments/unenrollauthenticator","metadata":{"seo":{"title":"Unenroll an authenticator","description":"
Identity Engine
"}},"httpPath":"/idp/bootstrap/unenroll-authenticator/{enrollmentId}"}]}]},{"type":"group","label":"Okta Aerial","items":[{"type":"link","fsPath":"openapi/aerial/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/aerial/guides/overview","routeSlug":"/openapi/aerial/guides/overview"},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/release-notes/2026-okta-aerial/","label":"Changelog","external":true},{"type":"link","label":"Okta Aerial","link":"/openapi/aerial/aerial","routeSlug":"/openapi/aerial/aerial"},{"type":"group","label":"Account","link":"/openapi/aerial/aerial/account","routeSlug":"/openapi/aerial/aerial/account","items":[{"label":"Retrieve an Aerial account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/account/getaccount","routeSlug":"/openapi/aerial/aerial/account/getaccount","metadata":{"seo":{"title":"Retrieve an Aerial account","description":"
"}},"httpPath":"/{accountId}/api/v1/accounts"},{"label":"Replace an Aerial account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/account/putaccount","routeSlug":"/openapi/aerial/aerial/account/putaccount","metadata":{"seo":{"title":"Replace an Aerial account","description":"
"}},"httpPath":"/{accountId}/api/v1/accounts"},{"label":"List all subscribed products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/account/getsubscribedproducts","routeSlug":"/openapi/aerial/aerial/account/getsubscribedproducts","metadata":{"seo":{"title":"List all subscribed products","description":"
"}},"httpPath":"/{accountId}/api/v1/products"}]},{"type":"group","label":"Orgs","link":"/openapi/aerial/aerial/orgs","routeSlug":"/openapi/aerial/aerial/orgs","items":[{"label":"Requests to delete an org","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/createdeletionrequest","routeSlug":"/openapi/aerial/aerial/orgs/createdeletionrequest","metadata":{"seo":{"title":"Requests to delete an org","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs/{orgId}/deletionRequest"},{"label":"Change the status of an org","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/changeorgstatus","routeSlug":"/openapi/aerial/aerial/orgs/changeorgstatus","metadata":{"seo":{"title":"Change the status of an org","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs/{orgId}/status"},{"label":"List all managed orgs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/getorgs","routeSlug":"/openapi/aerial/aerial/orgs/getorgs","metadata":{"seo":{"title":"List all managed orgs","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs"},{"label":"Add an org to your account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/addorg","routeSlug":"/openapi/aerial/aerial/orgs/addorg","metadata":{"seo":{"title":"Add an org to your account","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs"},{"label":"List all associated orgs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/getassociatedorgs","routeSlug":"/openapi/aerial/aerial/orgs/getassociatedorgs","metadata":{"seo":{"title":"List all associated orgs","description":"
"}},"httpPath":"/{accountId}/api/v1/reports/associatedOrgs"},{"label":"Retrieve an org","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/getorg","routeSlug":"/openapi/aerial/aerial/orgs/getorg","metadata":{"seo":{"title":"Retrieve an org","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs/{orgId}"},{"label":"List all enabled products for an org","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/getenabledproducts","routeSlug":"/openapi/aerial/aerial/orgs/getenabledproducts","metadata":{"seo":{"title":"List all enabled products for an org","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs/{orgId}/products"},{"label":"Update enabled products for an org","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/orgs/updateenabledproducts","routeSlug":"/openapi/aerial/aerial/orgs/updateenabledproducts","metadata":{"seo":{"title":"Update enabled products for an org","description":"
"}},"httpPath":"/{accountId}/api/v1/orgs/{orgId}/products"}]},{"type":"group","label":"Org Groups","link":"/openapi/aerial/aerial/org-groups","routeSlug":"/openapi/aerial/aerial/org-groups","items":[{"label":"List all org groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/getorggroups","routeSlug":"/openapi/aerial/aerial/org-groups/getorggroups","metadata":{"seo":{"title":"List all org groups","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups"},{"label":"Create an org group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/createorggroup","routeSlug":"/openapi/aerial/aerial/org-groups/createorggroup","metadata":{"seo":{"title":"Create an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups"},{"label":"Retrieve an org group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/getorggroup","routeSlug":"/openapi/aerial/aerial/org-groups/getorggroup","metadata":{"seo":{"title":"Retrieve an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}"},{"label":"Update an org group metadata","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/updateorggroup","routeSlug":"/openapi/aerial/aerial/org-groups/updateorggroup","metadata":{"seo":{"title":"Update an org group metadata","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}"},{"label":"Delete an org group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/deleteorggroup","routeSlug":"/openapi/aerial/aerial/org-groups/deleteorggroup","metadata":{"seo":{"title":"Delete an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}"},{"label":"List all orgs in an org group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/getorggrouporgmembers","routeSlug":"/openapi/aerial/aerial/org-groups/getorggrouporgmembers","metadata":{"seo":{"title":"List all orgs in an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}/orgs"},{"label":"Add an org to an org group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/addorgmember","routeSlug":"/openapi/aerial/aerial/org-groups/addorgmember","metadata":{"seo":{"title":"Add an org to an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}/orgs"},{"label":"Delete an org from an org group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/org-groups/deleteorgmember","routeSlug":"/openapi/aerial/aerial/org-groups/deleteorgmember","metadata":{"seo":{"title":"Delete an org from an org group","description":"
"}},"httpPath":"/{accountId}/api/v1/orgGroups/{groupId}/orgs"}]},{"type":"group","label":"Governance","link":"/openapi/aerial/aerial/governance","routeSlug":"/openapi/aerial/aerial/governance","items":[{"label":"List access request condition templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/getrequestconditiontemplates","routeSlug":"/openapi/aerial/aerial/governance/getrequestconditiontemplates","metadata":{"seo":{"title":"List access request condition templates","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates"},{"label":"Create an access request condition template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/createrequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/createrequestconditiontemplate","metadata":{"seo":{"title":"Create an access request condition template","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates"},{"label":"Retrieve an access request condition template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/getrequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/getrequestconditiontemplate","metadata":{"seo":{"title":"Retrieve an access request condition template","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates/{templateId}"},{"label":"Partially update an access request condition template","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/patchrequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/patchrequestconditiontemplate","metadata":{"seo":{"title":"Partially update an access request condition template","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates/{templateId}"},{"label":"Delete an access request condition template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/deleterequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/deleterequestconditiontemplate","metadata":{"seo":{"title":"Delete an access request condition template","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates/{templateId}"},{"label":"Apply an access request condition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/applyrequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/applyrequestconditiontemplate","metadata":{"seo":{"title":"Apply an access request condition","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates/{templateId}/apply"},{"label":"Remove an access request condition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/aerial/aerial/governance/removerequestconditiontemplate","routeSlug":"/openapi/aerial/aerial/governance/removerequestconditiontemplate","metadata":{"seo":{"title":"Remove an access request condition","description":"
"}},"httpPath":"/{accountId}/governance/api/v1/request-condition-templates/{templateId}/remove"}]}]},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/api/event-types/","label":"Event Types","external":true},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/error-codes/","label":"Error Codes","external":true},{"type":"link","link":"https://okta-developer.pixtulate.com/docs/reference/rate-limits/","label":"Rate Limits","external":true},{"type":"group","label":"Okta Privileged Access","items":[{"type":"link","fsPath":"openapi/opa/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/opa","routeSlug":"/openapi/opa"},{"type":"link","link":"https://www.postman.com/okta-eng/workspace/okta-public-api-collections/collection/26001419-9bc95911-6e9d-4e2c-b2c2-b19b3538fa22","label":"Postman Collection"},{"type":"link","label":"Okta Privileged Access","link":"/openapi/opa/opa","routeSlug":"/openapi/opa/opa"},{"type":"group","label":"Active Directory Accounts","link":"/openapi/opa/opa/active-directory-accounts","routeSlug":"/openapi/opa/opa/active-directory-accounts","items":[{"label":"List all Active Directory domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listactivedirectorydomains","routeSlug":"/openapi/opa/opa/active-directory-accounts/listactivedirectorydomains","metadata":{"seo":{"title":"List all Active Directory domains","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory"},{"label":"Retrieve an Active Directory connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectorydomainenduser","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectorydomainenduser","metadata":{"seo":{"title":"Retrieve an Active Directory connection","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}"},{"label":"List all Active Directory accounts within a connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountsenduser","routeSlug":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountsenduser","metadata":{"seo":{"title":"List all Active Directory accounts within a connection","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts"},{"label":"Retrieve an Active Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountenduser","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountenduser","metadata":{"seo":{"title":"Retrieve an Active Directory account","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}"},{"label":"List credential versions for an Active Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountcredentialversions","routeSlug":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountcredentialversions","metadata":{"seo":{"title":"List credential versions for an Active Directory account","description":"
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/credentials/versions"},{"label":"Reveal the password for an Active Directory account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/revealactivedirectoryaccountpassword","routeSlug":"/openapi/opa/opa/active-directory-accounts/revealactivedirectoryaccountpassword","metadata":{"seo":{"title":"Reveal the password for an Active Directory account","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/reveal_credentials"},{"label":"Rotate the password for Active Directory account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/rotateactivedirectoryaccountpassword","routeSlug":"/openapi/opa/opa/active-directory-accounts/rotateactivedirectoryaccountpassword","metadata":{"seo":{"title":"Rotate the password for Active Directory account","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/rotate_password"},{"label":"List all user access methods for an Active Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listuamforactivedirectoryaccount","routeSlug":"/openapi/opa/opa/active-directory-accounts/listuamforactivedirectoryaccount","metadata":{"seo":{"title":"List all user access methods for an Active Directory account","description":"
Early Access
OPA roles:
  • end_user
"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/user_access_methods"},{"label":"List all Active Directory accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listallactivedirectoryaccountsforsecurityadmin","routeSlug":"/openapi/opa/opa/active-directory-accounts/listallactivedirectoryaccountsforsecurityadmin","metadata":{"seo":{"title":"List all Active Directory accounts","description":"
Early Access
OPA roles:
  • security_admin
"}},"httpPath":"/v1/teams/{team_name}/all_active_directory_accounts"},{"label":"List all discovered Active Directory accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccounts","routeSlug":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccounts","metadata":{"seo":{"title":"List all discovered Active Directory accounts","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/accounts"},{"label":"Retrieve a discovered Active Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccount","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccount","metadata":{"seo":{"title":"Retrieve a discovered Active Directory account","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/accounts/{ad_account_id}"},{"label":"Retrieve an Active Directory account match","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountmatch","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountmatch","metadata":{"seo":{"title":"Retrieve an Active Directory account match","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/accounts/{ad_account_id}/match"},{"label":"Update an Active Directory account match","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/updateactivedirectoryaccountmatch","routeSlug":"/openapi/opa/opa/active-directory-accounts/updateactivedirectoryaccountmatch","metadata":{"seo":{"title":"Update an Active Directory account match","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/accounts/{ad_account_id}/match"},{"label":"Retrieve the Active Directory account rule settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountrulesettings","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountrulesettings","metadata":{"seo":{"title":"Retrieve the Active Directory account rule settings","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rule_settings"},{"label":"Configure the Active Directory account rule settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/configureactivedirectoryaccountrulesettings","routeSlug":"/openapi/opa/opa/active-directory-accounts/configureactivedirectoryaccountrulesettings","metadata":{"seo":{"title":"Configure the Active Directory account rule settings","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rule_settings"},{"label":"List all Active Directory account rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountrules","routeSlug":"/openapi/opa/opa/active-directory-accounts/listactivedirectoryaccountrules","metadata":{"seo":{"title":"List all Active Directory account rules","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules"},{"label":"Create an Active Directory account rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/createactivedirectoryaccountrule","routeSlug":"/openapi/opa/opa/active-directory-accounts/createactivedirectoryaccountrule","metadata":{"seo":{"title":"Create an Active Directory account rule","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules"},{"label":"Set the priority of Active Directory account rules","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/reorderactivedirectoryaccountrules","routeSlug":"/openapi/opa/opa/active-directory-accounts/reorderactivedirectoryaccountrules","metadata":{"seo":{"title":"Set the priority of Active Directory account rules","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules/reorder"},{"label":"Retrieve an Active Directory account rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountrule","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountrule","metadata":{"seo":{"title":"Retrieve an Active Directory account rule","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules/{ad_account_rule_id}"},{"label":"Update an Active Directory account rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/updateactivedirectoryaccountrule","routeSlug":"/openapi/opa/opa/active-directory-accounts/updateactivedirectoryaccountrule","metadata":{"seo":{"title":"Update an Active Directory account rule","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules/{ad_account_rule_id}"},{"label":"Delete an Active Directory account rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/deleteactivedirectoryaccountrule","routeSlug":"/openapi/opa/opa/active-directory-accounts/deleteactivedirectoryaccountrule","metadata":{"seo":{"title":"Delete an Active Directory account rule","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/rules/{ad_account_rule_id}"},{"label":"Retrieve the Active Directory account sync status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountsyncstatus","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountsyncstatus","metadata":{"seo":{"title":"Retrieve the Active Directory account sync status","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/sync_status"},{"label":"List all Active Directory accounts in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/listallactivedirectoryaccountsfordelegatedsecurityadmin","routeSlug":"/openapi/opa/opa/active-directory-accounts/listallactivedirectoryaccountsfordelegatedsecurityadmin","metadata":{"seo":{"title":"List all Active Directory accounts in a resource group","description":"
Early Access
OPA roles:
  • security_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_active_directory_accounts"},{"label":"Retrieve an Active Directory account in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountdetails","routeSlug":"/openapi/opa/opa/active-directory-accounts/getactivedirectoryaccountdetails","metadata":{"seo":{"title":"Retrieve an Active Directory account in a resource group","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
  • delegated_resource_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_accounts/{ad_account_id}"}]},{"type":"group","label":"Active Directory Connections","link":"/openapi/opa/opa/active-directory-connections","routeSlug":"/openapi/opa/opa/active-directory-connections","items":[{"label":"List all Active Directory connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-connections/listactivedirectoryconnections","routeSlug":"/openapi/opa/opa/active-directory-connections/listactivedirectoryconnections","metadata":{"seo":{"title":"List all Active Directory connections","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
"}},"httpPath":"/v1/teams/{team_name}/connections/active_directory"},{"label":"Retrieve an Active Directory connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-connections/getactivedirectoryconnection","routeSlug":"/openapi/opa/opa/active-directory-connections/getactivedirectoryconnection","metadata":{"seo":{"title":"Retrieve an Active Directory connection","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
"}},"httpPath":"/v1/teams/{team_name}/connections/active_directory/{ad_connection_id}"},{"label":"Update the status of an Active Directory connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-connections/updateactivedirectoryconnectionstatus","routeSlug":"/openapi/opa/opa/active-directory-connections/updateactivedirectoryconnectionstatus","metadata":{"seo":{"title":"Update the status of an Active Directory connection","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/connections/active_directory/{ad_connection_id}/status"},{"label":"Start Active Directory account force sync","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/active-directory-connections/startactivedirectoryaccountforcesync","routeSlug":"/openapi/opa/opa/active-directory-connections/startactivedirectoryaccountforcesync","metadata":{"seo":{"title":"Start Active Directory account force sync","description":"
Early Access
OPA roles:
  • resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/active_directory/{ad_connection_id}/force_sync"}]},{"type":"group","label":"Attributes","link":"/openapi/opa/opa/attributes","routeSlug":"/openapi/opa/opa/attributes","items":[{"label":"List all attribute conflicts for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/listteamuserattributeconflicts","routeSlug":"/openapi/opa/opa/attributes/listteamuserattributeconflicts","metadata":{"seo":{"title":"List all attribute conflicts for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/attributes/conflicts"},{"label":"List all attribute options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/listattributeoptions","routeSlug":"/openapi/opa/opa/attributes/listattributeoptions","metadata":{"seo":{"title":"List all attribute options","description":"
"}},"httpPath":"/v1/teams/{team_name}/attributes/options"},{"label":"Retrieve an attribute option","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/fetchattributeoption","routeSlug":"/openapi/opa/opa/attributes/fetchattributeoption","metadata":{"seo":{"title":"Retrieve an attribute option","description":"
"}},"httpPath":"/v1/teams/{team_name}/attributes/options/{namespace}/{attribute_name}"},{"label":"Upsert an attribute option","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/upsertattributeoption","routeSlug":"/openapi/opa/opa/attributes/upsertattributeoption","metadata":{"seo":{"title":"Upsert an attribute option","description":"
"}},"httpPath":"/v1/teams/{team_name}/attributes/options/{namespace}/{attribute_name}"},{"label":"Delete an attribute option","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/deleteattributeoption","routeSlug":"/openapi/opa/opa/attributes/deleteattributeoption","metadata":{"seo":{"title":"Delete an attribute option","description":"
"}},"httpPath":"/v1/teams/{team_name}/attributes/options/{namespace}/{attribute_name}"},{"label":"List all attributes for a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/listgroupattributes","routeSlug":"/openapi/opa/opa/attributes/listgroupattributes","metadata":{"seo":{"title":"List all attributes for a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes"},{"label":"Retrieve a group attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/fetchgroupattribute","routeSlug":"/openapi/opa/opa/attributes/fetchgroupattribute","metadata":{"seo":{"title":"Retrieve a group attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}"},{"label":"Update a group attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/updategroupattribute","routeSlug":"/openapi/opa/opa/attributes/updategroupattribute","metadata":{"seo":{"title":"Update a group attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}"},{"label":"List all attributes for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/listuserattributes","routeSlug":"/openapi/opa/opa/attributes/listuserattributes","metadata":{"seo":{"title":"List all attributes for a user","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes"},{"label":"Retrieve a user attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/fetchuserattribute","routeSlug":"/openapi/opa/opa/attributes/fetchuserattribute","metadata":{"seo":{"title":"Retrieve a user attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}"},{"label":"Update a user attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/attributes/updateuserattribute","routeSlug":"/openapi/opa/opa/attributes/updateuserattribute","metadata":{"seo":{"title":"Update a user attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}"}]},{"type":"group","label":"Clients","link":"/openapi/opa/opa/clients","routeSlug":"/openapi/opa/opa/clients","items":[{"label":"List all clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/clients/listclients","routeSlug":"/openapi/opa/opa/clients/listclients","metadata":{"seo":{"title":"List all clients","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients"},{"label":"Retrieve a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/clients/fetchclient","routeSlug":"/openapi/opa/opa/clients/fetchclient","metadata":{"seo":{"title":"Retrieve a client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"},{"label":"Update a client","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/clients/updateclient","routeSlug":"/openapi/opa/opa/clients/updateclient","metadata":{"seo":{"title":"Update a client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"},{"label":"Revoke access to a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/clients/removeclient","routeSlug":"/openapi/opa/opa/clients/removeclient","metadata":{"seo":{"title":"Revoke access to a client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"}]},{"type":"group","label":"Database Accounts","link":"/openapi/opa/opa/database-accounts","routeSlug":"/openapi/opa/opa/database-accounts","items":[{"label":"List all discovered database accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/listdatabaseaccounts","routeSlug":"/openapi/opa/opa/database-accounts/listdatabaseaccounts","metadata":{"seo":{"title":"List all discovered database accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts"},{"label":"Retrieve a discovered database account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/getdatabaseaccountbyconnection","routeSlug":"/openapi/opa/opa/database-accounts/getdatabaseaccountbyconnection","metadata":{"seo":{"title":"Retrieve a discovered database account","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts/{database_account_id}"},{"label":"List all database account rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/listdatabaseaccountrules","routeSlug":"/openapi/opa/opa/database-accounts/listdatabaseaccountrules","metadata":{"seo":{"title":"List all database account rules","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules"},{"label":"Create a new database account rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/createdatabaseaccountrule","routeSlug":"/openapi/opa/opa/database-accounts/createdatabaseaccountrule","metadata":{"seo":{"title":"Create a new database account rule","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules"},{"label":"Retrieve a database account rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/getdatabaseaccountrule","routeSlug":"/openapi/opa/opa/database-accounts/getdatabaseaccountrule","metadata":{"seo":{"title":"Retrieve a database account rule","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}"},{"label":"Update a database account rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/updatedatabaseaccountrule","routeSlug":"/openapi/opa/opa/database-accounts/updatedatabaseaccountrule","metadata":{"seo":{"title":"Update a database account rule","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}"},{"label":"Delete a database account rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/deletedatabaseaccountrule","routeSlug":"/openapi/opa/opa/database-accounts/deletedatabaseaccountrule","metadata":{"seo":{"title":"Delete a database account rule","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}"},{"label":"List all database accounts within a connection for end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/listdatabaseaccountsenduser","routeSlug":"/openapi/opa/opa/database-accounts/listdatabaseaccountsenduser","metadata":{"seo":{"title":"List all database accounts within a connection for end user","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts"},{"label":"Retrieve a database account for the end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/getdatabaseaccountenduser","routeSlug":"/openapi/opa/opa/database-accounts/getdatabaseaccountenduser","metadata":{"seo":{"title":"Retrieve a database account for the end user","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}"},{"label":"Reveal the credentials for a database account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/revealdatabaseaccountcredentials","routeSlug":"/openapi/opa/opa/database-accounts/revealdatabaseaccountcredentials","metadata":{"seo":{"title":"Reveal the credentials for a database account","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/reveal_credentials"},{"label":"List all user access methods for a database account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/listuamfordatabaseaccount","routeSlug":"/openapi/opa/opa/database-accounts/listuamfordatabaseaccount","metadata":{"seo":{"title":"List all user access methods for a database account","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/user_access_methods"},{"label":"Retrieve a database account in a resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-accounts/getdatabaseaccountdetails","routeSlug":"/openapi/opa/opa/database-accounts/getdatabaseaccountdetails","metadata":{"seo":{"title":"Retrieve a database account in a resource group project","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
  • delegated_resource_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts/{database_account_id}"}]},{"type":"group","label":"Database Connections","link":"/openapi/opa/opa/database-connections","routeSlug":"/openapi/opa/opa/database-connections","items":[{"label":"List all database connections for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/listdatabaseconnections","routeSlug":"/openapi/opa/opa/database-connections/listdatabaseconnections","metadata":{"seo":{"title":"List all database connections for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases"},{"label":"Create a new database connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/createdatabaseconnection","routeSlug":"/openapi/opa/opa/database-connections/createdatabaseconnection","metadata":{"seo":{"title":"Create a new database connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases"},{"label":"Retrieve a database connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/getdatabaseconnection","routeSlug":"/openapi/opa/opa/database-connections/getdatabaseconnection","metadata":{"seo":{"title":"Retrieve a database connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}"},{"label":"Update a database connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/updatedatabaseconnection","routeSlug":"/openapi/opa/opa/database-connections/updatedatabaseconnection","metadata":{"seo":{"title":"Update a database connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}"},{"label":"Delete a database connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/deletedatabaseconnection","routeSlug":"/openapi/opa/opa/database-connections/deletedatabaseconnection","metadata":{"seo":{"title":"Delete a database connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}"},{"label":"Start database account force sync","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/startdatabaseaccountforcesync","routeSlug":"/openapi/opa/opa/database-connections/startdatabaseaccountforcesync","metadata":{"seo":{"title":"Start database account force sync","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/force_sync"},{"label":"Retrieve the database account sync status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/getdatabaseaccountsyncstatus","routeSlug":"/openapi/opa/opa/database-connections/getdatabaseaccountsyncstatus","metadata":{"seo":{"title":"Retrieve the database account sync status","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/sync_status"},{"label":"List all database connections for the end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/listdatabaseconnectionsenduser","routeSlug":"/openapi/opa/opa/database-connections/listdatabaseconnectionsenduser","metadata":{"seo":{"title":"List all database connections for the end user","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases"},{"label":"Retrieve a database connection for the end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/database-connections/getdatabaseconnectionenduser","routeSlug":"/openapi/opa/opa/database-connections/getdatabaseconnectionenduser","metadata":{"seo":{"title":"Retrieve a database connection for the end user","description":"
"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}"}]},{"type":"group","label":"Gateways","link":"/openapi/opa/opa/gateways","routeSlug":"/openapi/opa/opa/gateways","items":[{"label":"List all gateway setup tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/listgatewaysetuptokens","routeSlug":"/openapi/opa/opa/gateways/listgatewaysetuptokens","metadata":{"seo":{"title":"List all gateway setup tokens","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens"},{"label":"Create a gateway setup token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/creategatewaysetuptoken","routeSlug":"/openapi/opa/opa/gateways/creategatewaysetuptoken","metadata":{"seo":{"title":"Create a gateway setup token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens"},{"label":"Retrieve a gateway setup token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/fetchgatewaysetuptoken","routeSlug":"/openapi/opa/opa/gateways/fetchgatewaysetuptoken","metadata":{"seo":{"title":"Retrieve a gateway setup token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}"},{"label":"Delete a gateway setup token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/deletegatewaysetuptoken","routeSlug":"/openapi/opa/opa/gateways/deletegatewaysetuptoken","metadata":{"seo":{"title":"Delete a gateway setup token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}"},{"label":"Retrieve a gateway setup token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/fetchgatewaysetuptokenasagenttoken","routeSlug":"/openapi/opa/opa/gateways/fetchgatewaysetuptokenasagenttoken","metadata":{"seo":{"title":"Retrieve a gateway setup token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}/token"},{"label":"List all gateways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/listgateways","routeSlug":"/openapi/opa/opa/gateways/listgateways","metadata":{"seo":{"title":"List all gateways","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways"},{"label":"Retrieve a gateway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/getgatewayinstance","routeSlug":"/openapi/opa/opa/gateways/getgatewayinstance","metadata":{"seo":{"title":"Retrieve a gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Update a gateway","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/updategatewayinstance","routeSlug":"/openapi/opa/opa/gateways/updategatewayinstance","metadata":{"seo":{"title":"Update a gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Delete a gateway","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/deletegatewayinstance","routeSlug":"/openapi/opa/opa/gateways/deletegatewayinstance","metadata":{"seo":{"title":"Delete a gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Retrieve a status report for a gateway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/gateways/getgatewaystatusreport","routeSlug":"/openapi/opa/opa/gateways/getgatewaystatusreport","metadata":{"seo":{"title":"Retrieve a status report for a gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}/status"}]},{"type":"group","label":"Groups","link":"/openapi/opa/opa/groups","routeSlug":"/openapi/opa/opa/groups","items":[{"label":"List all groups for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/listgroups","routeSlug":"/openapi/opa/opa/groups/listgroups","metadata":{"seo":{"title":"List all groups for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups"},{"label":"Create a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/creategroup","routeSlug":"/openapi/opa/opa/groups/creategroup","metadata":{"seo":{"title":"Create a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups"},{"label":"Retrieve a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/getgroup","routeSlug":"/openapi/opa/opa/groups/getgroup","metadata":{"seo":{"title":"Retrieve a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"Update a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/updategroup","routeSlug":"/openapi/opa/opa/groups/updategroup","metadata":{"seo":{"title":"Update a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"Delete a group from a team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/removegroup","routeSlug":"/openapi/opa/opa/groups/removegroup","metadata":{"seo":{"title":"Delete a group from a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"List all users for a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/listusersingroup","routeSlug":"/openapi/opa/opa/groups/listusersingroup","metadata":{"seo":{"title":"List all users for a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users"},{"label":"Add a user to a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/addusertogroup","routeSlug":"/openapi/opa/opa/groups/addusertogroup","metadata":{"seo":{"title":"Add a user to a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users"},{"label":"Remove a user from a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/groups/removeuserfromgroup","routeSlug":"/openapi/opa/opa/groups/removeuserfromgroup","metadata":{"seo":{"title":"Remove a user from a group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users/{user_name}"}]},{"type":"group","label":"Infrastructure Orchestrators","link":"/openapi/opa/opa/infrastructure-orchestrators","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators","items":[{"label":"Retrieve an orchestrator configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/infrastructure-orchestrators/getorchestratorconfig","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators/getorchestratorconfig","metadata":{"seo":{"title":"Retrieve an orchestrator configuration","description":"Retrieves the orchestrator configuration for a gateway. This endpoint is called by gateway agents to obtain orchestrator connection details."}},"httpPath":"/v1/gateways/orchestrator-config"},{"label":"List all infrastructure orchestrators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestrators","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestrators","metadata":{"seo":{"title":"List all infrastructure orchestrators","description":"
"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators"},{"label":"Retrieve an infrastructure orchestrator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/infrastructure-orchestrators/getinfrastructureorchestrator","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators/getinfrastructureorchestrator","metadata":{"seo":{"title":"Retrieve an infrastructure orchestrator","description":"
"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}"},{"label":"List gateways for an infrastructure orchestrator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestratorgateways","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestratorgateways","metadata":{"seo":{"title":"List gateways for an infrastructure orchestrator","description":"
"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/gateways"},{"label":"List integrations for an infrastructure orchestrator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestratorintegrations","routeSlug":"/openapi/opa/opa/infrastructure-orchestrators/listinfrastructureorchestratorintegrations","metadata":{"seo":{"title":"List integrations for an infrastructure orchestrator","description":"
"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/integrations"}]},{"type":"group","label":"MFA Approvals","link":"/openapi/opa/opa/mfa-approvals","routeSlug":"/openapi/opa/opa/mfa-approvals","items":[{"label":"Create an MFA approval","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/mfa-approvals/createmfaapproval","routeSlug":"/openapi/opa/opa/mfa-approvals/createmfaapproval","metadata":{"seo":{"title":"Create an MFA approval","description":"Creates an MFA approval"}},"httpPath":"/v1/teams/{team_name}/mfa_approvals"}]},{"type":"group","label":"Okta Universal Directory Accounts","link":"/openapi/opa/opa/okta-universal-directory-accounts","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts","items":[{"label":"List all Universal Directory accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listalloktauniversaldirectoryaccountsforsecurityadmin","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listalloktauniversaldirectoryaccountsforsecurityadmin","metadata":{"seo":{"title":"List all Universal Directory accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/all_okta_universal_directory_accounts"},{"label":"List all accessible Universal Directory service accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listoktaudserviceaccountsenduser","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listoktaudserviceaccountsenduser","metadata":{"seo":{"title":"List all accessible Universal Directory service accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts"},{"label":"List credential versions for a Universal Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listoktauniversaldirectoryaccountcredentialversions","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listoktauniversaldirectoryaccountcredentialversions","metadata":{"seo":{"title":"List credential versions for a Universal Directory account","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/credentials/versions"},{"label":"Reveal the password for Universal Directory account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/revealoktauniversaldirectoryaccountpassword","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/revealoktauniversaldirectoryaccountpassword","metadata":{"seo":{"title":"Reveal the password for Universal Directory account","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/reveal_credentials"},{"label":"Rotate a Universal Directory account password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/oktaudaccountrotatepassword","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/oktaudaccountrotatepassword","metadata":{"seo":{"title":"Rotate a Universal Directory account password","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/rotate_password"},{"label":"List the Universal Directory account user access methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listuamforoktaudaccount","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listuamforoktaudaccount","metadata":{"seo":{"title":"List the Universal Directory account user access methods","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/user_access_methods"},{"label":"List all Universal Directory account in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listalloktauniversaldirectoryaccountsfordelegatedsecurityadmin","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listalloktauniversaldirectoryaccountsfordelegatedsecurityadmin","metadata":{"seo":{"title":"List all Universal Directory account in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_okta_universal_directory_accounts"},{"label":"List all Universal Directory accounts in a resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/listresourcegroupprojectoktauniversaldirectoryaccounts","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/listresourcegroupprojectoktauniversaldirectoryaccounts","metadata":{"seo":{"title":"List all Universal Directory accounts in a resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_accounts"},{"label":"Retrieve a Universal Directory account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/okta-universal-directory-accounts/getoktauniversaldirectoryaccountdetails","routeSlug":"/openapi/opa/opa/okta-universal-directory-accounts/getoktauniversaldirectoryaccountdetails","metadata":{"seo":{"title":"Retrieve a Universal Directory account","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_accounts/{okta_universal_directory_account_id}"}]},{"type":"group","label":"Projects","link":"/openapi/opa/opa/projects","routeSlug":"/openapi/opa/opa/projects","items":[{"label":"List all projects in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listresourcegroupprojects","routeSlug":"/openapi/opa/opa/projects/listresourcegroupprojects","metadata":{"seo":{"title":"List all projects in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects"},{"label":"Create a project in a resource group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/createresourcegroupproject","routeSlug":"/openapi/opa/opa/projects/createresourcegroupproject","metadata":{"seo":{"title":"Create a project in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects"},{"label":"Retrieve a project from a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupproject","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupproject","metadata":{"seo":{"title":"Retrieve a project from a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}"},{"label":"Update a project in a resource group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupproject","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupproject","metadata":{"seo":{"title":"Update a project in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}"},{"label":"Delete a project from a resource group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/removeresourcegroupproject","routeSlug":"/openapi/opa/opa/projects/removeresourcegroupproject","metadata":{"seo":{"title":"Delete a project from a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}"},{"label":"List all Active Directory accounts in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listresourcegroupprojectactivedirectoryaccounts","routeSlug":"/openapi/opa/opa/projects/listresourcegroupprojectactivedirectoryaccounts","metadata":{"seo":{"title":"List all Active Directory accounts in a project","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
  • delegated_resource_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_accounts"},{"label":"Retrieve the checkout settings for an Active Directory account resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupactivedirectorybasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupactivedirectorybasedprojectcheckoutsettings","metadata":{"seo":{"title":"Retrieve the checkout settings for an Active Directory account resource group project","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
  • delegated_resource_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_checkout_settings"},{"label":"Update the checkout settings for an Active Directory account resource group project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupactivedirectorybasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupactivedirectorybasedprojectcheckoutsettings","metadata":{"seo":{"title":"Update the checkout settings for an Active Directory account resource group project","description":"
Early Access
OPA roles:
  • security_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_checkout_settings"},{"label":"Retrieve a project password policy for Active Directory resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getprojectpasswordpolicyforactivedirectoryresources","routeSlug":"/openapi/opa/opa/projects/getprojectpasswordpolicyforactivedirectoryresources","metadata":{"seo":{"title":"Retrieve a project password policy for Active Directory resources","description":"
Early Access
OPA roles:
  • resource_admin
  • delegated_resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_password_settings"},{"label":"Update a project password policy for Active Directory resources","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforactivedirectoryresources","routeSlug":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforactivedirectoryresources","metadata":{"seo":{"title":"Update a project password policy for Active Directory resources","description":"
Early Access
OPA roles:
  • resource_admin
  • delegated_resource_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/active_directory_password_settings"},{"label":"List all resources checked out in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listallcheckedoutresourcesbyadmin","routeSlug":"/openapi/opa/opa/projects/listallcheckedoutresourcesbyadmin","metadata":{"seo":{"title":"List all resources checked out in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/checked_out_resources"},{"label":"Check in a resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/admincheckinresource","routeSlug":"/openapi/opa/opa/projects/admincheckinresource","metadata":{"seo":{"title":"Check in a resource","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/checkin_resource"},{"label":"List all database accounts in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listresourcegroupprojectdatabaseaccounts","routeSlug":"/openapi/opa/opa/projects/listresourcegroupprojectdatabaseaccounts","metadata":{"seo":{"title":"List all database accounts in a project","description":"
Early Access
OPA roles:
  • resource_admin
  • security_admin
  • delegated_resource_admin
  • delegated_security_admin
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts"},{"label":"Retrieve database checkout settings for a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupdatabasebasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupdatabasebasedprojectcheckoutsettings","metadata":{"seo":{"title":"Retrieve database checkout settings for a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_checkout_settings"},{"label":"Update the database checkout settings for a project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupdatabasebasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupdatabasebasedprojectcheckoutsettings","metadata":{"seo":{"title":"Update the database checkout settings for a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_checkout_settings"},{"label":"Retrieve a project password policy for database resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getprojectpasswordpolicyfordatabaseresources","routeSlug":"/openapi/opa/opa/projects/getprojectpasswordpolicyfordatabaseresources","metadata":{"seo":{"title":"Retrieve a project password policy for database resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_password_settings"},{"label":"Update a project password policy for database resources","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateprojectpasswordpolicyfordatabaseresources","routeSlug":"/openapi/opa/opa/projects/updateprojectpasswordpolicyfordatabaseresources","metadata":{"seo":{"title":"Update a project password policy for database resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_password_settings"},{"label":"Retrieve the checkout settings for a Universal Directory resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupoktauniversaldirectorybasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupoktauniversaldirectorybasedprojectcheckoutsettings","metadata":{"seo":{"title":"Retrieve the checkout settings for a Universal Directory resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_checkout_settings"},{"label":"Update the checkout settings for a Universal Directory resource group project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupoktauniversaldirectorybasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupoktauniversaldirectorybasedprojectcheckoutsettings","metadata":{"seo":{"title":"Update the checkout settings for a Universal Directory resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_checkout_settings"},{"label":"Retrieve a project password policy for Universal Directory resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getprojectpasswordpolicyforoktauniversaldirectoryresources","routeSlug":"/openapi/opa/opa/projects/getprojectpasswordpolicyforoktauniversaldirectoryresources","metadata":{"seo":{"title":"Retrieve a project password policy for Universal Directory resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_password_settings"},{"label":"Update a project password policy for Universal Directory resources","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforoktauniversaldirectoryresources","routeSlug":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforoktauniversaldirectoryresources","metadata":{"seo":{"title":"Update a project password policy for Universal Directory resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/okta_universal_directory_password_settings"},{"label":"Rotate the password for a given resource in a project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/adminrotateresource","routeSlug":"/openapi/opa/opa/projects/adminrotateresource","metadata":{"seo":{"title":"Rotate the password for a given resource in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/rotate_resource"},{"label":"Retrieve the checkout settings for a SaaS app resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupsaasappbasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupsaasappbasedprojectcheckoutsettings","metadata":{"seo":{"title":"Retrieve the checkout settings for a SaaS app resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_checkout_settings"},{"label":"Update the checkout settings for a SaaS app resource group project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupsaasappbasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupsaasappbasedprojectcheckoutsettings","metadata":{"seo":{"title":"Update the checkout settings for a SaaS app resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_checkout_settings"},{"label":"Retrieve a project password policy for SaaS app resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getprojectpasswordpolicyforsaasappresources","routeSlug":"/openapi/opa/opa/projects/getprojectpasswordpolicyforsaasappresources","metadata":{"seo":{"title":"Retrieve a project password policy for SaaS app resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_password_settings"},{"label":"Update a project password policy for SaaS app resources","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforsaasappresources","routeSlug":"/openapi/opa/opa/projects/updateprojectpasswordpolicyforsaasappresources","metadata":{"seo":{"title":"Update a project password policy for SaaS app resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_password_settings"},{"label":"List all server accounts in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listserveraccountsforproject","routeSlug":"/openapi/opa/opa/projects/listserveraccountsforproject","metadata":{"seo":{"title":"List all server accounts in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_accounts"},{"label":"Retrieve a server account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getserveraccountdetails","routeSlug":"/openapi/opa/opa/projects/getserveraccountdetails","metadata":{"seo":{"title":"Retrieve a server account","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_accounts/{server_account_id}"},{"label":"Retrieve the checkout settings for a server resource group project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/fetchresourcegroupserverbasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/fetchresourcegroupserverbasedprojectcheckoutsettings","metadata":{"seo":{"title":"Retrieve the checkout settings for a server resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_checkout_settings"},{"label":"Update the checkout settings for a server resource group project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updateresourcegroupserverbasedprojectcheckoutsettings","routeSlug":"/openapi/opa/opa/projects/updateresourcegroupserverbasedprojectcheckoutsettings","metadata":{"seo":{"title":"Update the checkout settings for a server resource group project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_checkout_settings"},{"label":"List all server enrollment tokens in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listresourcegroupprojectserverenrollmenttokens","routeSlug":"/openapi/opa/opa/projects/listresourcegroupprojectserverenrollmenttokens","metadata":{"seo":{"title":"List all server enrollment tokens in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens"},{"label":"Create a server enrollment token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/createresourcegroupprojectserverenrollmenttoken","routeSlug":"/openapi/opa/opa/projects/createresourcegroupprojectserverenrollmenttoken","metadata":{"seo":{"title":"Create a server enrollment token","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens"},{"label":"Retrieve a server enrollment token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getresourcegroupprojectserverenrollmenttoken","routeSlug":"/openapi/opa/opa/projects/getresourcegroupprojectserverenrollmenttoken","metadata":{"seo":{"title":"Retrieve a server enrollment token","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens/{server_enrollment_token_id}"},{"label":"Delete a server enrollment token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/removeresourcegroupprojectserverenrollmenttoken","routeSlug":"/openapi/opa/opa/projects/removeresourcegroupprojectserverenrollmenttoken","metadata":{"seo":{"title":"Delete a server enrollment token","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens/{server_enrollment_token_id}"},{"label":"Retrieve project password policy for server accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/getpasswordpolicyforproject","routeSlug":"/openapi/opa/opa/projects/getpasswordpolicyforproject","metadata":{"seo":{"title":"Retrieve project password policy for server accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_password_settings"},{"label":"Update project password policy for server accounts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/updatepasswordpolicyforproject","routeSlug":"/openapi/opa/opa/projects/updatepasswordpolicyforproject","metadata":{"seo":{"title":"Update project password policy for server accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_password_settings"},{"label":"List all server accounts for a server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/projects/listserveraccountsforserver","routeSlug":"/openapi/opa/opa/projects/listserveraccountsforserver","metadata":{"seo":{"title":"List all server accounts for a server","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}/server_accounts"}]},{"type":"group","label":"Random Password Generation","link":"/openapi/opa/opa/random-password-generation","routeSlug":"/openapi/opa/opa/random-password-generation","items":[{"label":"Generate a random password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/random-password-generation/createrandompassword","routeSlug":"/openapi/opa/opa/random-password-generation/createrandompassword","metadata":{"seo":{"title":"Generate a random password","description":"
"}},"httpPath":"/v1/teams/{team_name}/random_password"}]},{"type":"group","label":"Access Reports","link":"/openapi/opa/opa/reports","routeSlug":"/openapi/opa/opa/reports","items":[{"label":"List all access reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/reports/listaccessreports","routeSlug":"/openapi/opa/opa/reports/listaccessreports","metadata":{"seo":{"title":"List all access reports","description":"
"}},"httpPath":"/v1/teams/{team_name}/access_reports"},{"label":"Create an access report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/reports/createaccessreport","routeSlug":"/openapi/opa/opa/reports/createaccessreport","metadata":{"seo":{"title":"Create an access report","description":"
"}},"httpPath":"/v1/teams/{team_name}/access_reports"},{"label":"Retrieve an access report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/reports/getaccessreport","routeSlug":"/openapi/opa/opa/reports/getaccessreport","metadata":{"seo":{"title":"Retrieve an access report","description":"
"}},"httpPath":"/v1/teams/{team_name}/access_reports/{access_report_id}"},{"label":"Download an access report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/reports/downloadaccessreport","routeSlug":"/openapi/opa/opa/reports/downloadaccessreport","metadata":{"seo":{"title":"Download an access report","description":"
"}},"httpPath":"/v1/teams/{team_name}/access_reports/{access_report_id}/report"}]},{"type":"group","label":"Resource groups","link":"/openapi/opa/opa/resource-groups","routeSlug":"/openapi/opa/opa/resource-groups","items":[{"label":"List all resource groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/resource-groups/listresourcegroups","routeSlug":"/openapi/opa/opa/resource-groups/listresourcegroups","metadata":{"seo":{"title":"List all resource groups","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups"},{"label":"Create a resource group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/resource-groups/createresourcegroup","routeSlug":"/openapi/opa/opa/resource-groups/createresourcegroup","metadata":{"seo":{"title":"Create a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups"},{"label":"Retrieve a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/resource-groups/getresourcegroup","routeSlug":"/openapi/opa/opa/resource-groups/getresourcegroup","metadata":{"seo":{"title":"Retrieve a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}"},{"label":"Update a resource group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/resource-groups/updateresourcegroup","routeSlug":"/openapi/opa/opa/resource-groups/updateresourcegroup","metadata":{"seo":{"title":"Update a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}"},{"label":"Delete a resource group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/resource-groups/deleteresourcegroup","routeSlug":"/openapi/opa/opa/resource-groups/deleteresourcegroup","metadata":{"seo":{"title":"Delete a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}"}]},{"type":"group","label":"SaaS Application Accounts","link":"/openapi/opa/opa/saas-app-accounts","routeSlug":"/openapi/opa/opa/saas-app-accounts","items":[{"label":"List all SaaS app accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listallsaasappaccountsforsecurityadmin","routeSlug":"/openapi/opa/opa/saas-app-accounts/listallsaasappaccountsforsecurityadmin","metadata":{"seo":{"title":"List all SaaS app accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/all_saas_app_accounts"},{"label":"List all connected app instances for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listappinstancesforteam","routeSlug":"/openapi/opa/opa/saas-app-accounts/listappinstancesforteam","metadata":{"seo":{"title":"List all connected app instances for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/saas_apps"},{"label":"Retrieve a single app instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/getappinstanceforteam","routeSlug":"/openapi/opa/opa/saas-app-accounts/getappinstanceforteam","metadata":{"seo":{"title":"Retrieve a single app instance","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/saas_apps/{saas_app_instance_id}"},{"label":"Update an app instance's password rotation strategy","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/patchappinstance","routeSlug":"/openapi/opa/opa/saas-app-accounts/patchappinstance","metadata":{"seo":{"title":"Update an app instance's password rotation strategy","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/saas_apps/{saas_app_instance_id}"},{"label":"Retrieve an Okta Universal Directory service account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/getoktaudserviceaccountenduser","routeSlug":"/openapi/opa/opa/saas-app-accounts/getoktaudserviceaccountenduser","metadata":{"seo":{"title":"Retrieve an Okta Universal Directory service account","description":"
"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}"},{"label":"List all SaaS app accounts in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listallsaasappaccountsfordelegatedsecurityadmin","routeSlug":"/openapi/opa/opa/saas-app-accounts/listallsaasappaccountsfordelegatedsecurityadmin","metadata":{"seo":{"title":"List all SaaS app accounts in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_saas_app_accounts"},{"label":"List all SaaS app accounts in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listresourcegroupprojectsaasappaccounts","routeSlug":"/openapi/opa/opa/saas-app-accounts/listresourcegroupprojectsaasappaccounts","metadata":{"seo":{"title":"List all SaaS app accounts in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_accounts"},{"label":"Retrieve a SaaS app account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/getsaasappaccountdetails","routeSlug":"/openapi/opa/opa/saas-app-accounts/getsaasappaccountdetails","metadata":{"seo":{"title":"Retrieve a SaaS app account","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/saas_app_accounts/{saas_app_account_id}"},{"label":"List the end-user SaaS app instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listsaasapplicationsaccessiblebyuser","routeSlug":"/openapi/opa/opa/saas-app-accounts/listsaasapplicationsaccessiblebyuser","metadata":{"seo":{"title":"List the end-user SaaS app instances","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps"},{"label":"Retrieve an end-user SaaS app instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/getsaasapplicationaccessiblebyuser","routeSlug":"/openapi/opa/opa/saas-app-accounts/getsaasapplicationaccessiblebyuser","metadata":{"seo":{"title":"Retrieve an end-user SaaS app instance","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}"},{"label":"List all end-user SaaS app service accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listsaasapplicationserviceaccountsenduser","routeSlug":"/openapi/opa/opa/saas-app-accounts/listsaasapplicationserviceaccountsenduser","metadata":{"seo":{"title":"List all end-user SaaS app service accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts"},{"label":"Retrieve an end-user SaaS app service account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/getsaasapplicationserviceaccountenduser","routeSlug":"/openapi/opa/opa/saas-app-accounts/getsaasapplicationserviceaccountenduser","metadata":{"seo":{"title":"Retrieve an end-user SaaS app service account","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}"},{"label":"Update the SaaS app account password","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/updatesaasappaccountpassword","routeSlug":"/openapi/opa/opa/saas-app-accounts/updatesaasappaccountpassword","metadata":{"seo":{"title":"Update the SaaS app account password","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/credentials"},{"label":"List credential versions for a SaaS app account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listsaasappaccountcredentialversions","routeSlug":"/openapi/opa/opa/saas-app-accounts/listsaasappaccountcredentialversions","metadata":{"seo":{"title":"List credential versions for a SaaS app account","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/credentials/versions"},{"label":"Reveal the SaaS app account password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/revealsaasappaccountpassword","routeSlug":"/openapi/opa/opa/saas-app-accounts/revealsaasappaccountpassword","metadata":{"seo":{"title":"Reveal the SaaS app account password","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/reveal_credentials"},{"label":"Rotate a managed SaaS app account password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/saasappaccountrotatepassword","routeSlug":"/openapi/opa/opa/saas-app-accounts/saasappaccountrotatepassword","metadata":{"seo":{"title":"Rotate a managed SaaS app account password","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/rotate_password"},{"label":"List all SaaS app account user access methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/saas-app-accounts/listuamforsaasapplicationaccount","routeSlug":"/openapi/opa/opa/saas-app-accounts/listuamforsaasapplicationaccount","metadata":{"seo":{"title":"List all SaaS app account user access methods","description":"
"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/user_access_methods"}]},{"type":"group","label":"Secrets","link":"/openapi/opa/opa/secrets","routeSlug":"/openapi/opa/opa/secrets","items":[{"label":"Resolve a secret or folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/resolvesecretorfolder","routeSlug":"/openapi/opa/opa/secrets/resolvesecretorfolder","metadata":{"seo":{"title":"Resolve a secret or folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resolve_secret"},{"label":"List top-level secret folders for a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforproject","routeSlug":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforproject","metadata":{"seo":{"title":"List top-level secret folders for a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders"},{"label":"Create a secret folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/createsecretfolder","routeSlug":"/openapi/opa/opa/secrets/createsecretfolder","metadata":{"seo":{"title":"Create a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders"},{"label":"Retrieve a secret folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/getsecretfolder","routeSlug":"/openapi/opa/opa/secrets/getsecretfolder","metadata":{"seo":{"title":"Retrieve a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}"},{"label":"Update a secret folder","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/updatesecretfolder","routeSlug":"/openapi/opa/opa/secrets/updatesecretfolder","metadata":{"seo":{"title":"Update a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}"},{"label":"Delete a secret folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/deletesecretfolder","routeSlug":"/openapi/opa/opa/secrets/deletesecretfolder","metadata":{"seo":{"title":"Delete a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}"},{"label":"Retrieve allowable actions for a secret folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/getfolderactions","routeSlug":"/openapi/opa/opa/secrets/getfolderactions","metadata":{"seo":{"title":"Retrieve allowable actions for a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/actions"},{"label":"List all items in a secret folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listsecretfolderitems","routeSlug":"/openapi/opa/opa/secrets/listsecretfolderitems","metadata":{"seo":{"title":"List all items in a secret folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/items"},{"label":"Create a secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/createsecret","routeSlug":"/openapi/opa/opa/secrets/createsecret","metadata":{"seo":{"title":"Create a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets"},{"label":"Retrieve a secret","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/getsecret","routeSlug":"/openapi/opa/opa/secrets/getsecret","metadata":{"seo":{"title":"Retrieve a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}"},{"label":"Reveal a secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/revealsecret","routeSlug":"/openapi/opa/opa/secrets/revealsecret","metadata":{"seo":{"title":"Reveal a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}"},{"label":"Update a secret","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/updatesecret","routeSlug":"/openapi/opa/opa/secrets/updatesecret","metadata":{"seo":{"title":"Update a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}"},{"label":"Delete a secret","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/deletesecret","routeSlug":"/openapi/opa/opa/secrets/deletesecret","metadata":{"seo":{"title":"Delete a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}"},{"label":"Retrieve the allowable actions for a secret","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/getsecretactions","routeSlug":"/openapi/opa/opa/secrets/getsecretactions","metadata":{"seo":{"title":"Retrieve the allowable actions for a secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/actions"},{"label":"List versions for a generic secret","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listsecretcredentialversions","routeSlug":"/openapi/opa/opa/secrets/listsecretcredentialversions","metadata":{"seo":{"title":"List versions for a generic secret","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/versions"},{"label":"List top-level secret folders for team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforteam","routeSlug":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforteam","metadata":{"seo":{"title":"List top-level secret folders for team","description":"
"}},"httpPath":"/v1/teams/{team_name}/secret_folders"},{"label":"List top-level secret folders for user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforuser","routeSlug":"/openapi/opa/opa/secrets/listtoplevelsecretfoldersforuser","metadata":{"seo":{"title":"List top-level secret folders for user","description":"
"}},"httpPath":"/v1/teams/{team_name}/secrets"},{"label":"Move a secret to a different folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/movesecret","routeSlug":"/openapi/opa/opa/secrets/movesecret","metadata":{"seo":{"title":"Move a secret to a different folder","description":"
"}},"httpPath":"/v1/teams/{team_name}/secrets/move"},{"label":"List secret move destination folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listmovedestinations","routeSlug":"/openapi/opa/opa/secrets/listmovedestinations","metadata":{"seo":{"title":"List secret move destination folders","description":"
"}},"httpPath":"/v1/teams/{team_name}/secrets/move-destinations"},{"label":"List all secret templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/secrets/listsecrettemplates","routeSlug":"/openapi/opa/opa/secrets/listsecrettemplates","metadata":{"seo":{"title":"List all secret templates","description":"
"}},"httpPath":"/v1/teams/{team_name}/templates"}]},{"type":"group","label":"Security Policy","link":"/openapi/opa/opa/security-policy","routeSlug":"/openapi/opa/opa/security-policy","items":[{"label":"List all security policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/security-policy/listsecuritypolicies","routeSlug":"/openapi/opa/opa/security-policy/listsecuritypolicies","metadata":{"seo":{"title":"List all security policies","description":"
"}},"httpPath":"/v1/teams/{team_name}/security_policy"},{"label":"Create a security policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/security-policy/createsecuritypolicy","routeSlug":"/openapi/opa/opa/security-policy/createsecuritypolicy","metadata":{"seo":{"title":"Create a security policy","description":"
"}},"httpPath":"/v1/teams/{team_name}/security_policy"},{"label":"Retrieve a security policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/security-policy/getsecuritypolicy","routeSlug":"/openapi/opa/opa/security-policy/getsecuritypolicy","metadata":{"seo":{"title":"Retrieve a security policy","description":"
"}},"httpPath":"/v1/teams/{team_name}/security_policy/{security_policy_id}"},{"label":"Update a security policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/security-policy/updatesecuritypolicy","routeSlug":"/openapi/opa/opa/security-policy/updatesecuritypolicy","metadata":{"seo":{"title":"Update a security policy","description":"
"}},"httpPath":"/v1/teams/{team_name}/security_policy/{security_policy_id}"},{"label":"Delete a security policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/security-policy/deletesecuritypolicy","routeSlug":"/openapi/opa/opa/security-policy/deletesecuritypolicy","metadata":{"seo":{"title":"Delete a security policy","description":"
"}},"httpPath":"/v1/teams/{team_name}/security_policy/{security_policy_id}"}]},{"type":"group","label":"Server Accounts","link":"/openapi/opa/opa/server-accounts","routeSlug":"/openapi/opa/opa/server-accounts","items":[{"label":"Reveal the password for a server account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/server-accounts/revealserveraccountpassword","routeSlug":"/openapi/opa/opa/server-accounts/revealserveraccountpassword","metadata":{"seo":{"title":"Reveal the password for a server account","description":"
"}},"httpPath":"/v1/teams/{team_name}/server_accounts/{server_account_id}/reveal_credentials"},{"label":"Rotate the password for a server account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/server-accounts/rotateserveraccountpassword","routeSlug":"/openapi/opa/opa/server-accounts/rotateserveraccountpassword","metadata":{"seo":{"title":"Rotate the password for a server account","description":"
"}},"httpPath":"/v1/teams/{team_name}/server_accounts/{server_account_id}/rotate_password"}]},{"type":"group","label":"Servers","link":"/openapi/opa/opa/servers","routeSlug":"/openapi/opa/opa/servers","items":[{"label":"Resolve resource names","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/resolveresource","routeSlug":"/openapi/opa/opa/servers/resolveresource","metadata":{"seo":{"title":"Resolve resource names","description":"Resolves enrolled resource names and returns any associated information and user access methods (UAMs)"}},"httpPath":"/v1/resolve"},{"label":"List all server account resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/listallserveraccountresourcesforsecurityadmin","routeSlug":"/openapi/opa/opa/servers/listallserveraccountresourcesforsecurityadmin","metadata":{"seo":{"title":"List all server account resources","description":"
"}},"httpPath":"/v1/teams/{team_name}/all_server_accounts"},{"label":"List all servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/listallserversforadmin","routeSlug":"/openapi/opa/opa/servers/listallserversforadmin","metadata":{"seo":{"title":"List all servers","description":"
"}},"httpPath":"/v1/teams/{team_name}/all_servers"},{"label":"List all server account resources in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/listallserveraccountresourcesfordelegatedsecurityadmin","routeSlug":"/openapi/opa/opa/servers/listallserveraccountresourcesfordelegatedsecurityadmin","metadata":{"seo":{"title":"List all server account resources in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_server_accounts"},{"label":"List all servers in a resource group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/listallserversforresourcegroup","routeSlug":"/openapi/opa/opa/servers/listallserversforresourcegroup","metadata":{"seo":{"title":"List all servers in a resource group","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_servers"},{"label":"List all servers in a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/listresourcegroupprojectservers","routeSlug":"/openapi/opa/opa/servers/listresourcegroupprojectservers","metadata":{"seo":{"title":"List all servers in a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers"},{"label":"Retrieve a server from a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/getresourcegroupprojectserver","routeSlug":"/openapi/opa/opa/servers/getresourcegroupprojectserver","metadata":{"seo":{"title":"Retrieve a server from a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}"},{"label":"Delete a server from a project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/servers/deleteresourcegroupprojectserver","routeSlug":"/openapi/opa/opa/servers/deleteresourcegroupprojectserver","metadata":{"seo":{"title":"Delete a server from a project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}"}]},{"type":"group","label":"Service Users","link":"/openapi/opa/opa/service-users","routeSlug":"/openapi/opa/opa/service-users","items":[{"label":"Issue a service user token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/issueservicetoken","routeSlug":"/openapi/opa/opa/service-users/issueservicetoken","metadata":{"seo":{"title":"Issue a service user token","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_token"},{"label":"List all service users for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/listserviceusers","routeSlug":"/openapi/opa/opa/service-users/listserviceusers","metadata":{"seo":{"title":"List all service users for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users"},{"label":"Create a service user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/createserviceuser","routeSlug":"/openapi/opa/opa/service-users/createserviceuser","metadata":{"seo":{"title":"Create a service user","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users"},{"label":"Retrieve a service user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/getserviceuser","routeSlug":"/openapi/opa/opa/service-users/getserviceuser","metadata":{"seo":{"title":"Retrieve a service user","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}"},{"label":"Update a service user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/serviceuserupdate","routeSlug":"/openapi/opa/opa/service-users/serviceuserupdate","metadata":{"seo":{"title":"Update a service user","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}"},{"label":"List all API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/listserviceuserkeys","routeSlug":"/openapi/opa/opa/service-users/listserviceuserkeys","metadata":{"seo":{"title":"List all API keys","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys"},{"label":"Rotate all API keys","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/rotateserviceuserkey","routeSlug":"/openapi/opa/opa/service-users/rotateserviceuserkey","metadata":{"seo":{"title":"Rotate all API keys","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys"},{"label":"Delete an API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/service-users/deleteserviceuserkey","routeSlug":"/openapi/opa/opa/service-users/deleteserviceuserkey","metadata":{"seo":{"title":"Delete an API key","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys/{key_id}"}]},{"type":"group","label":"Staged Service Accounts","link":"/openapi/opa/opa/staged-service-accounts","routeSlug":"/openapi/opa/opa/staged-service-accounts","items":[{"label":"List all staged service accounts from Okta Universal Directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/staged-service-accounts/liststagedserviceaccounts","routeSlug":"/openapi/opa/opa/staged-service-accounts/liststagedserviceaccounts","metadata":{"seo":{"title":"List all staged service accounts from Okta Universal Directory","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/universal_directory/accounts"},{"label":"Assign a SaaS or Okta service account to a resource group and project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/staged-service-accounts/assignstagedserviceaccount","routeSlug":"/openapi/opa/opa/staged-service-accounts/assignstagedserviceaccount","metadata":{"seo":{"title":"Assign a SaaS or Okta service account to a resource group and project","description":"
"}},"httpPath":"/v1/teams/{team_name}/resource_assignment/universal_directory/accounts/{staged_service_account_id}/assign/{project_id}"}]},{"type":"group","label":"Sudo Commands","link":"/openapi/opa/opa/sudo-commands","routeSlug":"/openapi/opa/opa/sudo-commands","items":[{"label":"List all sudo command bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/sudo-commands/listsudocommandbundles","routeSlug":"/openapi/opa/opa/sudo-commands/listsudocommandbundles","metadata":{"seo":{"title":"List all sudo command bundles","description":"
"}},"httpPath":"/v1/teams/{team_name}/sudo_command_bundles"},{"label":"Create a sudo command bundle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/sudo-commands/createsudocommandbundle","routeSlug":"/openapi/opa/opa/sudo-commands/createsudocommandbundle","metadata":{"seo":{"title":"Create a sudo command bundle","description":"
"}},"httpPath":"/v1/teams/{team_name}/sudo_command_bundles"},{"label":"Retrieve a sudo command bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/sudo-commands/getsudocommandbundle","routeSlug":"/openapi/opa/opa/sudo-commands/getsudocommandbundle","metadata":{"seo":{"title":"Retrieve a sudo command bundle","description":"
"}},"httpPath":"/v1/teams/{team_name}/sudo_command_bundles/{sudo_command_bundle_id}"},{"label":"Update a sudo command bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/sudo-commands/updatesudocommandbundle","routeSlug":"/openapi/opa/opa/sudo-commands/updatesudocommandbundle","metadata":{"seo":{"title":"Update a sudo command bundle","description":"
"}},"httpPath":"/v1/teams/{team_name}/sudo_command_bundles/{sudo_command_bundle_id}"},{"label":"Delete a sudo command bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/sudo-commands/deletesudocommandbundle","routeSlug":"/openapi/opa/opa/sudo-commands/deletesudocommandbundle","metadata":{"seo":{"title":"Delete a sudo command bundle","description":"
"}},"httpPath":"/v1/teams/{team_name}/sudo_command_bundles/{sudo_command_bundle_id}"}]},{"type":"group","label":"Teams","link":"/openapi/opa/opa/teams","routeSlug":"/openapi/opa/opa/teams","items":[{"label":"List all resources checked out by a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/listallcheckedoutresourcesbyuser","routeSlug":"/openapi/opa/opa/teams/listallcheckedoutresourcesbyuser","metadata":{"seo":{"title":"List all resources checked out by a user","description":"
"}},"httpPath":"/v1/teams/{team_name}/checked_out_resources"},{"label":"Check in a resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/selfcheckinresource","routeSlug":"/openapi/opa/opa/teams/selfcheckinresource","metadata":{"seo":{"title":"Check in a resource","description":"
"}},"httpPath":"/v1/teams/{team_name}/checkin_resource"},{"label":"List all roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/listroles","routeSlug":"/openapi/opa/opa/teams/listroles","metadata":{"seo":{"title":"List all roles","description":"
"}},"httpPath":"/v1/teams/{team_name}/roles"},{"label":"List all servers for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/listservers","routeSlug":"/openapi/opa/opa/teams/listservers","metadata":{"seo":{"title":"List all servers for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/servers"},{"label":"Retrieve settings for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/getteamsettings","routeSlug":"/openapi/opa/opa/teams/getteamsettings","metadata":{"seo":{"title":"Retrieve settings for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/settings"},{"label":"Update settings for a team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/updateteamsettings","routeSlug":"/openapi/opa/opa/teams/updateteamsettings","metadata":{"seo":{"title":"Update settings for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/settings"},{"label":"Retrieve statistics for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/fetchstatsforteam","routeSlug":"/openapi/opa/opa/teams/fetchstatsforteam","metadata":{"seo":{"title":"Retrieve statistics for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/team_stats"},{"label":"Retrieve the vault JWKS","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/teams/getvaultjwks","routeSlug":"/openapi/opa/opa/teams/getvaultjwks","metadata":{"seo":{"title":"Retrieve the vault JWKS","description":"Retrieves the vault JWKS. Data sent to the vault must be encrypted to this key."}},"httpPath":"/v1/teams/{team_name}/vault/jwks.json"}]},{"type":"group","label":"Users","link":"/openapi/opa/opa/users","routeSlug":"/openapi/opa/opa/users","items":[{"label":"Retrieve user details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/users/getcurrentuserinfo","routeSlug":"/openapi/opa/opa/users/getcurrentuserinfo","metadata":{"seo":{"title":"Retrieve user details","description":"Retrieves details about the current user"}},"httpPath":"/v1/teams/{team_name}/current_user"},{"label":"List all users for a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/users/listusers","routeSlug":"/openapi/opa/opa/users/listusers","metadata":{"seo":{"title":"List all users for a team","description":"
"}},"httpPath":"/v1/teams/{team_name}/users"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/users/getuser","routeSlug":"/openapi/opa/opa/users/getuser","metadata":{"seo":{"title":"Retrieve a user","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}"},{"label":"List all groups for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/users/listusergroups","routeSlug":"/openapi/opa/opa/users/listusergroups","metadata":{"seo":{"title":"List all groups for a user","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/groups"}]},{"type":"group","label":"Workload Connections","link":"/openapi/opa/opa/workload-connections","routeSlug":"/openapi/opa/opa/workload-connections","items":[{"label":"List all workload connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/listworkloadconnections","routeSlug":"/openapi/opa/opa/workload-connections/listworkloadconnections","metadata":{"seo":{"title":"List all workload connections","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads"},{"label":"Create a workload connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/createworkloadconnection","routeSlug":"/openapi/opa/opa/workload-connections/createworkloadconnection","metadata":{"seo":{"title":"Create a workload connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads"},{"label":"Retrieve a workload connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/getworkloadconnection","routeSlug":"/openapi/opa/opa/workload-connections/getworkloadconnection","metadata":{"seo":{"title":"Retrieve a workload connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads/{workload_connection_id}"},{"label":"Update a workload connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/updateworkloadconnection","routeSlug":"/openapi/opa/opa/workload-connections/updateworkloadconnection","metadata":{"seo":{"title":"Update a workload connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads/{workload_connection_id}"},{"label":"Delete a workload connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/deleteworkloadconnection","routeSlug":"/openapi/opa/opa/workload-connections/deleteworkloadconnection","metadata":{"seo":{"title":"Delete a workload connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads/{workload_connection_id}"},{"label":"Update the status of a workload connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-connections/updateworkloadconnectionstatus","routeSlug":"/openapi/opa/opa/workload-connections/updateworkloadconnectionstatus","metadata":{"seo":{"title":"Update the status of a workload connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/connections/workloads/{workload_connection_id}/status"}]},{"type":"group","label":"Workload Roles","link":"/openapi/opa/opa/workload-roles","routeSlug":"/openapi/opa/opa/workload-roles","items":[{"label":"List all workload roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-roles/listworkloadroles","routeSlug":"/openapi/opa/opa/workload-roles/listworkloadroles","metadata":{"seo":{"title":"List all workload roles","description":"
"}},"httpPath":"/v1/teams/{team_name}/workload-roles"},{"label":"Create a workload role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-roles/createworkloadrole","routeSlug":"/openapi/opa/opa/workload-roles/createworkloadrole","metadata":{"seo":{"title":"Create a workload role","description":"
"}},"httpPath":"/v1/teams/{team_name}/workload-roles"},{"label":"Retrieve a workload role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-roles/getworkloadrole","routeSlug":"/openapi/opa/opa/workload-roles/getworkloadrole","metadata":{"seo":{"title":"Retrieve a workload role","description":"
"}},"httpPath":"/v1/teams/{team_name}/workload-roles/{workload_role_id}"},{"label":"Update a workload role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-roles/updateworkloadrole","routeSlug":"/openapi/opa/opa/workload-roles/updateworkloadrole","metadata":{"seo":{"title":"Update a workload role","description":"
"}},"httpPath":"/v1/teams/{team_name}/workload-roles/{workload_role_id}"},{"label":"Delete a workload role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/workload-roles/deleteworkloadrole","routeSlug":"/openapi/opa/opa/workload-roles/deleteworkloadrole","metadata":{"seo":{"title":"Delete a workload role","description":"
"}},"httpPath":"/v1/teams/{team_name}/workload-roles/{workload_role_id}"}]},{"label":"/v1/gateways/orchestrator-config","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1gateways~1orchestrator-config/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1gateways~1orchestrator-config/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/gateways/orchestrator-config"}},"httpPath":"/v1/gateways/orchestrator-config"},{"label":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/credentials/versions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1active_directory~1{ad_connection_id}~1accounts~1{ad_account_id}~1credentials~1versions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1active_directory~1{ad_connection_id}~1accounts~1{ad_account_id}~1credentials~1versions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/credentials/versions"}},"httpPath":"/v1/teams/{team_name}/active_directory/{ad_connection_id}/accounts/{ad_account_id}/credentials/versions"},{"label":"/v1/teams/{team_name}/connections/databases","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases"}},"httpPath":"/v1/teams/{team_name}/connections/databases"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1accounts/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1accounts/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts/{database_account_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1accounts~1{database_account_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1accounts~1{database_account_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts/{database_account_id}"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/accounts/{database_account_id}"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/force_sync","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1force_sync/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1force_sync/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/force_sync"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/force_sync"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1rules/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1rules/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1rules~1{database_account_rule_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1rules~1{database_account_rule_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/rules/{database_account_rule_id}"},{"label":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/sync_status","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1sync_status/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1databases~1{database_connection_id}~1sync_status/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/sync_status"}},"httpPath":"/v1/teams/{team_name}/connections/databases/{database_connection_id}/sync_status"},{"label":"/v1/teams/{team_name}/connections/saas_apps","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1saas_apps/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1saas_apps/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/saas_apps"}},"httpPath":"/v1/teams/{team_name}/connections/saas_apps"},{"label":"/v1/teams/{team_name}/connections/saas_apps/{saas_app_instance_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1saas_apps~1{saas_app_instance_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1connections~1saas_apps~1{saas_app_instance_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/connections/saas_apps/{saas_app_instance_id}"}},"httpPath":"/v1/teams/{team_name}/connections/saas_apps/{saas_app_instance_id}"},{"label":"/v1/teams/{team_name}/databases","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases"}},"httpPath":"/v1/teams/{team_name}/databases"},{"label":"/v1/teams/{team_name}/databases/{database_connection_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases/{database_connection_id}"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}"},{"label":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts"},{"label":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}"},{"label":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/reveal_credentials","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}~1reveal_credentials/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}~1reveal_credentials/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/reveal_credentials"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/reveal_credentials"},{"label":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/user_access_methods","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}~1user_access_methods/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1databases~1{database_connection_id}~1accounts~1{database_account_id}~1user_access_methods/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/user_access_methods"}},"httpPath":"/v1/teams/{team_name}/databases/{database_connection_id}/accounts/{database_account_id}/user_access_methods"},{"label":"/v1/teams/{team_name}/infrastructure-orchestrators","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/infrastructure-orchestrators"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators"},{"label":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}"},{"label":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/gateways","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}~1references~1gateways/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}~1references~1gateways/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/gateways"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/gateways"},{"label":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/integrations","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}~1references~1integrations/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1infrastructure-orchestrators~1{infrastructure_orchestrator_id}~1references~1integrations/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/integrations"}},"httpPath":"/v1/teams/{team_name}/infrastructure-orchestrators/{infrastructure_orchestrator_id}/references/integrations"},{"label":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/credentials/versions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1okta_universal_directory_accounts~1{okta_universal_directory_account_id}~1credentials~1versions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1okta_universal_directory_accounts~1{okta_universal_directory_account_id}~1credentials~1versions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/credentials/versions"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/credentials/versions"},{"label":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/rotate_password","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1okta_universal_directory_accounts~1{okta_universal_directory_account_id}~1rotate_password/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1okta_universal_directory_accounts~1{okta_universal_directory_account_id}~1rotate_password/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/rotate_password"}},"httpPath":"/v1/teams/{team_name}/okta_universal_directory_accounts/{okta_universal_directory_account_id}/rotate_password"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_accounts/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_accounts/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts/{database_account_id}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_accounts~1{database_account_id}/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_accounts~1{database_account_id}/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts/{database_account_id}"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_accounts/{database_account_id}"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_checkout_settings","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_checkout_settings/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_checkout_settings/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_checkout_settings"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_checkout_settings"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_password_settings","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_password_settings/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1database_password_settings/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_password_settings"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/database_password_settings"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/actions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secret_folders~1{secret_folder_id}~1actions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secret_folders~1{secret_folder_id}~1actions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/actions"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/actions"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/actions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secrets~1{secret_id}~1actions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secrets~1{secret_id}~1actions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/actions"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/actions"},{"label":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/versions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secrets~1{secret_id}~1versions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1resource_groups~1{resource_group_id}~1projects~1{project_id}~1secrets~1{secret_id}~1versions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/versions"}},"httpPath":"/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}/versions"},{"label":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/credentials/versions","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1saas_apps~1{saas_app_instance_id}~1accounts~1{saas_app_account_id}~1credentials~1versions/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1saas_apps~1{saas_app_instance_id}~1accounts~1{saas_app_account_id}~1credentials~1versions/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/credentials/versions"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/credentials/versions"},{"label":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/rotate_password","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1saas_apps~1{saas_app_instance_id}~1accounts~1{saas_app_account_id}~1rotate_password/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1saas_apps~1{saas_app_instance_id}~1accounts~1{saas_app_account_id}~1rotate_password/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/rotate_password"}},"httpPath":"/v1/teams/{team_name}/saas_apps/{saas_app_instance_id}/accounts/{saas_app_account_id}/rotate_password"},{"label":"/v1/teams/{team_name}/secrets/move","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1secrets~1move/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1secrets~1move/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/secrets/move"}},"httpPath":"/v1/teams/{team_name}/secrets/move"},{"label":"/v1/teams/{team_name}/secrets/move-destinations","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1secrets~1move-destinations/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1secrets~1move-destinations/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/secrets/move-destinations"}},"httpPath":"/v1/teams/{team_name}/secrets/move-destinations"},{"label":"/v1/teams/{team_name}/server_accounts/{server_account_id}/reveal_credentials","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1server_accounts~1{server_account_id}~1reveal_credentials/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1server_accounts~1{server_account_id}~1reveal_credentials/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/server_accounts/{server_account_id}/reveal_credentials"}},"httpPath":"/v1/teams/{team_name}/server_accounts/{server_account_id}/reveal_credentials"},{"label":"/v1/teams/{team_name}/server_accounts/{server_account_id}/rotate_password","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1server_accounts~1{server_account_id}~1rotate_password/x-okta-lifecycle","routeSlug":"/openapi/opa/opa/paths/~1v1~1teams~1{team_name}~1server_accounts~1{server_account_id}~1rotate_password/x-okta-lifecycle","metadata":{"seo":{"title":"/v1/teams/{team_name}/server_accounts/{server_account_id}/rotate_password"}},"httpPath":"/v1/teams/{team_name}/server_accounts/{server_account_id}/rotate_password"}],"menuStyle":"drilldown"},{"type":"group","label":"Advanced Server Access","items":[{"type":"link","fsPath":"openapi/asa/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/asa","routeSlug":"/openapi/asa"},{"type":"link","link":"https://www.postman.com/okta-eng/workspace/okta-public-api-collections/collection/4920859-f91736f1-5ae0-4a0a-949d-abed2ada2c58","label":"Postman Collection"},{"type":"link","label":"Advanced Server Access","link":"/openapi/asa/asa","routeSlug":"/openapi/asa/asa"},{"type":"group","label":"AD Connections","link":"/openapi/asa/asa/ad-connections","routeSlug":"/openapi/asa/asa/ad-connections","items":[{"label":"List all AD Connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/listadconnections","routeSlug":"/openapi/asa/asa/ad-connections/listadconnections","metadata":{"seo":{"title":"List all AD Connections","description":"
"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections"},{"label":"Create an AD Connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/createadconnection","routeSlug":"/openapi/asa/asa/ad-connections/createadconnection","metadata":{"seo":{"title":"Create an AD Connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections"},{"label":"Retrieve an AD Connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/getadconnectionbyid","routeSlug":"/openapi/asa/asa/ad-connections/getadconnectionbyid","metadata":{"seo":{"title":"Retrieve an AD Connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}"},{"label":"Update an AD Connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/updateadconnection","routeSlug":"/openapi/asa/asa/ad-connections/updateadconnection","metadata":{"seo":{"title":"Update an AD Connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}"},{"label":"Delete an AD Connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/deleteadconnection","routeSlug":"/openapi/asa/asa/ad-connections/deleteadconnection","metadata":{"seo":{"title":"Delete an AD Connection","description":"
"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}"},{"label":"List all AD Server Sync Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/listserversyncjobs","routeSlug":"/openapi/asa/asa/ad-connections/listserversyncjobs","metadata":{"seo":{"title":"List all AD Server Sync Jobs","description":"Lists all server sync jobs for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings"},{"label":"Create a Server Sync Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/createserversyncjob","routeSlug":"/openapi/asa/asa/ad-connections/createserversyncjob","metadata":{"seo":{"title":"Create a Server Sync Job","description":"Creates a server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings"},{"label":"Retrieve a Server Sync Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/getserversyncjob","routeSlug":"/openapi/asa/asa/ad-connections/getserversyncjob","metadata":{"seo":{"title":"Retrieve a Server Sync Job","description":"Retrieves a server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}"},{"label":"Update a Server Sync Job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/updateserversyncjob","routeSlug":"/openapi/asa/asa/ad-connections/updateserversyncjob","metadata":{"seo":{"title":"Update a Server Sync Job","description":"Updates a server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}"},{"label":"Remove a Server Sync Job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/removeserversyncjob","routeSlug":"/openapi/asa/asa/ad-connections/removeserversyncjob","metadata":{"seo":{"title":"Remove a Server Sync Job","description":"Removes a server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}"},{"label":"Deactivate a Server Sync Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/deactivateserversyncjob","routeSlug":"/openapi/asa/asa/ad-connections/deactivateserversyncjob","metadata":{"seo":{"title":"Deactivate a Server Sync Job","description":"Deactivates an Active Directory server sync job"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}/deactivate"},{"label":"Update a Server Sync Job Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/updateserversyncjobschedule","routeSlug":"/openapi/asa/asa/ad-connections/updateserversyncjobschedule","metadata":{"seo":{"title":"Update a Server Sync Job Schedule","description":"Updates the schedule for a server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}/schedule"},{"label":"List all AD Server Sync Job Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/listserversyncjobresults","routeSlug":"/openapi/asa/asa/ad-connections/listserversyncjobresults","metadata":{"seo":{"title":"List all AD Server Sync Job Results","description":"Lists all results for a specified server sync job"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}/task_results"},{"label":"Retrieve a Server Sync Job Result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/getserversyncjobresult","routeSlug":"/openapi/asa/asa/ad-connections/getserversyncjobresult","metadata":{"seo":{"title":"Retrieve a Server Sync Job Result","description":"Retrieves the details summary of a specified server sync job"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}/task_results/{ad_task_result_id}/detailed_summary"},{"label":"Create a Server Sync Test Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/createserversyncjobtest","routeSlug":"/openapi/asa/asa/ad-connections/createserversyncjobtest","metadata":{"seo":{"title":"Create a Server Sync Test Request","description":"Creates a test request for the specified server sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/task_settings/{ad_task_settings_id}/test_request"},{"label":"List all AD User Sync Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/listusersyncjobs","routeSlug":"/openapi/asa/asa/ad-connections/listusersyncjobs","metadata":{"seo":{"title":"List all AD User Sync Jobs","description":"Lists all user sync jobs for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings"},{"label":"Create a User Sync Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/createusersyncjob","routeSlug":"/openapi/asa/asa/ad-connections/createusersyncjob","metadata":{"seo":{"title":"Create a User Sync Job","description":"Creates a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings"},{"label":"Retrieve a User Sync Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/getusersyncjob","routeSlug":"/openapi/asa/asa/ad-connections/getusersyncjob","metadata":{"seo":{"title":"Retrieve a User Sync Job","description":"Retrieves a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}"},{"label":"Update a User Sync Job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/usersyncjob","routeSlug":"/openapi/asa/asa/ad-connections/usersyncjob","metadata":{"seo":{"title":"Update a User Sync Job","description":"Updates a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}"},{"label":"Remove a User Sync Job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/removeusersyncjob","routeSlug":"/openapi/asa/asa/ad-connections/removeusersyncjob","metadata":{"seo":{"title":"Remove a User Sync Job","description":"Removes a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}"},{"label":"Update a User Sync Job Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/updateusersyncjobschedule","routeSlug":"/openapi/asa/asa/ad-connections/updateusersyncjobschedule","metadata":{"seo":{"title":"Update a User Sync Job Schedule","description":"Updates the schedule for a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}/schedule"},{"label":"Update a User Sync Job State","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/updateusersyncjobstate","routeSlug":"/openapi/asa/asa/ad-connections/updateusersyncjobstate","metadata":{"seo":{"title":"Update a User Sync Job State","description":"Updates the state of a user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}/state"},{"label":"Create a User Sync Test Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/createusersyncjobtest","routeSlug":"/openapi/asa/asa/ad-connections/createusersyncjobtest","metadata":{"seo":{"title":"Create a User Sync Test Request","description":"Creates a test request for the specified user sync job for an Active Directory connection"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}/test_request"},{"label":"List all AD User Sync Job Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/listusersyncjobresults","routeSlug":"/openapi/asa/asa/ad-connections/listusersyncjobresults","metadata":{"seo":{"title":"List all AD User Sync Job Results","description":"Lists all results for a specified user sync job"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}/user_sync_task_results"},{"label":"Retrieve a User Sync Job Result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/ad-connections/getusersyncjobresult","routeSlug":"/openapi/asa/asa/ad-connections/getusersyncjobresult","metadata":{"seo":{"title":"Retrieve a User Sync Job Result","description":"Retrieves the details summary of a specified user sync job"}},"httpPath":"/v1/teams/{team_name}/integrations/ad_connections/{ad_connection_id}/user_sync_task_settings/{ad_user_sync_task_settings_id}/user_sync_task_results/{ad_user_sync_task_result_id}/detailed_summary"}]},{"type":"group","label":"Attributes","link":"/openapi/asa/asa/attributes","routeSlug":"/openapi/asa/asa/attributes","items":[{"label":"List all Attributes for a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/listgroupattributes","routeSlug":"/openapi/asa/asa/attributes/listgroupattributes","metadata":{"seo":{"title":"List all Attributes for a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes"},{"label":"Retrieve a Group Attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/fetchgroupattribute","routeSlug":"/openapi/asa/asa/attributes/fetchgroupattribute","metadata":{"seo":{"title":"Retrieve a Group Attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}"},{"label":"Update a Group Attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/updategroupattribute","routeSlug":"/openapi/asa/asa/attributes/updategroupattribute","metadata":{"seo":{"title":"Update a Group Attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}"},{"label":"List all Attributes for a User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/listuserattributes","routeSlug":"/openapi/asa/asa/attributes/listuserattributes","metadata":{"seo":{"title":"List all Attributes for a User","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes"},{"label":"Retrieve a User Attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/fetchuserattribute","routeSlug":"/openapi/asa/asa/attributes/fetchuserattribute","metadata":{"seo":{"title":"Retrieve a User Attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}"},{"label":"Update a User Attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/attributes/updateuserattribute","routeSlug":"/openapi/asa/asa/attributes/updateuserattribute","metadata":{"seo":{"title":"Update a User Attribute","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}"}]},{"type":"group","label":"Audits","link":"/openapi/asa/asa/audits","routeSlug":"/openapi/asa/asa/audits","items":[{"label":"List all Audit Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/audits/listauditsforteamv2","routeSlug":"/openapi/asa/asa/audits/listauditsforteamv2","metadata":{"seo":{"title":"List all Audit Events","description":"
"}},"httpPath":"/v1/teams/{team_name}/auditsV2"}]},{"type":"group","label":"Clients","link":"/openapi/asa/asa/clients","routeSlug":"/openapi/asa/asa/clients","items":[{"label":"List all Clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/clients/listclients","routeSlug":"/openapi/asa/asa/clients/listclients","metadata":{"seo":{"title":"List all Clients","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients"},{"label":"Retrieve a Client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/clients/fetchclient","routeSlug":"/openapi/asa/asa/clients/fetchclient","metadata":{"seo":{"title":"Retrieve a Client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"},{"label":"Update a Client","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/clients/updateclient","routeSlug":"/openapi/asa/asa/clients/updateclient","metadata":{"seo":{"title":"Update a Client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"},{"label":"Revoke access to a Client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/clients/removeclient","routeSlug":"/openapi/asa/asa/clients/removeclient","metadata":{"seo":{"title":"Revoke access to a Client","description":"
"}},"httpPath":"/v1/teams/{team_name}/clients/{client_id}"}]},{"type":"group","label":"Entitlements","link":"/openapi/asa/asa/entitlements","routeSlug":"/openapi/asa/asa/entitlements","items":[{"label":"List all sudo Entitlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/listentitlementssudo","routeSlug":"/openapi/asa/asa/entitlements/listentitlementssudo","metadata":{"seo":{"title":"List all sudo Entitlements","description":"
"}},"httpPath":"/v1/teams/{team_name}/entitlements/sudo"},{"label":"Create a sudo Entitlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/createentitlementssudo","routeSlug":"/openapi/asa/asa/entitlements/createentitlementssudo","metadata":{"seo":{"title":"Create a sudo Entitlement","description":"
"}},"httpPath":"/v1/teams/{team_name}/entitlements/sudo"},{"label":"Retrieve a sudo Entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/getentitlementssudo","routeSlug":"/openapi/asa/asa/entitlements/getentitlementssudo","metadata":{"seo":{"title":"Retrieve a sudo Entitlement","description":"
"}},"httpPath":"/v1/teams/{team_name}/entitlements/sudo/{sudo_id}"},{"label":"Update a sudo Entitlement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/updateentitlementssudo","routeSlug":"/openapi/asa/asa/entitlements/updateentitlementssudo","metadata":{"seo":{"title":"Update a sudo Entitlement","description":"
"}},"httpPath":"/v1/teams/{team_name}/entitlements/sudo/{sudo_id}"},{"label":"Delete a sudo Entitlement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/removeentitlementssudo","routeSlug":"/openapi/asa/asa/entitlements/removeentitlementssudo","metadata":{"seo":{"title":"Delete a sudo Entitlement","description":"
"}},"httpPath":"/v1/teams/{team_name}/entitlements/sudo/{sudo_id}"},{"label":"List all sudo Entitlements for a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/listentitlementssudoforprojectgroup","routeSlug":"/openapi/asa/asa/entitlements/listentitlementssudoforprojectgroup","metadata":{"seo":{"title":"List all sudo Entitlements for a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}/entitlements/sudo"},{"label":"Assign a sudo Entitlement to a Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/addentitlementssudotoprojectgroup","routeSlug":"/openapi/asa/asa/entitlements/addentitlementssudotoprojectgroup","metadata":{"seo":{"title":"Assign a sudo Entitlement to a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}/entitlements/sudo"},{"label":"Remove a sudo Entitlement from a Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/entitlements/removeentitlementssudofromprojectgroup","routeSlug":"/openapi/asa/asa/entitlements/removeentitlementssudofromprojectgroup","metadata":{"seo":{"title":"Remove a sudo Entitlement from a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}/entitlements/sudo/{sudo_id}"}]},{"type":"group","label":"Gateways","link":"/openapi/asa/asa/gateways","routeSlug":"/openapi/asa/asa/gateways","items":[{"label":"List all Gateway Setup Tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/listgatewaysetuptokens","routeSlug":"/openapi/asa/asa/gateways/listgatewaysetuptokens","metadata":{"seo":{"title":"List all Gateway Setup Tokens","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens"},{"label":"Create a Gateway Setup Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/creategatewaysetuptoken","routeSlug":"/openapi/asa/asa/gateways/creategatewaysetuptoken","metadata":{"seo":{"title":"Create a Gateway Setup Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens"},{"label":"Retrieve a Gateway Setup Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/fetchgatewaysetuptoken","routeSlug":"/openapi/asa/asa/gateways/fetchgatewaysetuptoken","metadata":{"seo":{"title":"Retrieve a Gateway Setup Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}"},{"label":"Delete a Gateway Setup Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/deletegatewaysetuptoken","routeSlug":"/openapi/asa/asa/gateways/deletegatewaysetuptoken","metadata":{"seo":{"title":"Delete a Gateway Setup Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}"},{"label":"Retrieve a Gateway Setup Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/fetchgatewaysetuptokenasagenttoken","routeSlug":"/openapi/asa/asa/gateways/fetchgatewaysetuptokenasagenttoken","metadata":{"seo":{"title":"Retrieve a Gateway Setup Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}/token"},{"label":"List all Gateways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/listgateways","routeSlug":"/openapi/asa/asa/gateways/listgateways","metadata":{"seo":{"title":"List all Gateways","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways"},{"label":"Retrieve a Gateway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/getgatewayinstance","routeSlug":"/openapi/asa/asa/gateways/getgatewayinstance","metadata":{"seo":{"title":"Retrieve a Gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Update a Gateway","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/updategatewayinstance","routeSlug":"/openapi/asa/asa/gateways/updategatewayinstance","metadata":{"seo":{"title":"Update a Gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Delete a Gateway","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/deletegatewayinstance","routeSlug":"/openapi/asa/asa/gateways/deletegatewayinstance","metadata":{"seo":{"title":"Delete a Gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}"},{"label":"Retrieve a status report for a Gateway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/gateways/getgatewaystatusreport","routeSlug":"/openapi/asa/asa/gateways/getgatewaystatusreport","metadata":{"seo":{"title":"Retrieve a status report for a Gateway","description":"
"}},"httpPath":"/v1/teams/{team_name}/gateways/{gateway_id}/status"}]},{"type":"group","label":"Groups","link":"/openapi/asa/asa/groups","routeSlug":"/openapi/asa/asa/groups","items":[{"label":"List all Groups for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/listgroups","routeSlug":"/openapi/asa/asa/groups/listgroups","metadata":{"seo":{"title":"List all Groups for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups"},{"label":"Create a Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/creategroup","routeSlug":"/openapi/asa/asa/groups/creategroup","metadata":{"seo":{"title":"Create a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups"},{"label":"Retrieve a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/getgroup","routeSlug":"/openapi/asa/asa/groups/getgroup","metadata":{"seo":{"title":"Retrieve a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"Update a Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/updategroup","routeSlug":"/openapi/asa/asa/groups/updategroup","metadata":{"seo":{"title":"Update a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"Remove a Group from a Team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/removegroup","routeSlug":"/openapi/asa/asa/groups/removegroup","metadata":{"seo":{"title":"Remove a Group from a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}"},{"label":"Update a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/getdmgroupdetails","routeSlug":"/openapi/asa/asa/groups/getdmgroupdetails","metadata":{"seo":{"title":"Update a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/disconnected_mode"},{"label":"List all Users for a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/listusersingroup","routeSlug":"/openapi/asa/asa/groups/listusersingroup","metadata":{"seo":{"title":"List all Users for a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users"},{"label":"Add a User to a Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/addusertogroup","routeSlug":"/openapi/asa/asa/groups/addusertogroup","metadata":{"seo":{"title":"Add a User to a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users"},{"label":"Remove a User from a Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/groups/removeuserfromgroup","routeSlug":"/openapi/asa/asa/groups/removeuserfromgroup","metadata":{"seo":{"title":"Remove a User from a Group","description":"
"}},"httpPath":"/v1/teams/{team_name}/groups/{group_name}/users/{user_name}"}]},{"type":"group","label":"Projects","link":"/openapi/asa/asa/projects","routeSlug":"/openapi/asa/asa/projects","items":[{"label":"List all Projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listprojects","routeSlug":"/openapi/asa/asa/projects/listprojects","metadata":{"seo":{"title":"List all Projects","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects"},{"label":"Create a Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/createproject","routeSlug":"/openapi/asa/asa/projects/createproject","metadata":{"seo":{"title":"Create a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects"},{"label":"Retrieve a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/fetchproject","routeSlug":"/openapi/asa/asa/projects/fetchproject","metadata":{"seo":{"title":"Retrieve a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}"},{"label":"Updates the details of a Project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/updateproject","routeSlug":"/openapi/asa/asa/projects/updateproject","metadata":{"seo":{"title":"Updates the details of a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}"},{"label":"Delete a Project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removeproject","routeSlug":"/openapi/asa/asa/projects/removeproject","metadata":{"seo":{"title":"Delete a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}"},{"label":"List all Client Configuration Options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listclientconfigoptions","routeSlug":"/openapi/asa/asa/projects/listclientconfigoptions","metadata":{"seo":{"title":"List all Client Configuration Options","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/client_config_options"},{"label":"Add a Client Configuration Option","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/createclientconfigoption","routeSlug":"/openapi/asa/asa/projects/createclientconfigoption","metadata":{"seo":{"title":"Add a Client Configuration Option","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/client_config_options"},{"label":"Delete a Client Configuration Option","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removeclientconfigoption","routeSlug":"/openapi/asa/asa/projects/removeclientconfigoption","metadata":{"seo":{"title":"Delete a Client Configuration Option","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/client_config_options/{client_config_options_id}"},{"label":"List all Cloud Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listallcloudaccountsforproject","routeSlug":"/openapi/asa/asa/projects/listallcloudaccountsforproject","metadata":{"seo":{"title":"List all Cloud Accounts","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_accounts"},{"label":"Add a Cloud Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/addcloudaccounttoproject","routeSlug":"/openapi/asa/asa/projects/addcloudaccounttoproject","metadata":{"seo":{"title":"Add a Cloud Account","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_accounts"},{"label":"Retrieve a Cloud Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/getprojectcloudaccount","routeSlug":"/openapi/asa/asa/projects/getprojectcloudaccount","metadata":{"seo":{"title":"Retrieve a Cloud Account","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_accounts/{cloud_account_uuid}"},{"label":"Update a Cloud Account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/updatecloudaccounttoproject","routeSlug":"/openapi/asa/asa/projects/updatecloudaccounttoproject","metadata":{"seo":{"title":"Update a Cloud Account","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_accounts/{cloud_account_uuid}"},{"label":"Remove a Cloud Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removecloudaccountfromproject","routeSlug":"/openapi/asa/asa/projects/removecloudaccountfromproject","metadata":{"seo":{"title":"Remove a Cloud Account","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_accounts/{cloud_account_uuid}"},{"label":"Retrieve a Cloud Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/getprojectcloudaccountbyproviderandaccountid","routeSlug":"/openapi/asa/asa/projects/getprojectcloudaccountbyproviderandaccountid","metadata":{"seo":{"title":"Retrieve a Cloud Account","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/cloud_provider/{cloud_provider}/accounts/{cloud_account_id}"},{"label":"List all Groups in a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listprojectgroups","routeSlug":"/openapi/asa/asa/projects/listprojectgroups","metadata":{"seo":{"title":"List all Groups in a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups"},{"label":"Add a Group to a Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/addgrouptoproject","routeSlug":"/openapi/asa/asa/projects/addgrouptoproject","metadata":{"seo":{"title":"Add a Group to a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups"},{"label":"Retrieve a Group in a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/getprojectgroup","routeSlug":"/openapi/asa/asa/projects/getprojectgroup","metadata":{"seo":{"title":"Retrieve a Group in a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}"},{"label":"Update a Group in a Project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/updateprojectgroup","routeSlug":"/openapi/asa/asa/projects/updateprojectgroup","metadata":{"seo":{"title":"Update a Group in a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}"},{"label":"Remove a Group from a Project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removegroupfromproject","routeSlug":"/openapi/asa/asa/projects/removegroupfromproject","metadata":{"seo":{"title":"Remove a Group from a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/groups/{group_name}"},{"label":"List all Preauthorizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listpreauthorizationsforproject","routeSlug":"/openapi/asa/asa/projects/listpreauthorizationsforproject","metadata":{"seo":{"title":"List all Preauthorizations","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/preauthorizations"},{"label":"Create a Preauthorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/createpreauthorization","routeSlug":"/openapi/asa/asa/projects/createpreauthorization","metadata":{"seo":{"title":"Create a Preauthorization","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/preauthorizations"},{"label":"Retrieve a Preauthorization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/getpreauthorization","routeSlug":"/openapi/asa/asa/projects/getpreauthorization","metadata":{"seo":{"title":"Retrieve a Preauthorization","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/preauthorizations/{authorization_id}"},{"label":"Update a Preauthorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/updatepreauthorization","routeSlug":"/openapi/asa/asa/projects/updatepreauthorization","metadata":{"seo":{"title":"Update a Preauthorization","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/preauthorizations/{authorization_id}"},{"label":"List all Server Enrollment Tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listserverenrollmenttokens","routeSlug":"/openapi/asa/asa/projects/listserverenrollmenttokens","metadata":{"seo":{"title":"List all Server Enrollment Tokens","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_enrollment_tokens"},{"label":"Create a Server Enrollment Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/createserverenrollmenttoken","routeSlug":"/openapi/asa/asa/projects/createserverenrollmenttoken","metadata":{"seo":{"title":"Create a Server Enrollment Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_enrollment_tokens"},{"label":"Retrieve a Server Enrollment Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/fetchserverenrollmenttoken","routeSlug":"/openapi/asa/asa/projects/fetchserverenrollmenttoken","metadata":{"seo":{"title":"Retrieve a Server Enrollment Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_enrollment_tokens/{server_enrollment_token_id}"},{"label":"Delete a Server Enrollment Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removeserverenrollmenttoken","routeSlug":"/openapi/asa/asa/projects/removeserverenrollmenttoken","metadata":{"seo":{"title":"Delete a Server Enrollment Token","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_enrollment_tokens/{server_enrollment_token_id}"},{"label":"List all Server Users for a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listserverusersforproject","routeSlug":"/openapi/asa/asa/projects/listserverusersforproject","metadata":{"seo":{"title":"List all Server Users for a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_users"},{"label":"Retrieve a Server User for a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/getserveruserforproject","routeSlug":"/openapi/asa/asa/projects/getserveruserforproject","metadata":{"seo":{"title":"Retrieve a Server User for a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/server_users/{user_name}"},{"label":"List all Servers in a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/listserversforproject","routeSlug":"/openapi/asa/asa/projects/listserversforproject","metadata":{"seo":{"title":"List all Servers in a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers"},{"label":"Add an Unmanaged Server to a Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/createserver","routeSlug":"/openapi/asa/asa/projects/createserver","metadata":{"seo":{"title":"Add an Unmanaged Server to a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers"},{"label":"Retrieve a Server from a Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/fetchserver","routeSlug":"/openapi/asa/asa/projects/fetchserver","metadata":{"seo":{"title":"Retrieve a Server from a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}"},{"label":"Update a Server for a Project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/updateserverproject","routeSlug":"/openapi/asa/asa/projects/updateserverproject","metadata":{"seo":{"title":"Update a Server for a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}"},{"label":"Remove a Server from a Project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/projects/removeserver","routeSlug":"/openapi/asa/asa/projects/removeserver","metadata":{"seo":{"title":"Remove a Server from a Project","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}"}]},{"type":"group","label":"Service Users","link":"/openapi/asa/asa/service-users","routeSlug":"/openapi/asa/asa/service-users","items":[{"label":"Issue a Service User token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/issueservicetoken","routeSlug":"/openapi/asa/asa/service-users/issueservicetoken","metadata":{"seo":{"title":"Issue a Service User token","description":"Requests a Service User token from the platform. Most API calls require an HTTP Authorization header with a value of Bearer ${AUTH_TOKEN}.To retrieve an auth token, you need to create a Service User and API key, then pass the API key information to this endpoint.Auth tokens may expire at any time, so code that uses them should be prepared to handle a 401 response code by creating a new auth token. By design, this operation does not require a authorization token."}},"httpPath":"/v1/teams/{team_name}/service_token"},{"label":"List all Service Users for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/listserviceusers","routeSlug":"/openapi/asa/asa/service-users/listserviceusers","metadata":{"seo":{"title":"List all Service Users for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users"},{"label":"Create a Service User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/createserviceuser","routeSlug":"/openapi/asa/asa/service-users/createserviceuser","metadata":{"seo":{"title":"Create a Service User","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users"},{"label":"Retrieve a Service User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/getserviceuser","routeSlug":"/openapi/asa/asa/service-users/getserviceuser","metadata":{"seo":{"title":"Retrieve a Service User","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}"},{"label":"Update a Service User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/serviceuserupdate","routeSlug":"/openapi/asa/asa/service-users/serviceuserupdate","metadata":{"seo":{"title":"Update a Service User","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}"},{"label":"List all API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/listserviceuserkeys","routeSlug":"/openapi/asa/asa/service-users/listserviceuserkeys","metadata":{"seo":{"title":"List all API keys","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys"},{"label":"Rotate all API keys","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/rotateserviceuserkey","routeSlug":"/openapi/asa/asa/service-users/rotateserviceuserkey","metadata":{"seo":{"title":"Rotate all API keys","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys"},{"label":"Delete an API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/service-users/deleteserviceuserkey","routeSlug":"/openapi/asa/asa/service-users/deleteserviceuserkey","metadata":{"seo":{"title":"Delete an API key","description":"
"}},"httpPath":"/v1/teams/{team_name}/service_users/{user_name}/keys/{key_id}"}]},{"type":"group","label":"Services","link":"/openapi/asa/asa/services","routeSlug":"/openapi/asa/asa/services","items":[{"label":"List all Services for a Server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/listservicesforserver","routeSlug":"/openapi/asa/asa/services/listservicesforserver","metadata":{"seo":{"title":"List all Services for a Server","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services"},{"label":"Create a Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/createserviceforserver","routeSlug":"/openapi/asa/asa/services/createserviceforserver","metadata":{"seo":{"title":"Create a Service","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services"},{"label":"Delete a Service from a Server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/removeserviceforserver","routeSlug":"/openapi/asa/asa/services/removeserviceforserver","metadata":{"seo":{"title":"Delete a Service from a Server","description":"
"}},"httpPath":"/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services/{service_id}"},{"label":"List all Services for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/listservices","routeSlug":"/openapi/asa/asa/services/listservices","metadata":{"seo":{"title":"List all Services for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/services"},{"label":"Retrieve a Service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/getservice","routeSlug":"/openapi/asa/asa/services/getservice","metadata":{"seo":{"title":"Retrieve a Service","description":"
"}},"httpPath":"/v1/teams/{team_name}/services/{service_id}"},{"label":"Delete a Service from a Team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/services/removeservice","routeSlug":"/openapi/asa/asa/services/removeservice","metadata":{"seo":{"title":"Delete a Service from a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/services/{service_id}"}]},{"type":"group","label":"Teams","link":"/openapi/asa/asa/teams","routeSlug":"/openapi/asa/asa/teams","items":[{"label":"List all Servers for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/teams/listservers","routeSlug":"/openapi/asa/asa/teams/listservers","metadata":{"seo":{"title":"List all Servers for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/servers"},{"label":"Update a Server for a Team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/teams/updateserverteam","routeSlug":"/openapi/asa/asa/teams/updateserverteam","metadata":{"seo":{"title":"Update a Server for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/servers/{server_id}"},{"label":"Retrieve settings for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/teams/getteamsettings","routeSlug":"/openapi/asa/asa/teams/getteamsettings","metadata":{"seo":{"title":"Retrieve settings for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/settings"},{"label":"Update settings for a Team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/teams/updateteamsettings","routeSlug":"/openapi/asa/asa/teams/updateteamsettings","metadata":{"seo":{"title":"Update settings for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/settings"},{"label":"Retrieve statistics for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/teams/fetchstatsforteam","routeSlug":"/openapi/asa/asa/teams/fetchstatsforteam","metadata":{"seo":{"title":"Retrieve statistics for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/team_stats"}]},{"type":"group","label":"Users","link":"/openapi/asa/asa/users","routeSlug":"/openapi/asa/asa/users","items":[{"label":"Retrieve information about the current User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/users/getcurrentuserinfo","routeSlug":"/openapi/asa/asa/users/getcurrentuserinfo","metadata":{"seo":{"title":"Retrieve information about the current User","description":"Retrieves information about the User that is invoking the API"}},"httpPath":"/v1/teams/{team_name}/current_user"},{"label":"List all Users for a Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/users/listusers","routeSlug":"/openapi/asa/asa/users/listusers","metadata":{"seo":{"title":"List all Users for a Team","description":"
"}},"httpPath":"/v1/teams/{team_name}/users"},{"label":"Retrieve a User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/users/getuser","routeSlug":"/openapi/asa/asa/users/getuser","metadata":{"seo":{"title":"Retrieve a User","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}"},{"label":"Update a User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/users/updateuser","routeSlug":"/openapi/asa/asa/users/updateuser","metadata":{"seo":{"title":"Update a User","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}"},{"label":"List all Groups for a User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/asa/asa/users/listusergroups","routeSlug":"/openapi/asa/asa/users/listusergroups","metadata":{"seo":{"title":"List all Groups for a User","description":"
"}},"httpPath":"/v1/teams/{team_name}/users/{user_name}/groups"}]}],"menuStyle":"drilldown"},{"type":"group","label":"Okta Identity Governance","items":[{"type":"link","fsPath":"iga/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/iga","routeSlug":"/iga"},{"type":"link","link":"https://www.postman.com/okta-eng/workspace/okta-public-api-collections/collection/26001419-cc71d586-dfd0-48a7-81e5-8d959baffe32","label":"Postman Collection","external":true},{"type":"link","fsPath":"iga/oauth2.md","metadata":{"type":"markdown"},"label":"OAuth 2.0 Scopes","link":"/iga/oauth2","routeSlug":"/iga/oauth2"},{"type":"group","label":"Management APIs","items":[{"type":"link","label":"Okta Governance API","link":"/iga/openapi/governance-production-reference","routeSlug":"/iga/openapi/governance-production-reference"},{"type":"group","label":"Campaigns","link":"/iga/openapi/governance-production-reference/campaigns","routeSlug":"/iga/openapi/governance-production-reference/campaigns","items":[{"label":"Create a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/createcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/createcampaign","metadata":{"seo":{"title":"Create a campaign","description":"
"}},"httpPath":"/governance/api/v1/campaigns"},{"label":"List all campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/listcampaigns","routeSlug":"/iga/openapi/governance-production-reference/campaigns/listcampaigns","metadata":{"seo":{"title":"List all campaigns","description":"
"}},"httpPath":"/governance/api/v1/campaigns"},{"label":"Retrieve a campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/getcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/getcampaign","metadata":{"seo":{"title":"Retrieve a campaign","description":"
"}},"httpPath":"/governance/api/v1/campaigns/{campaignId}"},{"label":"Delete a campaign","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/deletecampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/deletecampaign","metadata":{"seo":{"title":"Delete a campaign","description":"
"}},"httpPath":"/governance/api/v1/campaigns/{campaignId}"},{"label":"Launch a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/launchcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/launchcampaign","metadata":{"seo":{"title":"Launch a campaign","description":"
"}},"httpPath":"/governance/api/v1/campaigns/{campaignId}/launch"},{"label":"End a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/endcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/endcampaign","metadata":{"seo":{"title":"End a campaign","description":"
"}},"httpPath":"/governance/api/v1/campaigns/{campaignId}/end"}]},{"type":"group","label":"Reviews","link":"/iga/openapi/governance-production-reference/reviews","routeSlug":"/iga/openapi/governance-production-reference/reviews","items":[{"label":"List all reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/listreviews","routeSlug":"/iga/openapi/governance-production-reference/reviews/listreviews","metadata":{"seo":{"title":"List all reviews","description":"
"}},"httpPath":"/governance/api/v1/reviews"},{"label":"Reassign the reviews","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/reassignreviews","routeSlug":"/iga/openapi/governance-production-reference/reviews/reassignreviews","metadata":{"seo":{"title":"Reassign the reviews","description":"
"}},"httpPath":"/governance/api/v1/campaigns/{campaignId}/reviews/reassign"},{"label":"Retrieve a review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/getreview","routeSlug":"/iga/openapi/governance-production-reference/reviews/getreview","metadata":{"seo":{"title":"Retrieve a review","description":"
"}},"httpPath":"/governance/api/v1/reviews/{reviewId}"}]},{"type":"group","label":"Entitlements","link":"/iga/openapi/governance-production-reference/entitlements","routeSlug":"/iga/openapi/governance-production-reference/entitlements","items":[{"label":"Create an entitlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/createentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/createentitlement","metadata":{"seo":{"title":"Create an entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements"},{"label":"List all entitlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listentitlements","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listentitlements","metadata":{"seo":{"title":"List all entitlements","description":"
"}},"httpPath":"/governance/api/v1/entitlements"},{"label":"Delete an entitlement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/deleteentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/deleteentitlement","metadata":{"seo":{"title":"Delete an entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Retrieve an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/getentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/getentitlement","metadata":{"seo":{"title":"Retrieve an entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Replace an entitlement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/replaceentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/replaceentitlement","metadata":{"seo":{"title":"Replace an entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Update the entitlement","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/updateentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/updateentitlement","metadata":{"seo":{"title":"Update the entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"List all values for an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listentitlementvalues","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listentitlementvalues","metadata":{"seo":{"title":"List all values for an entitlement","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}/values"},{"label":"Retrieve an entitlement value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/getentitlementvalue","routeSlug":"/iga/openapi/governance-production-reference/entitlements/getentitlementvalue","metadata":{"seo":{"title":"Retrieve an entitlement value","description":"
"}},"httpPath":"/governance/api/v1/entitlements/{entitlementId}/values/{valueId}"},{"label":"List all entitlement values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listallentitlementvalues","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listallentitlementvalues","metadata":{"seo":{"title":"List all entitlement values","description":"
"}},"httpPath":"/governance/api/v1/entitlements/values"}]},{"type":"group","label":"Entitlement Bundles","link":"/iga/openapi/governance-production-reference/entitlement-bundles","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles","items":[{"label":"Create an entitlement bundle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/createentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/createentitlementbundle","metadata":{"seo":{"title":"Create an entitlement bundle","description":"
"}},"httpPath":"/governance/api/v1/entitlement-bundles"},{"label":"List all entitlement bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/listentitlementbundles","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/listentitlementbundles","metadata":{"seo":{"title":"List all entitlement bundles","description":"
"}},"httpPath":"/governance/api/v1/entitlement-bundles"},{"label":"Retrieve an entitlement bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/getentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/getentitlementbundle","metadata":{"seo":{"title":"Retrieve an entitlement bundle","description":"
"}},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"},{"label":"Replace an entitlement bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/replaceentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/replaceentitlementbundle","metadata":{"seo":{"title":"Replace an entitlement bundle","description":"
"}},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"},{"label":"Delete an entitlement bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/deleteentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/deleteentitlementbundle","metadata":{"seo":{"title":"Delete an entitlement bundle","description":"
"}},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"}]},{"type":"group","label":"Grants","link":"/iga/openapi/governance-production-reference/grants","routeSlug":"/iga/openapi/governance-production-reference/grants","items":[{"type":"link","label":"Base","link":"/iga/openapi/governance-production-reference/grants/base","routeSlug":"/iga/openapi/governance-production-reference/grants/base"},{"type":"link","label":"Additive","link":"/iga/openapi/governance-production-reference/grants/additive","routeSlug":"/iga/openapi/governance-production-reference/grants/additive"},{"label":"Create a grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/creategrant","routeSlug":"/iga/openapi/governance-production-reference/grants/creategrant","metadata":{"seo":{"title":"Create a grant","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/grants"},{"label":"List all grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/listgrants","routeSlug":"/iga/openapi/governance-production-reference/grants/listgrants","metadata":{"seo":{"title":"List all grants","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/grants"},{"label":"Retrieve a grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/getgrant","routeSlug":"/iga/openapi/governance-production-reference/grants/getgrant","metadata":{"seo":{"title":"Retrieve a grant","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/grants/{grantId}"},{"label":"Replace a grant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/replacegrant","routeSlug":"/iga/openapi/governance-production-reference/grants/replacegrant","metadata":{"seo":{"title":"Replace a grant","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/grants/{grantId}"},{"label":"Update a grant","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/updategrant","routeSlug":"/iga/openapi/governance-production-reference/grants/updategrant","metadata":{"seo":{"title":"Update a grant","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/grants/{grantId}"}]},{"type":"group","label":"Principal Entitlements","link":"/iga/openapi/governance-production-reference/principal-entitlements","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements","items":[{"label":"Retrieve the principal's effective entitlements for a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlements","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlements","metadata":{"seo":{"title":"Retrieve the principal's effective entitlements for a resource","description":"
"}},"httpPath":"/governance/api/v1/principal-entitlements"},{"label":"Retrieve the principal entitlement changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementschanges","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementschanges","metadata":{"seo":{"title":"Retrieve the principal entitlement changes","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/principal-entitlements-changes/{principalEntitlementsChangeId}"},{"label":"Retrieve an entitlement history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementshistory","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementshistory","metadata":{"seo":{"title":"Retrieve an entitlement history","description":"
"}},"httpPath":"/governance/api/v1/principal-entitlements/history"}]},{"type":"group","label":"Principal Access","link":"/iga/openapi/governance-production-reference/principal-access","routeSlug":"/iga/openapi/governance-production-reference/principal-access","items":[{"label":"Retrieve the principal access for a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-access/getprincipalaccess","routeSlug":"/iga/openapi/governance-production-reference/principal-access/getprincipalaccess","metadata":{"seo":{"title":"Retrieve the principal access for a resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/principal-access"}]},{"type":"group","label":"Principal Access - V2","link":"/iga/openapi/governance-production-reference/principal-access-v2","routeSlug":"/iga/openapi/governance-production-reference/principal-access-v2","items":[{"label":"Revoke a principal's access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-access-v2/revokeprincipalaccess","routeSlug":"/iga/openapi/governance-production-reference/principal-access-v2/revokeprincipalaccess","metadata":{"seo":{"title":"Revoke a principal's access","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/revoke-principal-access"}]},{"type":"group","label":"Collections","link":"/iga/openapi/governance-production-reference/collections","routeSlug":"/iga/openapi/governance-production-reference/collections","items":[{"label":"Create a resource collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/createcollection","routeSlug":"/iga/openapi/governance-production-reference/collections/createcollection","metadata":{"seo":{"title":"Create a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections"},{"label":"List all resource collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollections","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollections","metadata":{"seo":{"title":"List all resource collections","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections"},{"label":"Retrieve a resource collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getcollection","routeSlug":"/iga/openapi/governance-production-reference/collections/getcollection","metadata":{"seo":{"title":"Retrieve a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"Replace a resource collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/replacecollection","routeSlug":"/iga/openapi/governance-production-reference/collections/replacecollection","metadata":{"seo":{"title":"Replace a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deletecollection","routeSlug":"/iga/openapi/governance-production-reference/collections/deletecollection","metadata":{"seo":{"title":"Delete a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"List all collection resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionresources","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionresources","metadata":{"seo":{"title":"List all collection resources","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/resources"},{"label":"Add the resources to a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/addresourcestocollection","routeSlug":"/iga/openapi/governance-production-reference/collections/addresourcestocollection","metadata":{"seo":{"title":"Add the resources to a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/resources"},{"label":"Delete a collection resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deletecollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/deletecollectionresource","metadata":{"seo":{"title":"Delete a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getcollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/getcollectionresource","metadata":{"seo":{"title":"Retrieve a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Replace a collection resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/replacecollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/replacecollectionresource","metadata":{"seo":{"title":"Replace a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve the unassigned users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getunassignedusers","routeSlug":"/iga/openapi/governance-production-reference/collections/getunassignedusers","metadata":{"seo":{"title":"Retrieve the unassigned users","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/catalog/users"},{"label":"List all assignments for a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionassignments","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionassignments","metadata":{"seo":{"title":"List all assignments for a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments"},{"label":"Assign a collection to principals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/assigncollection","routeSlug":"/iga/openapi/governance-production-reference/collections/assigncollection","metadata":{"seo":{"title":"Assign a collection to principals","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments"},{"label":"Update a principal assignment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/updateprincipalassignment","routeSlug":"/iga/openapi/governance-production-reference/collections/updateprincipalassignment","metadata":{"seo":{"title":"Update a principal assignment","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}"},{"label":"Delete a principal assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deleteprincipalassignment","routeSlug":"/iga/openapi/governance-production-reference/collections/deleteprincipalassignment","metadata":{"seo":{"title":"Delete a principal assignment","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}"},{"label":"List all assignments for all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionsassignments","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionsassignments","metadata":{"seo":{"title":"List all assignments for all collections","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/collections/assignments"}]},{"type":"group","label":"Collections - V2","link":"/iga/openapi/governance-production-reference/collections-v2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2","items":[{"label":"Create a resource collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/createcollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/createcollectionv2","metadata":{"seo":{"title":"Create a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections"},{"label":"List all resource collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsv2","metadata":{"seo":{"title":"List all resource collections","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections"},{"label":"Retrieve a resource collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getcollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getcollectionv2","metadata":{"seo":{"title":"Retrieve a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"Replace a resource collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionv2","metadata":{"seo":{"title":"Replace a resource collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionv2","metadata":{"seo":{"title":"Delete a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"List all collection resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourcesv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourcesv2","metadata":{"seo":{"title":"List all collection resources","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources"},{"label":"Add the resources to a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/addresourcestocollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/addresourcestocollectionv2","metadata":{"seo":{"title":"Add the resources to a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources"},{"label":"Delete a collection resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionresourcev2","metadata":{"seo":{"title":"Delete a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getcollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getcollectionresourcev2","metadata":{"seo":{"title":"Retrieve a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"Replace a collection resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionresourcev2","metadata":{"seo":{"title":"Replace a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"List all entitlements for a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourceentitlementsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourceentitlementsv2","metadata":{"seo":{"title":"List all entitlements for a collection resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}/entitlements"},{"label":"Retrieve the unassigned users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getunassignedusersv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getunassignedusersv2","metadata":{"seo":{"title":"Retrieve the unassigned users","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/catalog/users"},{"label":"List all assignments for a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionassignmentsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionassignmentsv2","metadata":{"seo":{"title":"List all assignments for a collection","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments"},{"label":"Assign a collection to principals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/assigncollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/assigncollectionv2","metadata":{"seo":{"title":"Assign a collection to principals","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments"},{"label":"Update a principal assignment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/updateprincipalassignmentv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/updateprincipalassignmentv2","metadata":{"seo":{"title":"Update a principal assignment","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}"},{"label":"Delete a principal assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deleteprincipalassignmentv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deleteprincipalassignmentv2","metadata":{"seo":{"title":"Delete a principal assignment","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}"},{"label":"List all assignments for all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsassignmentsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsassignmentsv2","metadata":{"seo":{"title":"List all assignments for all collections","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.collections.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/collections/assignments"}]},{"type":"group","label":"Risk Rules","link":"/iga/openapi/governance-production-reference/risk-rules","routeSlug":"/iga/openapi/governance-production-reference/risk-rules","items":[{"label":"Create a risk rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/createriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/createriskrule","metadata":{"seo":{"title":"Create a risk rule","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rules"},{"label":"List all risk rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/listriskrules","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/listriskrules","metadata":{"seo":{"title":"List all risk rules","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rules"},{"label":"Retrieve a risk rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/getriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/getriskrule","metadata":{"seo":{"title":"Retrieve a risk rule","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Replace a risk rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/replaceriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/replaceriskrule","metadata":{"seo":{"title":"Replace a risk rule","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Delete a risk rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/deleteriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/deleteriskrule","metadata":{"seo":{"title":"Delete a risk rule","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Generate a risk assessment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/generatepotentialriskassessments","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/generatepotentialriskassessments","metadata":{"seo":{"title":"Generate a risk assessment","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v1/risk-rule-assessments"}]},{"type":"group","label":"Resource Owners","link":"/iga/openapi/governance-production-reference/resource-owners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners","items":[{"label":"Configure the resource owners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/configureresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/configureresourceowners","metadata":{"seo":{"title":"Configure the resource owners","description":"
"}},"httpPath":"/governance/api/v1/resource-owners"},{"label":"List all resources with owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/listresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/listresourceowners","metadata":{"seo":{"title":"List all resources with owners","description":"
"}},"httpPath":"/governance/api/v1/resource-owners"},{"label":"Update a resource owner","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/updateresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/updateresourceowners","metadata":{"seo":{"title":"Update a resource owner","description":"
"}},"httpPath":"/governance/api/v1/resource-owners"},{"label":"List all unowned resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/listresourceownercatalogresources","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/listresourceownercatalogresources","metadata":{"seo":{"title":"List all unowned resources","description":"
"}},"httpPath":"/governance/api/v1/resource-owners/catalog/resources"}]},{"type":"group","label":"Labels","link":"/iga/openapi/governance-production-reference/labels","routeSlug":"/iga/openapi/governance-production-reference/labels","items":[{"label":"Create a label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/createlabel","routeSlug":"/iga/openapi/governance-production-reference/labels/createlabel","metadata":{"seo":{"title":"Create a label","description":"
"}},"httpPath":"/governance/api/v1/labels"},{"label":"List all labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/listlabels","routeSlug":"/iga/openapi/governance-production-reference/labels/listlabels","metadata":{"seo":{"title":"List all labels","description":"
"}},"httpPath":"/governance/api/v1/labels"},{"label":"Delete a label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/deletelabel","routeSlug":"/iga/openapi/governance-production-reference/labels/deletelabel","metadata":{"seo":{"title":"Delete a label","description":"
"}},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"Retrieve a label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/getlabel","routeSlug":"/iga/openapi/governance-production-reference/labels/getlabel","metadata":{"seo":{"title":"Retrieve a label","description":"
"}},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"Update a label","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/updatelabel","routeSlug":"/iga/openapi/governance-production-reference/labels/updatelabel","metadata":{"seo":{"title":"Update a label","description":"
"}},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"List all labeled resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/listlabelresources","routeSlug":"/iga/openapi/governance-production-reference/labels/listlabelresources","metadata":{"seo":{"title":"List all labeled resources","description":"
"}},"httpPath":"/governance/api/v1/resource-labels"},{"label":"Assign the labels to resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/assignresourcelabels","routeSlug":"/iga/openapi/governance-production-reference/labels/assignresourcelabels","metadata":{"seo":{"title":"Assign the labels to resources","description":"
"}},"httpPath":"/governance/api/v1/resource-labels/assign"},{"label":"Remove the labels from resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/removeresourcelabels","routeSlug":"/iga/openapi/governance-production-reference/labels/removeresourcelabels","metadata":{"seo":{"title":"Remove the labels from resources","description":"
"}},"httpPath":"/governance/api/v1/resource-labels/unassign"}]},{"type":"group","label":"Principal Settings","link":"/iga/openapi/governance-production-reference/principal-settings","routeSlug":"/iga/openapi/governance-production-reference/principal-settings","items":[{"label":"Update the principal settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-settings/updateprincipalsettings","routeSlug":"/iga/openapi/governance-production-reference/principal-settings/updateprincipalsettings","metadata":{"seo":{"title":"Update the principal settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.principalSettings.manage
Admin roles:
  • SUPER_ADMIN
  • ACCESS_CERTIFICATION_ADMIN
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/principal-settings/{targetPrincipalId}"}]},{"type":"group","label":"Delegates","link":"/iga/openapi/governance-production-reference/delegates","routeSlug":"/iga/openapi/governance-production-reference/delegates","items":[{"label":"List all delegate appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/delegates/listdelegateappointments","routeSlug":"/iga/openapi/governance-production-reference/delegates/listdelegateappointments","metadata":{"seo":{"title":"List all delegate appointments","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.delegates.read
Admin roles:
  • SUPER_ADMIN
  • ACCESS_CERTIFICATION_ADMIN
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/delegates"}]},{"type":"group","label":"Security Access Reviews","link":"/iga/openapi/governance-production-reference/security-access-reviews","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews","items":[{"label":"List all security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviews","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviews","metadata":{"seo":{"title":"List all security access reviews","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews"},{"label":"Create a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/createsecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/createsecurityaccessreview","metadata":{"seo":{"title":"Create a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews"},{"label":"Retrieve the statistics for security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewsstats","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewsstats","metadata":{"seo":{"title":"Retrieve the statistics for security access reviews","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/stats"},{"label":"Retrieve a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreview","metadata":{"seo":{"title":"Retrieve a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}"},{"label":"Update a security access review","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/updatesecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/updatesecurityaccessreview","metadata":{"seo":{"title":"Update a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}"},{"label":"Generate a summary for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewsummary","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewsummary","metadata":{"seo":{"title":"Generate a summary for a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary"},{"label":"List the actions for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewactions","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewactions","metadata":{"seo":{"title":"List the actions for a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Execute an action on a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaction","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaction","metadata":{"seo":{"title":"Execute an action on a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Retrieve the principal for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewprincipaldetails","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewprincipaldetails","metadata":{"seo":{"title":"Retrieve the principal for a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/principal"},{"label":"List the access items for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccesses","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccesses","metadata":{"seo":{"title":"List the access items for a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses"},{"label":"List the sub-access items for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewsubaccesses","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewsubaccesses","metadata":{"seo":{"title":"List the sub-access items for an access item","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses"},{"label":"List the anomalies for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccessesanomalies","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccessesanomalies","metadata":{"seo":{"title":"List the anomalies for an access item","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies"},{"label":"Generate a summary for an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewaccessessummary","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewaccessessummary","metadata":{"seo":{"title":"Generate a summary for an access item","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary"},{"label":"Execute an action on an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaccessesaction","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaccessesaction","metadata":{"seo":{"title":"Execute an action on an access item","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions"},{"label":"List the history of a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewhistory","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewhistory","metadata":{"seo":{"title":"List the history of a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/history"},{"label":"Add a comment for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/addsecurityaccessreviewcomment","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/addsecurityaccessreviewcomment","metadata":{"seo":{"title":"Add a comment for a security access review","description":"
"}},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/comment"}]},{"type":"group","label":"Org Governance Settings","link":"/iga/openapi/governance-production-reference/org-governance-settings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings","items":[{"label":"Retrieve the org settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/getorgsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/getorgsettings","metadata":{"seo":{"title":"Retrieve the org settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.settings.read
Admin roles:
  • ACCESS_CERTIFICATION_ADMIN
  • ACCESS_REQUESTS_ADMIN
  • SUPER_ADMIN
"}},"httpPath":"/governance/api/v1/settings"},{"label":"Update the org settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgsettings","metadata":{"seo":{"title":"Update the org settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.settings.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/governance/api/v1/settings"},{"label":"List all org integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/listorgintegrations","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/listorgintegrations","metadata":{"seo":{"title":"List all org integrations","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.settings.read
Admin roles:
  • ACCESS_CERTIFICATION_ADMIN
  • ACCESS_REQUESTS_ADMIN
  • SUPER_ADMIN
Permissions:
  • okta.governance.settings.read
"}},"httpPath":"/governance/api/v1/settings/integrations"},{"label":"Create an org integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/createorgintegration","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/createorgintegration","metadata":{"seo":{"title":"Create an org integration","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.settings.manage
Admin roles:
  • SUPER_ADMIN
Permissions:
  • okta.governance.settings.manage
"}},"httpPath":"/governance/api/v1/settings/integrations"},{"label":"Delete an org integration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/deleteorgintegration","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/deleteorgintegration","metadata":{"seo":{"title":"Delete an org integration","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.settings.manage
Admin roles:
  • SUPER_ADMIN
Permissions:
  • okta.governance.settings.manage
"}},"httpPath":"/governance/api/v1/settings/integrations/{integrationId}"},{"label":"Retrieve the org certification settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/getorgcertificationsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/getorgcertificationsettings","metadata":{"seo":{"title":"Retrieve the org certification settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.admin.read
Admin roles:
  • ACCESS_CERTIFICATION_ADMIN
"}},"httpPath":"/governance/api/v1/settings/certification"},{"label":"Update the org certification settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgcertificationsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgcertificationsettings","metadata":{"seo":{"title":"Update the org certification settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.admin.manage
Admin roles:
  • ACCESS_CERTIFICATION_ADMIN
"}},"httpPath":"/governance/api/v1/settings/certification"}]},{"type":"group","label":"Entitlement Settings","link":"/iga/openapi/governance-production-reference/entitlement-settings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings","items":[{"label":"Update the entitlement settings for the resource","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-settings/updateentitlementsettings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings/updateentitlementsettings","metadata":{"seo":{"title":"Update the entitlement settings for the resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings"},{"label":"Retrieve the entitlement settings for the resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-settings/getentitlementsettings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings/getentitlementsettings","metadata":{"seo":{"title":"Retrieve the entitlement settings for the resource","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN
"}},"httpPath":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings"}]},{"type":"group","label":"Operations","link":"/iga/openapi/governance-production-reference/operations","routeSlug":"/iga/openapi/governance-production-reference/operations","items":[{"label":"Retrieve an operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/operations/getoperation","routeSlug":"/iga/openapi/governance-production-reference/operations/getoperation","metadata":{"seo":{"title":"Retrieve an operation","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.operations.read
Admin roles:
  • ORG_ADMIN
"}},"httpPath":"/governance/api/v1/operations/{operationId}"}]},{"type":"group","label":"Access Requests - V1","items":[{"type":"link","label":"Access Requests - V1","link":"/iga/openapi/governance-production-requests-admin-v1-reference","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference"},{"type":"group","label":"Request Types","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types","items":[{"label":"Create a request type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/createrequesttype","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/createrequesttype","metadata":{"seo":{"title":"Create a request type","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/request-types"},{"label":"List all request types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/listallrequesttypes","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/listallrequesttypes","metadata":{"seo":{"title":"List all request types","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.read
"}},"httpPath":"/governance/api/v1/request-types"},{"label":"Retrieve a request type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/getrequesttype","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/getrequesttype","metadata":{"seo":{"title":"Retrieve a request type","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/request-types/{requestTypeId}"},{"label":"Delete a request type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/deleterequesttype","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/deleterequesttype","metadata":{"seo":{"title":"Delete a request type","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/request-types/{requestTypeId}"},{"label":"Publish a request type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/publishrequesttype","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/publishrequesttype","metadata":{"seo":{"title":"Publish a request type","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/request-types/{requestTypeId}/publish"},{"label":"Unpublish a request type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/unpublishrequesttype","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/unpublishrequesttype","metadata":{"seo":{"title":"Unpublish a request type","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/request-types/{requestTypeId}/un-publish"},{"label":"List all teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/listallrequestteams","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/listallrequestteams","metadata":{"seo":{"title":"List all teams","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/teams"}]},{"type":"group","label":"Requests","link":"/iga/openapi/governance-production-requests-admin-v1-reference/requests","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/requests","items":[{"label":"List all requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/listallrequests","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/listallrequests","metadata":{"seo":{"title":"List all requests","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/requests"},{"label":"Create a request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequest","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequest","metadata":{"seo":{"title":"Create a request","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/requests"},{"label":"Retrieve a request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/getrequest","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/getrequest","metadata":{"seo":{"title":"Retrieve a request","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/requests/{requestId}"},{"label":"Create a Message for a Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequestmessage","routeSlug":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequestmessage","metadata":{"seo":{"title":"Create a Message for a Request","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.accessRequests.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v1/requests/{requestId}/messages"}]}]},{"type":"group","label":"Access Requests - V2","items":[{"type":"link","label":"Access Requests - V2","link":"/iga/openapi/governance-production-requests-admin-v2-reference","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference"},{"type":"group","label":"Request Conditions","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions","items":[{"label":"List all resource request conditions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/listresourcerequestconditionsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/listresourcerequestconditionsv2","metadata":{"seo":{"title":"List all resource request conditions","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions"},{"label":"Create a request condition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/createresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/createresourcerequestconditionv2","metadata":{"seo":{"title":"Create a request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions"},{"label":"Retrieve a resource request condition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/getresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/getresourcerequestconditionv2","metadata":{"seo":{"title":"Retrieve a resource request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}"},{"label":"Delete a request condition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/deleteresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/deleteresourcerequestconditionv2","metadata":{"seo":{"title":"Delete a request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}"},{"label":"Update the request condition","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/updateresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/updateresourcerequestconditionv2","metadata":{"seo":{"title":"Update the request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}"},{"label":"Activate the request condition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/activateresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/activateresourcerequestconditionv2","metadata":{"seo":{"title":"Activate the request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}/activate"},{"label":"Deactivate the request condition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/deactivateresourcerequestconditionv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions/deactivateresourcerequestconditionv2","metadata":{"seo":{"title":"Deactivate the request condition","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}/deactivate"}]},{"type":"group","label":"Request Sequences","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences","items":[{"label":"List all resource request sequences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/listresourcerequestsequencesv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/listresourcerequestsequencesv2","metadata":{"seo":{"title":"List all resource request sequences","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-sequences"},{"label":"Retrieve a resource request sequence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/getresourcerequestsequencev2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/getresourcerequestsequencev2","metadata":{"seo":{"title":"Retrieve a resource request sequence","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-sequences/{sequenceId}"},{"label":"Delete a request sequence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/deleterequestsequencev2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences/deleterequestsequencev2","metadata":{"seo":{"title":"Delete a request sequence","description":"
"}},"httpPath":"/governance/api/v2/request-sequences/{sequenceId}"}]},{"type":"group","label":"Request Settings","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings","items":[{"label":"Retrieve the resource request settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/getrequestsettingsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/getrequestsettingsv2","metadata":{"seo":{"title":"Retrieve the resource request settings","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-settings"},{"label":"Update the resource request settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/updateresourcerequestsettingsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/updateresourcerequestsettingsv2","metadata":{"seo":{"title":"Update the resource request settings","description":"
"}},"httpPath":"/governance/api/v2/resources/{resourceId}/request-settings"},{"label":"Retrieve the org request settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/getorgrequestsettingsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/getorgrequestsettingsv2","metadata":{"seo":{"title":"Retrieve the org request settings","description":"
"}},"httpPath":"/governance/api/v2/request-settings"},{"label":"Update the org request settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/updateorgrequestsettingsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings/updateorgrequestsettingsv2","metadata":{"seo":{"title":"Update the org request settings","description":"
"}},"httpPath":"/governance/api/v2/request-settings"}]},{"type":"group","label":"Requests","link":"/iga/openapi/governance-production-requests-admin-v2-reference/requests","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/requests","items":[{"label":"List all requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/listallrequestsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/listallrequestsv2","metadata":{"seo":{"title":"List all requests","description":"
"}},"httpPath":"/governance/api/v2/requests"},{"label":"Create a request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/createrequestv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/createrequestv2","metadata":{"seo":{"title":"Create a request","description":"
"}},"httpPath":"/governance/api/v2/requests"},{"label":"Retrieve a request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/getrequestv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/getrequestv2","metadata":{"seo":{"title":"Retrieve a request","description":"
"}},"httpPath":"/governance/api/v2/requests/{requestId}"},{"label":"Create a request message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/createrequestmessagev2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/requests/createrequestmessagev2","metadata":{"seo":{"title":"Create a request message","description":"
"}},"httpPath":"/governance/api/v2/requests/{requestId}/messages"}]},{"type":"group","label":"Catalogs","link":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs","items":[{"label":"List all entries for the default access request catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/listalldefaultentriesv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/listalldefaultentriesv2","metadata":{"seo":{"title":"List all entries for the default access request catalog","description":"
Early Access
OAuth 2.0 scope:
  • okta.accessRequests.catalog.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/catalogs/default/entries"},{"label":"Retrieve a catalog entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/getcatalogentryv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/getcatalogentryv2","metadata":{"seo":{"title":"Retrieve a catalog entry","description":"
Early Access
OAuth 2.0 scope:
  • okta.accessRequests.catalog.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/catalogs/default/entries/{entryId}"},{"label":"List all access request catalog entries for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/listalldefaultuserentriesv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/listalldefaultuserentriesv2","metadata":{"seo":{"title":"List all access request catalog entries for a user","description":"
"}},"httpPath":"/governance/api/v2/catalogs/default/user/{userId}/entries"},{"label":"Retrieve the request fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/getcatalogentryrequestfieldsv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/catalogs/getcatalogentryrequestfieldsv2","metadata":{"seo":{"title":"Retrieve the request fields","description":"
"}},"httpPath":"/governance/api/v2/catalogs/default/entries/{entryId}/users/{userId}/request-fields"}]},{"type":"group","label":"Tasks","link":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks","items":[{"label":"List all tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/listalltasksv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/listalltasksv2","metadata":{"seo":{"title":"List all tasks","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/tasks"},{"label":"Retrieve a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/gettaskv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/gettaskv2","metadata":{"seo":{"title":"Retrieve a task","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.read
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/tasks/{taskId}"},{"label":"Update a task","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/updatetaskv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/updatetaskv2","metadata":{"seo":{"title":"Update a task","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/tasks/{taskId}"},{"label":"Resolve a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/resolvetaskv2","routeSlug":"/iga/openapi/governance-production-requests-admin-v2-reference/tasks/resolvetaskv2","metadata":{"seo":{"title":"Resolve a task","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN
"}},"httpPath":"/governance/api/v2/tasks/{taskId}/resolve"}]}]}],"expanded":"true"},{"type":"group","label":"End user APIs","items":[{"type":"link","label":"Okta Enduser Governance API","link":"/iga/openapi/governance-production-enduser-reference","routeSlug":"/iga/openapi/governance-production-enduser-reference"},{"type":"group","label":"My Requests","link":"/iga/openapi/governance-production-enduser-reference/my-requests","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-requests","items":[{"label":"Create a request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-requests/createmyrequestv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-requests/createmyrequestv2","metadata":{"seo":{"title":"Create a request","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}/requests"},{"label":"Retrieve my request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-requests/getmyrequestv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-requests/getmyrequestv2","metadata":{"seo":{"title":"Retrieve my request","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}/requests/{requestId}"}]},{"type":"group","label":"My Catalogs","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs","items":[{"label":"List my entries for the default access request catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs/listmydefaultentriesv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs/listmydefaultentriesv2","metadata":{"seo":{"title":"List my entries for the default access request catalog","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries"},{"label":"Retrieve my catalog entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmyentryv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmyentryv2","metadata":{"seo":{"title":"Retrieve my catalog entry","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}"},{"label":"Retrieve the request fields for my catalog entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmycatalogentryrequestfieldsv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmycatalogentryrequestfieldsv2","metadata":{"seo":{"title":"Retrieve the request fields for my catalog entry","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}/request-fields"},{"label":"List my catalog entry users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs/listmyentryusersv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs/listmyentryusersv2","metadata":{"seo":{"title":"List my catalog entry users","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}/users"},{"label":"Retrieve the entry request fields for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmycatalogentryuserrequestfieldsv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-catalogs/getmycatalogentryuserrequestfieldsv2","metadata":{"seo":{"title":"Retrieve the entry request fields for a user","description":"
"}},"httpPath":"/governance/api/v2/my/catalogs/default/entries/{entryId}/users/{userId}/request-fields"}]},{"type":"group","label":"My Tasks","link":"/iga/openapi/governance-production-enduser-reference/my-tasks","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-tasks","items":[{"label":"List all my tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-tasks/listallmytasksv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-tasks/listallmytasksv2","metadata":{"seo":{"title":"List all my tasks","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.read
"}},"httpPath":"/governance/api/v2/my/tasks"},{"label":"Retrieve my task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-tasks/getmytaskv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-tasks/getmytaskv2","metadata":{"seo":{"title":"Retrieve my task","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.read
"}},"httpPath":"/governance/api/v2/my/tasks/{taskId}"},{"label":"Resolve my task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-tasks/resolvemytaskv2","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-tasks/resolvemytaskv2","metadata":{"seo":{"title":"Resolve my task","description":"
Beta
OAuth 2.0 scope:
  • okta.accessRequests.tasks.manage
"}},"httpPath":"/governance/api/v2/my/tasks/{taskId}/resolve"}]},{"type":"group","label":"My Security Access Reviews","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews","items":[{"label":"List the security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviews","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviews","metadata":{"seo":{"title":"List the security access reviews","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews"},{"label":"Retrieve the statistics for security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreviewsstats","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreviewsstats","metadata":{"seo":{"title":"Retrieve the statistics for security access reviews","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/stats"},{"label":"Retrieve a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreview","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreview","metadata":{"seo":{"title":"Retrieve a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}"},{"label":"Generate a summary for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/generatemysecurityaccessreviewsummary","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/generatemysecurityaccessreviewsummary","metadata":{"seo":{"title":"Generate a summary for a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/summary"},{"label":"List all actions for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewactions","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewactions","metadata":{"seo":{"title":"List all actions for a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Execute an action on a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/executemysecurityaccessreviewaction","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/executemysecurityaccessreviewaction","metadata":{"seo":{"title":"Execute an action on a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Retrieve the principal for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreviewprincipaldetails","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/getmysecurityaccessreviewprincipaldetails","metadata":{"seo":{"title":"Retrieve the principal for a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/principal"},{"label":"List the access items for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewaccesses","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewaccesses","metadata":{"seo":{"title":"List the access items for a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/accesses"},{"label":"List the sub-access items for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewsubaccesses","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewsubaccesses","metadata":{"seo":{"title":"List the sub-access items for an access item","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses"},{"label":"List the anomalies for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewaccessesanomalies","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewaccessesanomalies","metadata":{"seo":{"title":"List the anomalies for an access item","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies"},{"label":"Generate a summary for an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/generatemysecurityaccessreviewaccessessummary","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/generatemysecurityaccessreviewaccessessummary","metadata":{"seo":{"title":"Generate a summary for an access item","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary"},{"label":"Execute an action on an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/executemysecurityaccessreviewaccessesaction","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/executemysecurityaccessreviewaccessesaction","metadata":{"seo":{"title":"Execute an action on an access item","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions"},{"label":"List the history of a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewhistory","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/listmysecurityaccessreviewhistory","metadata":{"seo":{"title":"List the history of a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/history"},{"label":"Add a comment for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/addmysecurityaccessreviewcomment","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-security-access-reviews/addmysecurityaccessreviewcomment","metadata":{"seo":{"title":"Add a comment for a security access review","description":"
"}},"httpPath":"/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/comment"}]},{"type":"group","label":"My Access Certification Reviews","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews","items":[{"label":"List all resource connections for my review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/listmyresourceconnections","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/listmyresourceconnections","metadata":{"seo":{"title":"List all resource connections for my review","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.reviewer.read
"}},"httpPath":"/governance/api/v1/my/campaigns/{campaignId}/reviews/{reviewId}/agent-resource-connections/{agentId}"},{"label":"Submit a bulk-review decision","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/submitcampaignbulkdecisions","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/submitcampaignbulkdecisions","metadata":{"seo":{"title":"Submit a bulk-review decision","description":"
"}},"httpPath":"/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions"},{"label":"Retrieve the status of a bulk-review submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/getcampaignbulkdecisionsjobstatus","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/getcampaignbulkdecisionsjobstatus","metadata":{"seo":{"title":"Retrieve the status of a bulk-review submission","description":"
"}},"httpPath":"/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions/jobs/{jobId}"},{"label":"List my reviews for a campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/listcampaignreviews","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/listcampaignreviews","metadata":{"seo":{"title":"List my reviews for a campaign","description":"
"}},"httpPath":"/governance/api/v1/my/campaigns/{campaignId}/reviews"},{"label":"Submit my review actions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/submitmycampaignreviewactions","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-access-certification-reviews/submitmycampaignreviewactions","metadata":{"seo":{"title":"Submit my review actions","description":"
"}},"httpPath":"/governance/api/v1/my/campaigns/{campaignId}/reviews/actions"}]},{"type":"group","label":"My Settings","link":"/iga/openapi/governance-production-enduser-reference/my-settings","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-settings","items":[{"label":"Retrieve my settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-settings/getmysettings","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-settings/getmysettings","metadata":{"seo":{"title":"Retrieve my settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.principalSettings.read
"}},"httpPath":"/governance/api/v1/my/settings"},{"label":"Update my settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-settings/updatemysettings","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-settings/updatemysettings","metadata":{"seo":{"title":"Update my settings","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.principalSettings.manage
"}},"httpPath":"/governance/api/v1/my/settings"},{"label":"List my eligible delegates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-enduser-reference/my-settings/listmydelegateusers","routeSlug":"/iga/openapi/governance-production-enduser-reference/my-settings/listmydelegateusers","metadata":{"seo":{"title":"List my eligible delegates","description":"
Beta
OAuth 2.0 scope:
  • okta.governance.principalSettings.read
"}},"httpPath":"/governance/api/v1/my/settings/delegate/users"}]}],"expanded":"true"}],"menuStyle":"drilldown"},{"type":"group","label":"Okta for AI Agents","items":[{"type":"link","fsPath":"secures-ai/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/secures-ai","routeSlug":"/secures-ai"},{"type":"link","fsPath":"secures-ai/ai-agents.md","metadata":{"type":"markdown"},"label":"AI Agents","link":"/secures-ai/ai-agents","routeSlug":"/secures-ai/ai-agents"},{"type":"link","fsPath":"secures-ai/mcp-servers.md","metadata":{"type":"markdown"},"label":"MCP Servers","link":"/secures-ai/mcp-servers","routeSlug":"/secures-ai/mcp-servers"},{"type":"group","label":"Resource Servers","items":[{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration","label":"Agent-to-Agent Server Registrations","items":[{"type":"group","label":"Agent-to-Agent Server Registrations","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/a2aserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/a2aserverregistration","items":[]},{"label":"List all A2A servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/lista2aservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/lista2aservers","metadata":{"seo":{"title":"List all A2A servers","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers"},{"label":"Retrieve an A2A server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/geta2aserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/geta2aserver","metadata":{"seo":{"title":"Retrieve an A2A server","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers/{a2aServerId}"},{"label":"List all authorization servers for an A2A server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/lista2aserverauthorizationservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/lista2aserverauthorizationservers","metadata":{"seo":{"title":"List all authorization servers for an A2A server","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
  • okta.authorizationServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers/{a2aServerId}/authorization-servers"},{"label":"Add an authorization server to an A2A server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/adda2aserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/adda2aserverauthorizationserver","metadata":{"seo":{"title":"Add an authorization server to an A2A server","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
  • okta.authorizationServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers/{a2aServerId}/authorization-servers"},{"label":"Retrieve an authorization server for an A2A server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/geta2aserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/geta2aserverauthorizationserver","metadata":{"seo":{"title":"Retrieve an authorization server for an A2A server","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
  • okta.authorizationServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers/{a2aServerId}/authorization-servers/{authorizationServerId}"},{"label":"Remove an authorization server from an A2A server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/removea2aserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/a2aserverregistration/other/removea2aserverauthorizationserver","metadata":{"seo":{"title":"Remove an authorization server from an A2A server","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
  • okta.authorizationServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/a2a-servers/{a2aServerId}/authorization-servers/{authorizationServerId}"}],"metadata":{"type":"openapi","title":"Agent-to-Agent Server Registrations","description":"The Agent-to-Agent (A2A) Server Registrations API provides read-only operations for A2A servers and management operations for their associated authorization servers. An A2A server represents the resource server identity of an AI agent in agent-to-agent deployments, which are identified by a `resourceUrl`.\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration","label":"API Server Registrations","items":[{"type":"group","label":"API Server Registrations","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/apiserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/apiserverregistration","items":[]},{"label":"List all API servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/listapiservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/listapiservers","metadata":{"seo":{"title":"List all API servers","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers"},{"label":"Register an API server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/registerapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/registerapiserver","metadata":{"seo":{"title":"Register an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers"},{"label":"Retrieve an API server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/getapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/getapiserver","metadata":{"seo":{"title":"Retrieve an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}"},{"label":"Update an API server","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/updateapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/updateapiserver","metadata":{"seo":{"title":"Update an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}"},{"label":"Delete an API server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/deleteapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/deleteapiserver","metadata":{"seo":{"title":"Delete an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}"},{"label":"List all authorization servers for an API server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/listapiserverauthorizationservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/listapiserverauthorizationservers","metadata":{"seo":{"title":"List all authorization servers for an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/authorization-servers"},{"label":"Add an authorization server to an API server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/addapiserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/addapiserverauthorizationserver","metadata":{"seo":{"title":"Add an authorization server to an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/authorization-servers"},{"label":"Retrieve an authorization server for an API server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/getapiserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/getapiserverauthorizationserver","metadata":{"seo":{"title":"Retrieve an authorization server for an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/authorization-servers/{authorizationServerId}"},{"label":"Update an authorization server for an API server","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/updateapiserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/updateapiserverauthorizationserver","metadata":{"seo":{"title":"Update an authorization server for an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/authorization-servers/{authorizationServerId}"},{"label":"Remove an authorization server from an API server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/removeapiserverauthorizationserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/removeapiserverauthorizationserver","metadata":{"seo":{"title":"Remove an authorization server from an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/authorization-servers/{authorizationServerId}"},{"label":"Activate an API server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/activateapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/activateapiserver","metadata":{"seo":{"title":"Activate an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/lifecycle/activate"},{"label":"Deactivate an API server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/deactivateapiserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/apiserverregistration/other/deactivateapiserver","metadata":{"seo":{"title":"Deactivate an API server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.apiServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/api-servers/{apiServerId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"API Server Registrations","description":"The API Server Registrations API provides registration and management operations for third-party API servers as resource servers. An API server is a third-party REST API that AI agents can authenticate to and access as a resource server.\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration","label":"MCP Server Registrations","items":[{"type":"group","label":"MCP Server Registrations","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/mcpserverregistration","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/mcpserverregistration","items":[]},{"label":"List all MCP servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/listmcpservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/listmcpservers","metadata":{"seo":{"title":"List all MCP servers","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers"},{"label":"Register an MCP server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/registermcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/registermcpserver","metadata":{"seo":{"title":"Register an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers"},{"label":"Retrieve an MCP server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/getmcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/getmcpserver","metadata":{"seo":{"title":"Retrieve an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}"},{"label":"Update an MCP server","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/updatemcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/updatemcpserver","metadata":{"seo":{"title":"Update an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}"},{"label":"Delete an MCP server","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/deletemcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/deletemcpserver","metadata":{"seo":{"title":"Delete an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}"},{"label":"List all authorization servers for an MCP server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/listmcpserverauthorizationservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/listmcpserverauthorizationservers","metadata":{"seo":{"title":"List all authorization servers for an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}/authorization-servers"},{"label":"Activate an MCP server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/activatemcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/activatemcpserver","metadata":{"seo":{"title":"Activate an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}/lifecycle/activate"},{"label":"Deactivate an MCP server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/deactivatemcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/deactivatemcpserver","metadata":{"seo":{"title":"Deactivate an MCP server","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}/lifecycle/deactivate"},{"label":"Refresh the MCP server metadata","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/refreshmcpservermetadata","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/mcpserverregistration/other/refreshmcpservermetadata","metadata":{"seo":{"title":"Refresh the MCP server metadata","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.mcpServers.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/mcp-servers/{mcpServerId}/metadata/refresh"}],"metadata":{"type":"openapi","title":"MCP Server Registrations","description":"The Model Context Protocol (MCP) Server Registrations API provides registration and lifecycle management operations for third-party MCP servers. See [MCP Servers](/secures-ai/mcp-servers).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings","label":"Client Authentication Settings","items":[{"type":"group","label":"Client Authentication Settings","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/resourceserverclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/resourceserverclientauthsettings","items":[]},{"label":"List all client authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/listclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/listclientauthsettings","metadata":{"seo":{"title":"List all client authentication settings","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.clientAuthSettings.read
  • okta.resourceServers.mcpServers.read
  • okta.resourceServers.virtualMcpServers.read
  • okta.resourceServers.apiServers.read
  • okta.resourceServers.read
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/client-auth-settings"},{"label":"Create a client authentication settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/createclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/createclientauthsettings","metadata":{"seo":{"title":"Create a client authentication settings","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.clientAuthSettings.manage
  • okta.resourceServers.mcpServers.manage
  • okta.resourceServers.virtualMcpServers.manage
  • okta.resourceServers.apiServers.manage
  • okta.resourceServers.manage
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/client-auth-settings"},{"label":"Get client authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/getclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/getclientauthsettings","metadata":{"seo":{"title":"Get client authentication settings","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.clientAuthSettings.read
  • okta.resourceServers.mcpServers.read
  • okta.resourceServers.virtualMcpServers.read
  • okta.resourceServers.apiServers.read
  • okta.resourceServers.read
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/client-auth-settings/{clientAuthSettingsId}"},{"label":"Update client authentication settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/updateclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/updateclientauthsettings","metadata":{"seo":{"title":"Update client authentication settings","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.clientAuthSettings.manage
  • okta.resourceServers.mcpServers.manage
  • okta.resourceServers.virtualMcpServers.manage
  • okta.resourceServers.apiServers.manage
  • okta.resourceServers.manage
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/client-auth-settings/{clientAuthSettingsId}"},{"label":"Delete client authentication settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/deleteclientauthsettings","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserverclientauthsettings/other/deleteclientauthsettings","metadata":{"seo":{"title":"Delete client authentication settings","description":"
Beta
OAuth 2.0 scope:
  • okta.resourceServers.clientAuthSettings.manage
  • okta.resourceServers.mcpServers.manage
  • okta.resourceServers.virtualMcpServers.manage
  • okta.resourceServers.apiServers.manage
  • okta.resourceServers.manage
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/resource-servers/api/v1/client-auth-settings/{clientAuthSettingsId}"}],"metadata":{"type":"openapi","title":"Client Authentication Settings","description":"The Client Authentication Settings API provides management of client configuration for authenticating to third-party authorization servers. This can include the configuration of scopes that are requested from the third-party authorization server that the user must provide consent to, as well as the client credentials that are used to complete the authorization code flow.\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource","label":"Virtual MCP Servers","items":[{"type":"group","label":"Virtual MCP Servers","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/virtualmcpserverresource","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/virtualmcpserverresource","items":[]},{"label":"List all virtual MCP servers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/listvirtualmcpservers","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/listvirtualmcpservers","metadata":{"seo":{"title":"List all virtual MCP servers","description":"
"}},"httpPath":"/resource-servers/api/v1/virtual-mcp-servers"},{"label":"Retrieve a virtual MCP server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/getvirtualmcpserver","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/getvirtualmcpserver","metadata":{"seo":{"title":"Retrieve a virtual MCP server","description":"
"}},"httpPath":"/resource-servers/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"List all tools for a virtual MCP server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/listvirtualmcpservertools","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/listvirtualmcpservertools","metadata":{"seo":{"title":"List all tools for a virtual MCP server","description":"
"}},"httpPath":"/resource-servers/api/v1/virtual-mcp-servers/{virtualMcpServerId}/tools"},{"label":"Retrieve a specific tool for a virtual MCP server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/getvirtualmcpservertool","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/virtualmcpserverresource/other/getvirtualmcpservertool","metadata":{"seo":{"title":"Retrieve a specific tool for a virtual MCP server","description":"
"}},"httpPath":"/resource-servers/api/v1/virtual-mcp-servers/{virtualMcpServerId}/tools/{capabilityId}"}],"metadata":{"type":"openapi","title":"Virtual MCP Servers","description":"The Virtual MCP Servers API provides operations for read access for virtual MCP servers registered as resource servers. See [MCP Servers](/secures-ai/mcp-servers).\n\n> **Note:** This API, which is available as a [Research Release](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/release-lifecycle/#research-release), is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}}]},{"type":"group","label":"STS Authorization","items":[{"type":"group","fsPath":"secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization.yaml","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization","label":"STSAuthorization","items":[{"type":"group","label":"STSAuthorization","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization/stsauthorization","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization/stsauthorization","items":[]},{"label":"Handle the STS authorization response","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization/other/stsauthorizecallback","routeSlug":"/secures-ai/openapi/secures-ai-resource-servers/tags/stsauthorization/other/stsauthorizecallback","metadata":{"seo":{"title":"Handle the STS authorization response","description":"
Beta
"}},"httpPath":"/oauth2/v1/sts/callback"}],"metadata":{"type":"openapi","title":"STSAuthorization"}}]},{"type":"group","label":"Workload Principals","items":[{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections","label":"Potential Connections","items":[{"type":"group","label":"Potential Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/agentpotentialconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/agentpotentialconnections","items":[]},{"label":"List all potential connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/other/listpotentialconnectionsbytype","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/other/listpotentialconnectionsbytype","metadata":{"seo":{"title":"List all potential connections","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/potential-connections"}],"metadata":{"type":"openapi","title":"Potential Connections","description":"The Potential Connections API provides operations that allow you to discover resources for AI agent resource connections. Discoverable resources include those already known to Okta, such as custom authorization servers in your org. See [AI agent resource connections](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent-secure).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections","label":"AI Agent Connections","items":[{"type":"group","label":"AI Agent Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/agentconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/agentconnections","items":[]},{"label":"List all AI agent connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/listconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/listconnections","metadata":{"seo":{"title":"List all AI agent connections","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections"},{"label":"Create a resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/createresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/createresourceconnection","metadata":{"seo":{"title":"Create a resource connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections"},{"label":"Retrieve an AI agent connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/getresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/getresourceconnection","metadata":{"seo":{"title":"Retrieve an AI agent connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Update a resource connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/updateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/updateresourceconnection","metadata":{"seo":{"title":"Update a resource connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Delete an AI agent connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/deleteresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/deleteresourceconnection","metadata":{"seo":{"title":"Delete an AI agent connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Activate an AI agent resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/activateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/activateresourceconnection","metadata":{"seo":{"title":"Activate an AI agent resource connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/activate"},{"label":"Deactivate an AI agent resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/deactivateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/deactivateresourceconnection","metadata":{"seo":{"title":"Deactivate an AI agent resource connection","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"AI Agent Connections","description":"The AI Agent Connections API provides connection management operations between AI agents and resources. After registering an AI agent, you can set up a resource connection to define the resources that your AI agent can access. See [AI agent resource connections](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent-secure).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey","label":"AI Agent Credentials","items":[{"type":"group","label":"AI Agent Credentials","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/agentpublickey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/agentpublickey","items":[]},{"label":"List all AI agent JSON Web Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/listagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/listagentjwk","metadata":{"seo":{"title":"List all AI agent JSON Web Keys","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks"},{"label":"Add a JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/addagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/addagentjwk","metadata":{"seo":{"title":"Add a JSON Web Key","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks"},{"label":"Retrieve an AI agent JSON Web Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/getagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/getagentjwk","metadata":{"seo":{"title":"Retrieve an AI agent JSON Web Key","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}"},{"label":"Delete an AI agent JSON Web Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/deleteagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/deleteagentjwk","metadata":{"seo":{"title":"Delete an AI agent JSON Web Key","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}"},{"label":"Activate an AI agent JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/activateagentjsonwebkey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/activateagentjsonwebkey","metadata":{"seo":{"title":"Activate an AI agent JSON Web Key","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/activate"},{"label":"Deactivate an AI agent JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/deactivateagentjsonwebkey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpublickey/other/deactivateagentjsonwebkey","metadata":{"seo":{"title":"Deactivate an AI agent JSON Web Key","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"AI Agent Credentials","description":"The AI Agent Public Keys API provides a set of operations to manage public [JSON Web Key](https://datatracker.ietf.org/doc/html/rfc7517) (JWK) credentials that are used for AI agents. See [Manage AI agents](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent).\n\nA JWK 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.\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration","label":"AI Agent Registrations","items":[{"type":"group","label":"AI Agent Registrations","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/agentregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/agentregistration","items":[]},{"label":"List all AI agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/listaiagents","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/listaiagents","metadata":{"seo":{"title":"List all AI agents","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents"},{"label":"Register an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/registeraiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/registeraiagent","metadata":{"seo":{"title":"Register an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents"},{"label":"Retrieve an AI agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/getaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/getaiagent","metadata":{"seo":{"title":"Retrieve an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Replace an AI agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/replaceaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/replaceaiagent","metadata":{"seo":{"title":"Replace an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Update an AI agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/updateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/updateaiagent","metadata":{"seo":{"title":"Update an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Delete an AI agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/deleteaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/deleteaiagent","metadata":{"seo":{"title":"Delete an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Activate an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/activateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/activateaiagent","metadata":{"seo":{"title":"Activate an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/activate"},{"label":"Deactivate an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/deactivateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentregistration/other/deactivateaiagent","metadata":{"seo":{"title":"Deactivate an AI agent","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"AI Agent Registrations","description":"The AI Agent Registrations API provides registration and lifecycle management operations for AI agents. A single app can have multiple AI agents linked to it. See [Register an AI agent](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent-register).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations","label":"Workload Principal Operations","items":[{"type":"group","label":"Workload Principal Operations","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/workloadprincipaloperations","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/workloadprincipaloperations","items":[]},{"label":"List all workload principal operations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/other/listworkloadprincipaloperations","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/other/listworkloadprincipaloperations","metadata":{"seo":{"title":"List all workload principal operations","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/operations"},{"label":"Retrieve a workload principal operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/other/getworkloadprincipaloperation","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/workloadprincipaloperations/other/getworkloadprincipaloperation","metadata":{"seo":{"title":"Retrieve a workload principal operation","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/operations/{operationId}"}],"metadata":{"type":"openapi","title":"Workload Principal Operations","description":"The Workload Principal Operations API provides operations management operations for workload principals, including AI agents. An operation represents an asynchronous task performed by Okta for a workload principal, such as establishing a connection to a resource server. Operations have a status that you can query to check the progress of the task. For the API related to resource server operations, see [Resource server operations](/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserveroperations).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders","label":"AI Agent Providers","items":[{"type":"group","label":"AI Agent Providers","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/agentproviders","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/agentproviders","items":[]},{"label":"List all AI agent providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/listaiagentproviders","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/listaiagentproviders","metadata":{"seo":{"title":"List all AI agent providers","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers"},{"label":"Create an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/createaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/createaiagentprovider","metadata":{"seo":{"title":"Create an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers"},{"label":"Validate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/validateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/validateaiagentprovider","metadata":{"seo":{"title":"Validate an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/validate"},{"label":"Retrieve an AI agent provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/getaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/getaiagentprovider","metadata":{"seo":{"title":"Retrieve an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Replace an AI agent provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/replaceaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/replaceaiagentprovider","metadata":{"seo":{"title":"Replace an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Update an AI agent provider","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/updateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/updateaiagentprovider","metadata":{"seo":{"title":"Update an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Delete an AI agent provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/deleteaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/deleteaiagentprovider","metadata":{"seo":{"title":"Delete an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Start the import of an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/startaiagentproviderimport","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/startaiagentproviderimport","metadata":{"seo":{"title":"Start the import of an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/import"},{"label":"Activate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/activateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/activateaiagentprovider","metadata":{"seo":{"title":"Activate an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/activate"},{"label":"Deactivate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/deactivateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentproviders/other/deactivateaiagentprovider","metadata":{"seo":{"title":"Deactivate an AI agent provider","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"AI Agent Providers","description":"The AI Agent Providers API provides operations to help manage integrations that allow AI agents from external platforms to be imported and registered in Okta's AI Agents registry in Universal Directory. See [AI agent imports](https://okta-help.pixtulate.com/okta_help.htm?type=oie&id=ai-agent-imports).\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks","label":"Delegation Links","items":[{"type":"group","label":"Delegation Links","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/delegationlinks","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/delegationlinks","items":[]},{"label":"List all delegation links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/listdelegationlinks","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/listdelegationlinks","metadata":{"seo":{"title":"List all delegation links","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/delegation-links"},{"label":"Create a delegation link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/createdelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/createdelegationlink","metadata":{"seo":{"title":"Create a delegation link","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/delegation-links"},{"label":"Retrieve a delegation link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/getdelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/getdelegationlink","metadata":{"seo":{"title":"Retrieve a delegation link","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/delegation-links/{delegationLinkId}"},{"label":"Delete a delegation link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/deletedelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks/other/deletedelegationlink","metadata":{"seo":{"title":"Delete a delegation link","description":"
Beta
OAuth 2.0 scope:
  • okta.aiAgents.manage
Admin roles:
  • SUPER_ADMIN
"}},"httpPath":"/workload-principals/api/v1/delegation-links/{delegationLinkId}"}],"metadata":{"type":"openapi","title":"Delegation Links","description":"The Delegation Links API provides operations for managing delegation links. A delegation link is a security control that defines whether delegation from one entity to another is allowed. Each link specifies a `from` source and a `to` target, expressed in terms of the entities that customers manage in Okta. For example, a delegation link can allow a web client to delegate authority to an AI agent, or allow one AI agent to delegate to another.\n\n> **Note:** This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections","label":"Virtual MCP Connections","items":[{"type":"group","label":"Virtual MCP Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/virtualmcpconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/virtualmcpconnections","items":[]},{"label":"List all virtual MCP connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/listvirtualmcpconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/listvirtualmcpconnections","metadata":{"seo":{"title":"List all virtual MCP connections","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections"},{"label":"Create a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/createvirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/createvirtualmcpconnection","metadata":{"seo":{"title":"Create a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections"},{"label":"Retrieve a virtual MCP connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/getvirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/getvirtualmcpconnection","metadata":{"seo":{"title":"Retrieve a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"Update a virtual MCP connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/updatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/updatevirtualmcpconnection","metadata":{"seo":{"title":"Update a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"Delete a virtual MCP connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/deletevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/deletevirtualmcpconnection","metadata":{"seo":{"title":"Delete a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"List all capabilities for a virtual MCP connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/listvirtualmcpconnectioncapabilities","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/listvirtualmcpconnectioncapabilities","metadata":{"seo":{"title":"List all capabilities for a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Add a capability to a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/addvirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/addvirtualmcpconnectioncapability","metadata":{"seo":{"title":"Add a capability to a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Replace all capabilities for a virtual MCP connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/replacevirtualmcpconnectioncapabilities","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/replacevirtualmcpconnectioncapabilities","metadata":{"seo":{"title":"Replace all capabilities for a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Retrieve a specific capability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/getvirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/getvirtualmcpconnectioncapability","metadata":{"seo":{"title":"Retrieve a specific capability","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Update a specific capability","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/updatevirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/updatevirtualmcpconnectioncapability","metadata":{"seo":{"title":"Update a specific capability","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Remove a specific capability from a virtual MCP connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/removevirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/removevirtualmcpconnectioncapability","metadata":{"seo":{"title":"Remove a specific capability from a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Activate a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/activatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/activatevirtualmcpconnection","metadata":{"seo":{"title":"Activate a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/activate"},{"label":"Deactivate a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/deactivatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpconnections/other/deactivatevirtualmcpconnection","metadata":{"seo":{"title":"Deactivate a virtual MCP connection","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Virtual MCP Connections","description":"The Virtual MCP Connections API provides connection management operations between virtual MCP servers and downstream resource servers. See [Virtual MCP Settings](/openapi/secures-ai-wlp-virtual-mcp-servers/virtualmcpsettings) for supported connection types and [MCP Servers](/secures-ai/mcp-servers).\n\n> **Note:** This API, which is available as a [Research Release](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/release-lifecycle#research-release), is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration","label":"Virtual MCP Server Registrations","items":[{"type":"group","label":"Virtual MCP Server Registrations","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/virtualmcpregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/virtualmcpregistration","items":[]},{"label":"List all virtual MCPs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/listvirtualmcps","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/listvirtualmcps","metadata":{"seo":{"title":"List all virtual MCPs","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers"},{"label":"Create a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/createvirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/createvirtualmcp","metadata":{"seo":{"title":"Create a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers"},{"label":"Retrieve a virtual MCP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/getvirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/getvirtualmcp","metadata":{"seo":{"title":"Retrieve a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Update a virtual MCP","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/updatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/updatevirtualmcp","metadata":{"seo":{"title":"Update a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Delete a virtual MCP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/deletevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/deletevirtualmcp","metadata":{"seo":{"title":"Delete a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Activate a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/activatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/activatevirtualmcp","metadata":{"seo":{"title":"Activate a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/activate"},{"label":"Deactivate a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/deactivatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpregistration/other/deactivatevirtualmcp","metadata":{"seo":{"title":"Deactivate a virtual MCP","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/deactivate"}],"metadata":{"type":"openapi","title":"Virtual MCP Server Registrations","description":"The Virtual Model Context Protocol (MCP) Server Registrations API provides registration and lifecycle management operations for virtual MCPs. A virtual MCP serves as a consolidated interface for multiple underlying resource servers as a single, unified MCP to an AI agent. See [MCP Servers](/secures-ai/mcp-servers).\n\n> **Note:** This API, which is available as a [Research Release](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/release-lifecycle/#research-release), is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}},{"type":"group","fsPath":"secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings.yaml","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings","label":"Virtual MCP Settings","items":[{"type":"group","label":"Virtual MCP Settings","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings/virtualmcpsettings","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings/virtualmcpsettings","items":[]},{"label":"Retrieve the Virtual MCP Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings/other/getvirtualmcpsettings","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/tags/virtualmcpsettings/other/getvirtualmcpsettings","metadata":{"seo":{"title":"Retrieve the Virtual MCP Settings","description":"
"}},"httpPath":"/workload-principals/api/v1/virtual-mcp-settings"}],"metadata":{"type":"openapi","title":"Virtual MCP Settings","description":"The Virtual MCP Settings API provides operations for org-level configuration and limits for virtual MCPs. See [MCP Servers](/secures-ai/mcp-servers).\n\n> **Note:** This API, which is available as a [Research Release](https://okta-developer.pixtulate.com/docs/api/openapi/okta-management/guides/release-lifecycle#research-release), is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."}}]}],"menuStyle":"drilldown"},{"type":"group","label":"Okta Access Gateway","items":[{"type":"link","fsPath":"openapi/oag/guides/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi/oag/guides/overview","routeSlug":"/openapi/oag/guides/overview"},{"type":"link","link":"https://www.postman.com/okta-eng/workspace/okta-public-api-collections/collection/26001419-56f11b28-1b94-481a-8fa7-87e6ca318b3b","label":"Postman Collection","external":true},{"type":"group","label":"API Access Tokens","items":[{"type":"group","fsPath":"openapi/oag/oag/tags/accesstokens.yaml","link":"/openapi/oag/oag/tags/accesstokens","routeSlug":"/openapi/oag/oag/tags/accesstokens","label":"Access Tokens","items":[{"type":"group","label":"Access Tokens","link":"/openapi/oag/oag/tags/accesstokens/accesstokens","routeSlug":"/openapi/oag/oag/tags/accesstokens/accesstokens","items":[]},{"label":"/api/v2/oauth/token","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/accesstokens/paths/~1api~1v2~1oauth~1token/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/accesstokens/paths/~1api~1v2~1oauth~1token/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/oauth/token"}},"httpPath":"/api/v2/oauth/token"},{"label":"Create an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/accesstokens/other/createaccesstoken","routeSlug":"/openapi/oag/oag/tags/accesstokens/other/createaccesstoken","metadata":{"seo":{"title":"Create an access token","description":"Creates an access token for your Access Gateway. Use the access token to authenticate API requests. Authentication is performed using a signed JWT assertion in the client_assertion parameter of the request body, not through HTTP headers."}},"httpPath":"/api/v2/oauth/token"}],"metadata":{"type":"openapi","title":"Access Tokens","description":"The Access Tokens API allows you to create access tokens for API requests."}}]},{"type":"group","label":"Applications","items":[{"type":"group","fsPath":"openapi/oag/oag/tags/applications.yaml","link":"/openapi/oag/oag/tags/applications","routeSlug":"/openapi/oag/oag/tags/applications","label":"Applications","items":[{"type":"group","label":"Applications","link":"/openapi/oag/oag/tags/applications/applications","routeSlug":"/openapi/oag/oag/tags/applications/applications","items":[]},{"label":"/api/v2/apps","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps"}},"httpPath":"/api/v2/apps"},{"label":"List all applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/listapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/listapplication","metadata":{"seo":{"title":"List all applications","description":"Lists all applications that are configured in Access Gateway"}},"httpPath":"/api/v2/apps"},{"label":"Create an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/createapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/createapplication","metadata":{"seo":{"title":"Create an application","description":"Creates a new application in Access Gateway."}},"httpPath":"/api/v2/apps"},{"label":"/api/v2/apps/{applicationId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}"}},"httpPath":"/api/v2/apps/{applicationId}"},{"label":"Retrieve an application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/getapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/getapplication","metadata":{"seo":{"title":"Retrieve an application","description":"Retrieves details of a specific application by applicationId"}},"httpPath":"/api/v2/apps/{applicationId}"},{"label":"Replace an application","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/replaceapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/replaceapplication","metadata":{"seo":{"title":"Replace an application","description":"Replaces an existing application configuration"}},"httpPath":"/api/v2/apps/{applicationId}"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/deleteapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/deleteapplication","metadata":{"seo":{"title":"Delete an application","description":"Deletes an application by applicationId."}},"httpPath":"/api/v2/apps/{applicationId}"},{"label":"/api/v2/apps/{applicationId}/activate","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1activate/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1activate/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/activate"}},"httpPath":"/api/v2/apps/{applicationId}/activate"},{"label":"Activate an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/activateapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/activateapplication","metadata":{"seo":{"title":"Activate an application","description":"Activates a newly created application in Access Gateway. Activate an application after you create it. Access Gateway doesn't automatically activate newly created applications."}},"httpPath":"/api/v2/apps/{applicationId}/activate"},{"label":"/api/v2/apps/{applicationId}/credentials/keys","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/keys"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys"},{"label":"/api/v2/apps/{applicationId}/credentials/keys","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/keys"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys"},{"label":"List all public keys (JWKS)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/listpublickeys","routeSlug":"/openapi/oag/oag/tags/applications/other/listpublickeys","metadata":{"seo":{"title":"List all public keys (JWKS)","description":"Lists the public JSON Web Key Set (JWKS) that are configured for this application"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys"},{"label":"Upload a public key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/uploadapplicationpublickey","routeSlug":"/openapi/oag/oag/tags/applications/other/uploadapplicationpublickey","metadata":{"seo":{"title":"Upload a public key","description":"Uploads a public key in JWK format to the application's JWKS."}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys"},{"label":"/api/v2/apps/{applicationId}/credentials/keys/{kid}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys~1{kid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys~1{kid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/keys/{kid}"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys/{kid}"},{"label":"/api/v2/apps/{applicationId}/credentials/keys/{kid}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys~1{kid}/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1keys~1{kid}/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/keys/{kid}"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys/{kid}"},{"label":"Revoke a public key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/revokeapplicationpublickey","routeSlug":"/openapi/oag/oag/tags/applications/other/revokeapplicationpublickey","metadata":{"seo":{"title":"Revoke a public key","description":"Revokes a specific public key by its key ID (kid), immediately blocking any inbound authentication requests signed by the matching private key"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/keys/{kid}"},{"label":"/api/v2/apps/{applicationId}/credentials/secret","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1secret/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1secret/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/secret"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/secret"},{"label":"/api/v2/apps/{applicationId}/credentials/secret","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1secret/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1credentials~1secret/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/credentials/secret"}},"httpPath":"/api/v2/apps/{applicationId}/credentials/secret"},{"label":"Retrieve the client secret","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/getclientsecret","routeSlug":"/openapi/oag/oag/tags/applications/other/getclientsecret","metadata":{"seo":{"title":"Retrieve the client secret","description":"Retrieves the client secret for the specified OIDC application."}},"httpPath":"/api/v2/apps/{applicationId}/credentials/secret"},{"label":"Generate a client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/generateclientsecret","routeSlug":"/openapi/oag/oag/tags/applications/other/generateclientsecret","metadata":{"seo":{"title":"Generate a client secret","description":"Generates a new client secret for the specified OIDC application. The previous secret is immediately invalidated."}},"httpPath":"/api/v2/apps/{applicationId}/credentials/secret"},{"label":"/api/v2/apps/{applicationId}/deactivate","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1deactivate/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1deactivate/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/deactivate"}},"httpPath":"/api/v2/apps/{applicationId}/deactivate"},{"label":"Deactivate an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/deactivateapplication","routeSlug":"/openapi/oag/oag/tags/applications/other/deactivateapplication","metadata":{"seo":{"title":"Deactivate an application","description":"Deactivates an existing application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/deactivate"},{"label":"/api/v2/apps/{applicationId}/maintenance","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1maintenance/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/applications/paths/~1api~1v2~1apps~1{applicationid}~1maintenance/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/maintenance"}},"httpPath":"/api/v2/apps/{applicationId}/maintenance"},{"label":"Update an application status to maintenance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/applications/other/updateapplicationmaintenance","routeSlug":"/openapi/oag/oag/tags/applications/other/updateapplicationmaintenance","metadata":{"seo":{"title":"Update an application status to maintenance","description":"Updates the status of an application to maintenance mode in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/maintenance"}],"metadata":{"type":"openapi","title":"Applications","description":"The Applications API allows you to list and manage Access Gateway applications and application-related configurations."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-attributes.yaml","link":"/openapi/oag/oag/tags/application-attributes","routeSlug":"/openapi/oag/oag/tags/application-attributes","label":"Application Attributes","items":[{"type":"group","label":"Application Attributes","link":"/openapi/oag/oag/tags/application-attributes/application-attributes","routeSlug":"/openapi/oag/oag/tags/application-attributes/application-attributes","items":[]},{"label":"/api/v2/apps/{applicationId}/attributes","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/paths/~1api~1v2~1apps~1{applicationid}~1attributes/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-attributes/paths/~1api~1v2~1apps~1{applicationid}~1attributes/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/attributes"}},"httpPath":"/api/v2/apps/{applicationId}/attributes"},{"label":"List all attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/other/listattributes","routeSlug":"/openapi/oag/oag/tags/application-attributes/other/listattributes","metadata":{"seo":{"title":"List all attributes","description":"Lists all attributes for a specific application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/attributes"},{"label":"Create an attribute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/other/createattribute","routeSlug":"/openapi/oag/oag/tags/application-attributes/other/createattribute","metadata":{"seo":{"title":"Create an attribute","description":"Creates an attribute for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/attributes"},{"label":"/api/v2/apps/{applicationId}/attributes/{attributeId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/paths/~1api~1v2~1apps~1{applicationid}~1attributes~1{attributeid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-attributes/paths/~1api~1v2~1apps~1{applicationid}~1attributes~1{attributeid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/attributes/{attributeId}"}},"httpPath":"/api/v2/apps/{applicationId}/attributes/{attributeId}"},{"label":"Retrieve an attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/other/getattribute","routeSlug":"/openapi/oag/oag/tags/application-attributes/other/getattribute","metadata":{"seo":{"title":"Retrieve an attribute","description":"Retrieves details of a specific attribute for an application by applicationId and attributeId"}},"httpPath":"/api/v2/apps/{applicationId}/attributes/{attributeId}"},{"label":"Replace an attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/other/replaceattribute","routeSlug":"/openapi/oag/oag/tags/application-attributes/other/replaceattribute","metadata":{"seo":{"title":"Replace an attribute","description":"Replaces an existing attribute configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/attributes/{attributeId}"},{"label":"Delete an attribute","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-attributes/other/deleteattribute","routeSlug":"/openapi/oag/oag/tags/application-attributes/other/deleteattribute","metadata":{"seo":{"title":"Delete an attribute","description":"Deletes an attribute for an application by applicationId and attributeId"}},"httpPath":"/api/v2/apps/{applicationId}/attributes/{attributeId}"}],"metadata":{"type":"openapi","title":"Application Attributes","description":"The Attributes API allows you to retrieve and manage attributes of your applications."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-behavior.yaml","link":"/openapi/oag/oag/tags/application-behavior","routeSlug":"/openapi/oag/oag/tags/application-behavior","label":"Application Behavior","items":[{"type":"group","label":"Application Behavior","link":"/openapi/oag/oag/tags/application-behavior/application-behavior","routeSlug":"/openapi/oag/oag/tags/application-behavior/application-behavior","items":[]},{"label":"/api/v2/apps/{applicationId}/behavior","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-behavior/paths/~1api~1v2~1apps~1{applicationid}~1behavior/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-behavior/paths/~1api~1v2~1apps~1{applicationid}~1behavior/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/behavior"}},"httpPath":"/api/v2/apps/{applicationId}/behavior"},{"label":"Retrieve the application behavior configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-behavior/other/getbehavior","routeSlug":"/openapi/oag/oag/tags/application-behavior/other/getbehavior","metadata":{"seo":{"title":"Retrieve the application behavior configuration","description":"Retrieves a behavior configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/behavior"},{"label":"Replace the application behavior configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-behavior/other/replacebehavior","routeSlug":"/openapi/oag/oag/tags/application-behavior/other/replacebehavior","metadata":{"seo":{"title":"Replace the application behavior configuration","description":"Replaces the behavior configuration for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/behavior"}],"metadata":{"type":"openapi","title":"Application Behavior","description":"The Behaviors API allows you to retrieve and manage the behavior configurations of your applications."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-health-check.yaml","link":"/openapi/oag/oag/tags/application-health-check","routeSlug":"/openapi/oag/oag/tags/application-health-check","label":"Application Health Check","items":[{"type":"group","label":"Application Health Check","link":"/openapi/oag/oag/tags/application-health-check/application-health-check","routeSlug":"/openapi/oag/oag/tags/application-health-check/application-health-check","items":[]},{"label":"/api/v2/apps/{applicationId}/health-check","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-health-check/paths/~1api~1v2~1apps~1{applicationid}~1health-check/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-health-check/paths/~1api~1v2~1apps~1{applicationid}~1health-check/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/health-check"}},"httpPath":"/api/v2/apps/{applicationId}/health-check"},{"label":"Retrieve the application health check configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-health-check/other/gethealthcheck","routeSlug":"/openapi/oag/oag/tags/application-health-check/other/gethealthcheck","metadata":{"seo":{"title":"Retrieve the application health check configuration","description":"Retrieves a health check configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/health-check"},{"label":"Replace the application health check configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-health-check/other/replacehealthcheck","routeSlug":"/openapi/oag/oag/tags/application-health-check/other/replacehealthcheck","metadata":{"seo":{"title":"Replace the application health check configuration","description":"Replaces the health check configuration for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/health-check"}],"metadata":{"type":"openapi","title":"Application Health Check","description":"The Health Check API allows you to retrieve and manage the health status configuration for the protected resources of an application."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-policies.yaml","link":"/openapi/oag/oag/tags/application-policies","routeSlug":"/openapi/oag/oag/tags/application-policies","label":"Application Policies","items":[{"type":"group","label":"Application Policies","link":"/openapi/oag/oag/tags/application-policies/application-policies","routeSlug":"/openapi/oag/oag/tags/application-policies/application-policies","items":[]},{"label":"/api/v2/apps/{applicationId}/policies","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/paths/~1api~1v2~1apps~1{applicationid}~1policies/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-policies/paths/~1api~1v2~1apps~1{applicationid}~1policies/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/policies"}},"httpPath":"/api/v2/apps/{applicationId}/policies"},{"label":"List all policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/other/listpolicies","routeSlug":"/openapi/oag/oag/tags/application-policies/other/listpolicies","metadata":{"seo":{"title":"List all policies","description":"Lists all policies for a specific application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/policies"},{"label":"Create a policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/other/createpolicy","routeSlug":"/openapi/oag/oag/tags/application-policies/other/createpolicy","metadata":{"seo":{"title":"Create a policy","description":"Creates a policy for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/policies"},{"label":"/api/v2/apps/{applicationId}/policies/{policyId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/paths/~1api~1v2~1apps~1{applicationid}~1policies~1{policyid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-policies/paths/~1api~1v2~1apps~1{applicationid}~1policies~1{policyid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/policies/{policyId}"}},"httpPath":"/api/v2/apps/{applicationId}/policies/{policyId}"},{"label":"Retrieve a policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/other/getpolicy","routeSlug":"/openapi/oag/oag/tags/application-policies/other/getpolicy","metadata":{"seo":{"title":"Retrieve a policy","description":"Retrieves details of a specific policy for an application by applicationId and policyId"}},"httpPath":"/api/v2/apps/{applicationId}/policies/{policyId}"},{"label":"Replace a policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/other/replacepolicy","routeSlug":"/openapi/oag/oag/tags/application-policies/other/replacepolicy","metadata":{"seo":{"title":"Replace a policy","description":"Replaces an existing policy configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/policies/{policyId}"},{"label":"Delete a policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-policies/other/deletepolicy","routeSlug":"/openapi/oag/oag/tags/application-policies/other/deletepolicy","metadata":{"seo":{"title":"Delete a policy","description":"Deletes a policy for an application by applicationId and policyId"}},"httpPath":"/api/v2/apps/{applicationId}/policies/{policyId}"}],"metadata":{"type":"openapi","title":"Application Policies","description":"The Policies API allows you to retrieve and manage the policies of your applications."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-protected-resources.yaml","link":"/openapi/oag/oag/tags/application-protected-resources","routeSlug":"/openapi/oag/oag/tags/application-protected-resources","label":"Application Protected Resources","items":[{"type":"group","label":"Application Protected Resources","link":"/openapi/oag/oag/tags/application-protected-resources/application-protected-resources","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/application-protected-resources","items":[]},{"label":"/api/v2/apps/{applicationId}/resources","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/paths/~1api~1v2~1apps~1{applicationid}~1resources/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/paths/~1api~1v2~1apps~1{applicationid}~1resources/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/resources"}},"httpPath":"/api/v2/apps/{applicationId}/resources"},{"label":"List all protected resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/other/listprotectedresources","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/other/listprotectedresources","metadata":{"seo":{"title":"List all protected resources","description":"Lists all protected resources for a specific application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/resources"},{"label":"Create a protected resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/other/createprotectedresource","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/other/createprotectedresource","metadata":{"seo":{"title":"Create a protected resource","description":"Creates a protected resource for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/resources"},{"label":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/paths/~1api~1v2~1apps~1{applicationid}~1resources~1{protectedresourceid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/paths/~1api~1v2~1apps~1{applicationid}~1resources~1{protectedresourceid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}"}},"httpPath":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}"},{"label":"Retrieve a protected resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/other/getresource","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/other/getresource","metadata":{"seo":{"title":"Retrieve a protected resource","description":"Retrieves details of a specific protected resource by applicationId and protectedResourceId"}},"httpPath":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}"},{"label":"Replace a protected resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/other/replaceresource","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/other/replaceresource","metadata":{"seo":{"title":"Replace a protected resource","description":"Replaces an existing protected resource configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}"},{"label":"Delete a protected resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-protected-resources/other/deleteprotectedresource","routeSlug":"/openapi/oag/oag/tags/application-protected-resources/other/deleteprotectedresource","metadata":{"seo":{"title":"Delete a protected resource","description":"Deletes a protected resource for an application by applicationId and protectedResourceId"}},"httpPath":"/api/v2/apps/{applicationId}/resources/{protectedResourceId}"}],"metadata":{"type":"openapi","title":"Application Protected Resources","description":"The Protected Resources API allows you to retrieve and manage protected resources of your applications."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-session.yaml","link":"/openapi/oag/oag/tags/application-session","routeSlug":"/openapi/oag/oag/tags/application-session","label":"Application Session","items":[{"type":"group","label":"Application Session","link":"/openapi/oag/oag/tags/application-session/application-session","routeSlug":"/openapi/oag/oag/tags/application-session/application-session","items":[]},{"label":"/api/v2/apps/{applicationId}/session","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-session/paths/~1api~1v2~1apps~1{applicationid}~1session/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-session/paths/~1api~1v2~1apps~1{applicationid}~1session/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/session"}},"httpPath":"/api/v2/apps/{applicationId}/session"},{"label":"Retrieve the application session configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-session/other/getsession","routeSlug":"/openapi/oag/oag/tags/application-session/other/getsession","metadata":{"seo":{"title":"Retrieve the application session configuration","description":"Retrieves a session configuration for an application"}},"httpPath":"/api/v2/apps/{applicationId}/session"},{"label":"Replace the application session configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-session/other/replacesession","routeSlug":"/openapi/oag/oag/tags/application-session/other/replacesession","metadata":{"seo":{"title":"Replace the application session configuration","description":"Replaces the session configuration for an application in Access Gateway"}},"httpPath":"/api/v2/apps/{applicationId}/session"}],"metadata":{"type":"openapi","title":"Application Session","description":"The Sessions API allows you to retrieve and manage the session configurations of your applications."}},{"type":"group","fsPath":"openapi/oag/oag/tags/application-offline-mode.yaml","link":"/openapi/oag/oag/tags/application-offline-mode","routeSlug":"/openapi/oag/oag/tags/application-offline-mode","label":"Application Offline Mode","items":[{"type":"group","label":"Application Offline Mode","link":"/openapi/oag/oag/tags/application-offline-mode/application-offline-mode","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/application-offline-mode","items":[]},{"label":"/api/v2/apps/{applicationId}/offline-mode","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/offline-mode"}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode"},{"label":"/api/v2/apps/{applicationId}/offline-mode","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/offline-mode"}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode"},{"label":"Retrieve the offline mode state for an application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/other/getapplicationofflinemodestate","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/other/getapplicationofflinemodestate","metadata":{"seo":{"title":"Retrieve the offline mode state for an application","description":"Retrieves the offline mode state for a specific application in Access Gateway, by applicationId"}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode"},{"label":"Assign the offline mode state for an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/other/assignapplicationofflinemodestate","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/other/assignapplicationofflinemodestate","metadata":{"seo":{"title":"Assign the offline mode state for an application","description":"Assigns the offline mode state for a specific application in Access Gateway, by applicationId."}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode"},{"label":"/api/v2/apps/{applicationId}/offline-mode/group-policy","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode~1group-policy/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode~1group-policy/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/offline-mode/group-policy"}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode/group-policy"},{"label":"/api/v2/apps/{applicationId}/offline-mode/group-policy","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode~1group-policy/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/paths/~1api~1v2~1apps~1{applicationid}~1offline-mode~1group-policy/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/apps/{applicationId}/offline-mode/group-policy"}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode/group-policy"},{"label":"Retrieve the offline mode group policy for an application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/other/getapplicationofflinemodegrouppolicy","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/other/getapplicationofflinemodegrouppolicy","metadata":{"seo":{"title":"Retrieve the offline mode group policy for an application","description":"Retrieves the offline mode group policy for a specific application in Access Gateway, by applicationId."}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode/group-policy"},{"label":"Assign a group to an application's offline mode policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/application-offline-mode/other/assignapplicationofflinemodegrouppolicy","routeSlug":"/openapi/oag/oag/tags/application-offline-mode/other/assignapplicationofflinemodegrouppolicy","metadata":{"seo":{"title":"Assign a group to an application's offline mode policy","description":"Assigns groups to the offline mode policy for a specific application in Access Gateway, by applicationId. Users who are in the groups that are assigned to the offline mode application policy can sign in to the application when offline mode is enabled. Users who aren't in the assigned groups are blocked from signing in when offline mode is enabled."}},"httpPath":"/api/v2/apps/{applicationId}/offline-mode/group-policy"}],"metadata":{"type":"openapi","title":"Application Offline Mode","description":"The Application Offline Mode API allows you to manage the offline mode configuration of your applications.\n\nOffline mode is a feature of Access Gateway that allows it to continue functioning with modified capabilities when the connection to the identity provider (IdP) is lost. This API allows you to manage the offline mode settings at the application level, which applies to all users and IdPs associated with the application.\n\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}}]},{"type":"group","label":"Certificates","items":[{"type":"group","fsPath":"openapi/oag/oag/tags/certificates.yaml","link":"/openapi/oag/oag/tags/certificates","routeSlug":"/openapi/oag/oag/tags/certificates","label":"Certificates","items":[{"type":"group","label":"Certificates","link":"/openapi/oag/oag/tags/certificates/certificates","routeSlug":"/openapi/oag/oag/tags/certificates/certificates","items":[]},{"label":"/api/v2/certificates","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/certificates/paths/~1api~1v2~1certificates/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/certificates/paths/~1api~1v2~1certificates/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/certificates"}},"httpPath":"/api/v2/certificates"},{"label":"List all certificates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/certificates/other/listcertificates","routeSlug":"/openapi/oag/oag/tags/certificates/other/listcertificates","metadata":{"seo":{"title":"List all certificates","description":"Lists all certificates configured in Access Gateway. This request returns a list of certificates with their details."}},"httpPath":"/api/v2/certificates"},{"label":"/api/v2/certificates/{certificateId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/certificates/paths/~1api~1v2~1certificates~1{certificateid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/certificates/paths/~1api~1v2~1certificates~1{certificateid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/certificates/{certificateId}"}},"httpPath":"/api/v2/certificates/{certificateId}"},{"label":"Retrieve a certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/certificates/other/getcertificate","routeSlug":"/openapi/oag/oag/tags/certificates/other/getcertificate","metadata":{"seo":{"title":"Retrieve a certificate","description":"Retrieves a certificate by certificateId"}},"httpPath":"/api/v2/certificates/{certificateId}"}],"metadata":{"type":"openapi","title":"Certificates","description":"The Certificates API allows you to list and manage SSL certificates on your Access Gateway instance."}}]},{"type":"group","label":"Identity Providers","items":[{"type":"group","fsPath":"openapi/oag/oag/tags/idps.yaml","link":"/openapi/oag/oag/tags/idps","routeSlug":"/openapi/oag/oag/tags/idps","label":"Identity Providers","items":[{"type":"group","label":"Identity Providers","link":"/openapi/oag/oag/tags/idps/idps","routeSlug":"/openapi/oag/oag/tags/idps/idps","items":[]},{"label":"/api/v2/idps","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/paths/~1api~1v2~1idps/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps/paths/~1api~1v2~1idps/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps"}},"httpPath":"/api/v2/idps"},{"label":"List all IdPs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/other/listidps","routeSlug":"/openapi/oag/oag/tags/idps/other/listidps","metadata":{"seo":{"title":"List all IdPs","description":"Lists all identity providers (IdPs) that are configured in Access Gateway"}},"httpPath":"/api/v2/idps"},{"label":"Create an IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/other/createidp","routeSlug":"/openapi/oag/oag/tags/idps/other/createidp","metadata":{"seo":{"title":"Create an IdP","description":"Creates an identity provider (IdP) in Access Gateway"}},"httpPath":"/api/v2/idps"},{"label":"/api/v2/idps/{idpId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/paths/~1api~1v2~1idps~1{idpid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps/paths/~1api~1v2~1idps~1{idpid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}"}},"httpPath":"/api/v2/idps/{idpId}"},{"label":"Retrieve an IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/other/getidp","routeSlug":"/openapi/oag/oag/tags/idps/other/getidp","metadata":{"seo":{"title":"Retrieve an IdP","description":"Retrieves an identity provider (IdP) integration by idpId"}},"httpPath":"/api/v2/idps/{idpId}"},{"label":"Replace an IdP","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/other/replaceidp","routeSlug":"/openapi/oag/oag/tags/idps/other/replaceidp","metadata":{"seo":{"title":"Replace an IdP","description":"Replaces an existing identity provider (IdP) configuration"}},"httpPath":"/api/v2/idps/{idpId}"},{"label":"Delete an IdP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps/other/deleteidp","routeSlug":"/openapi/oag/oag/tags/idps/other/deleteidp","metadata":{"seo":{"title":"Delete an IdP","description":"Deletes an identity provider (IdP) by idpId"}},"httpPath":"/api/v2/idps/{idpId}"}],"metadata":{"type":"openapi","title":"Identity Providers","description":"The Identity Providers API allows you to list and manage identity providers (IdPs) on your Access Gateway instance."}},{"type":"group","fsPath":"openapi/oag/oag/tags/idps-offline-mode.yaml","link":"/openapi/oag/oag/tags/idps-offline-mode","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode","label":"Identity Providers Offline Mode","items":[{"type":"group","label":"Identity Providers Offline Mode","link":"/openapi/oag/oag/tags/idps-offline-mode/idps-offline-mode","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode/idps-offline-mode","items":[]},{"label":"/api/v2/idps/{idpId}/offline-mode","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode/paths/~1api~1v2~1idps~1{idpid}~1offline-mode/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode/paths/~1api~1v2~1idps~1{idpid}~1offline-mode/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode"},{"label":"/api/v2/idps/{idpId}/offline-mode","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode/paths/~1api~1v2~1idps~1{idpid}~1offline-mode/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode/paths/~1api~1v2~1idps~1{idpid}~1offline-mode/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode"},{"label":"Retrieve the failover mode for an IdP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode/other/getidpofflinemodefailovermode","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode/other/getidpofflinemodefailovermode","metadata":{"seo":{"title":"Retrieve the failover mode for an IdP","description":"Retrieves the failover mode for the specified identity provider (IdP) by idpId."}},"httpPath":"/api/v2/idps/{idpId}/offline-mode"},{"label":"Assign the failover mode for an IdP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode/other/assignidpofflinemodefailovermode","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode/other/assignidpofflinemodefailovermode","metadata":{"seo":{"title":"Assign the failover mode for an IdP","description":"Assigns the failover mode for the specified identity provider (IdP) by idpId."}},"httpPath":"/api/v2/idps/{idpId}/offline-mode"}],"metadata":{"type":"openapi","title":"Identity Providers Offline Mode","description":"The Identity Providers Offline Mode API allows you to manage the offline mode configuration for the identity providers (IdPs) on your Access Gateway instance.\n\nOffline mode is a feature of Access Gateway that allows it to continue functioning with modified capabilities when the connection to the IdP is lost. This API allows you to manage the offline mode settings for each IdP, which determine how Access Gateway handles authentication requests when an IdP is unavailable.\n\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}},{"type":"group","fsPath":"openapi/oag/oag/tags/idps-offline-mode-directory.yaml","link":"/openapi/oag/oag/tags/idps-offline-mode-directory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory","label":"Identity Providers Offline Mode Directory","items":[{"type":"group","label":"Identity Providers Offline Mode Directory","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/idps-offline-mode-directory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/idps-offline-mode-directory","items":[]},{"label":"/api/v2/idps/{idpId}/offline-mode/directories","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/directories"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories"},{"label":"/api/v2/idps/{idpId}/offline-mode/directories","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/directories"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories"},{"label":"List all offline mode directories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/listofflinemodedirectories","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/listofflinemodedirectories","metadata":{"seo":{"title":"List all offline mode directories","description":"Lists all offline mode directories for the specified identity provider (IdP) by idpId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories"},{"label":"Create an offline mode directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/createofflinemodedirectory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/createofflinemodedirectory","metadata":{"seo":{"title":"Create an offline mode directory","description":"Creates an offline mode directory for the specified identity provider (IdP) by idpId."}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories"},{"label":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories~1{directoryid}/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories~1{directoryid}/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"},{"label":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories~1{directoryid}/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1directories~1{directoryid}/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"},{"label":"Retrieve an offline mode directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/getofflinemodedirectory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/getofflinemodedirectory","metadata":{"seo":{"title":"Retrieve an offline mode directory","description":"Retrieves an offline mode directory for the specified identity provider (IdP) by idpId and directoryId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"},{"label":"Replace an offline mode directory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/replaceofflinemodedirectory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/replaceofflinemodedirectory","metadata":{"seo":{"title":"Replace an offline mode directory","description":"Replaces an existing offline mode directory for the specified identity provider (IdP) by idpId and directoryId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"},{"label":"Delete an offline mode directory","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/deleteofflinemodedirectory","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/deleteofflinemodedirectory","metadata":{"seo":{"title":"Delete an offline mode directory","description":"Deletes an offline mode directory for the specified identity provider (IdP) by idpId and directoryId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/directories/{directoryId}"},{"label":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1test-directory-connection/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1test-directory-connection/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection"},{"label":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1test-directory-connection/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1test-directory-connection/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection"},{"label":"Test a directory connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/testdirectoryconnection","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-directory/other/testdirectoryconnection","metadata":{"seo":{"title":"Test a directory connection","description":"Tests the connection to the offline mode directory for the specified identity provider (IdP) by idpId."}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/test-directory-connection"}],"metadata":{"type":"openapi","title":"Identity Providers Offline Mode Directory","description":"The Identity Providers Offline Mode Directory API allows you to manage the offline mode directory for the identity providers (IdPs) on your Access Gateway instance.\n\nThe offline mode directory is a component of Access Gateway's offline mode that serves as a backup authentication source when the connection to the IdP is lost. This API allows you to manage the offline mode directory settings for each IdP, which determine how Access Gateway connects to and uses the offline mode directory during failover.\n\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}},{"type":"group","fsPath":"openapi/oag/oag/tags/idps-offline-mode-health-policy.yaml","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy","label":"Identity Providers Offline Mode Health Policy","items":[{"type":"group","label":"Identity Providers Offline Mode Health Policy","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/idps-offline-mode-health-policy","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/idps-offline-mode-health-policy","items":[]},{"label":"/api/v2/idps/{idpId}/offline-mode/health-policy","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1health-policy/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1health-policy/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/health-policy"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/health-policy"},{"label":"/api/v2/idps/{idpId}/offline-mode/health-policy","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1health-policy/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/paths/~1api~1v2~1idps~1{idpid}~1offline-mode~1health-policy/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/idps/{idpId}/offline-mode/health-policy"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/health-policy"},{"label":"Retrieve an offline mode health policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/other/getofflinemodehealthpolicy","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/other/getofflinemodehealthpolicy","metadata":{"seo":{"title":"Retrieve an offline mode health policy","description":"Retrieves the offline mode health policy for the specified identity provider (IdP) by idpId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/health-policy"},{"label":"Replace an offline mode health policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/other/replaceofflinemodehealthpolicy","routeSlug":"/openapi/oag/oag/tags/idps-offline-mode-health-policy/other/replaceofflinemodehealthpolicy","metadata":{"seo":{"title":"Replace an offline mode health policy","description":"Replaces the offline mode health policy for the specified identity provider (IdP) by idpId"}},"httpPath":"/api/v2/idps/{idpId}/offline-mode/health-policy"}],"metadata":{"type":"openapi","title":"Identity Providers Offline Mode Health Policy","description":"The Identity Providers Offline Mode Health Policy API allows you to manage the offline mode health policy for the identity providers (IdPs) on your Access Gateway instance.\n\nThe health policy is a component of Access Gateway's offline mode that determines the health status of an IdP and when to trigger failover to offline mode. This API allows you to manage the health policy settings for each IdP, which determine how Access Gateway monitors the health of the IdP and decides when to switch to offline mode.\n\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}},{"type":"group","fsPath":"openapi/oag/oag/tags/oidc.yaml","link":"/openapi/oag/oag/tags/oidc","routeSlug":"/openapi/oag/oag/tags/oidc","label":"OpenID Connect & OAuth 2.0","items":[{"type":"group","label":"OpenID Connect & OAuth 2.0","link":"/openapi/oag/oag/tags/oidc/oidc","routeSlug":"/openapi/oag/oag/tags/oidc/oidc","items":[]},{"label":"/realms/{idpId}/.well-known/openid-configuration","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1.well-known~1openid-configuration/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1.well-known~1openid-configuration/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/.well-known/openid-configuration"}},"httpPath":"/realms/{idpId}/.well-known/openid-configuration"},{"label":"/realms/{idpId}/.well-known/openid-configuration","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1.well-known~1openid-configuration/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1.well-known~1openid-configuration/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/.well-known/openid-configuration"}},"httpPath":"/realms/{idpId}/.well-known/openid-configuration"},{"label":"Retrieve the OpenID Connect discovery document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/getopenidconnectdiscovery","routeSlug":"/openapi/oag/oag/tags/oidc/other/getopenidconnectdiscovery","metadata":{"seo":{"title":"Retrieve the OpenID Connect discovery document","description":"Retrieves the OpenID Connect discovery document for the specified IdP."}},"httpPath":"/realms/{idpId}/.well-known/openid-configuration"},{"label":"/realms/{idpId}/protocol/openid-connect/auth","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1auth/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1auth/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/auth"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/auth"},{"label":"/realms/{idpId}/protocol/openid-connect/auth","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1auth/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1auth/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/auth"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/auth"},{"label":"Initiate an OIDC authorization for a user using GET","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/initiateoidcauthorizationresponseget","routeSlug":"/openapi/oag/oag/tags/oidc/other/initiateoidcauthorizationresponseget","metadata":{"seo":{"title":"Initiate an OIDC authorization for a user using GET","description":"Initiates an OIDC authorization for a user by directing them to authenticate with the specified IdP. Authorization request parameters are passed as URL query parameters."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/auth"},{"label":"Initiate an OIDC authorization for a user using POST","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/initiateoidcauthorizationresponsepost","routeSlug":"/openapi/oag/oag/tags/oidc/other/initiateoidcauthorizationresponsepost","metadata":{"seo":{"title":"Initiate an OIDC authorization for a user using POST","description":"Initiates an OIDC authorization for a user by directing them to authenticate with the specified IdP. Authorization request parameters are passed as form-encoded body parameters."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/auth"},{"label":"/realms/{idpId}/protocol/openid-connect/certs","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1certs/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1certs/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/certs"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/certs"},{"label":"/realms/{idpId}/protocol/openid-connect/certs","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1certs/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1certs/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/certs"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/certs"},{"label":"Retrieve the JSON Web Key Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/getjsonwebkeyset","routeSlug":"/openapi/oag/oag/tags/oidc/other/getjsonwebkeyset","metadata":{"seo":{"title":"Retrieve the JSON Web Key Set","description":"Retrieves the JSON Web Key Set (JWKS) for the specified IdP."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/certs"},{"label":"/realms/{idpId}/protocol/openid-connect/revoke","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1revoke/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1revoke/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/revoke"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/revoke"},{"label":"/realms/{idpId}/protocol/openid-connect/revoke","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1revoke/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1revoke/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/revoke"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/revoke"},{"label":"Revoke a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/revoketoken","routeSlug":"/openapi/oag/oag/tags/oidc/other/revoketoken","metadata":{"seo":{"title":"Revoke a token","description":"Revokes an access or refresh token for the specified IdP."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/revoke"},{"label":"/realms/{idpId}/protocol/openid-connect/token","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/token"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token"},{"label":"/realms/{idpId}/protocol/openid-connect/token","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/token"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token"},{"label":"Request a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/requesttoken","routeSlug":"/openapi/oag/oag/tags/oidc/other/requesttoken","metadata":{"seo":{"title":"Request a token","description":"Requests a token for the specified IdP's authorization server. Use the token to authenticate API requests. Perform client authentication by using either HTTP Basic Auth (client ID and secret as Basic credentials) or by including client_id/client_secret (or client_assertion/client_assertion_type for JWT-based methods) as body parameters."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token"},{"label":"/realms/{idpId}/protocol/openid-connect/token/introspect","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token~1introspect/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token~1introspect/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/token/introspect"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token/introspect"},{"label":"/realms/{idpId}/protocol/openid-connect/token/introspect","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token~1introspect/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1token~1introspect/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/token/introspect"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token/introspect"},{"label":"Validate a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/validatetoken","routeSlug":"/openapi/oag/oag/tags/oidc/other/validatetoken","metadata":{"seo":{"title":"Validate a token","description":"Validates an access or refresh token for the specified IdP and returns its active status and associated claims, such as the subject, scopes, and expiry time"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/token/introspect"},{"label":"/realms/{idpId}/protocol/openid-connect/userinfo","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1userinfo/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1userinfo/x-okta-team-detail","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/userinfo"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/userinfo"},{"label":"/realms/{idpId}/protocol/openid-connect/userinfo","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1userinfo/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/oidc/paths/~1realms~1{idpid}~1protocol~1openid-connect~1userinfo/x-okta-lifecycle","metadata":{"seo":{"title":"/realms/{idpId}/protocol/openid-connect/userinfo"}},"httpPath":"/realms/{idpId}/protocol/openid-connect/userinfo"},{"label":"Retrieve the user information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/oidc/other/getuserinfo","routeSlug":"/openapi/oag/oag/tags/oidc/other/getuserinfo","metadata":{"seo":{"title":"Retrieve the user information","description":"Retrieves profile claims for the user that's associated with the provided access token. For example, the response includes the user's name, email address, and username. The claims that are returned depend on the scopes granted to the access token."}},"httpPath":"/realms/{idpId}/protocol/openid-connect/userinfo"}],"metadata":{"type":"openapi","title":"OpenID Connect & OAuth 2.0","description":"The OpenID Connect & OAuth 2.0 API provides the protocol endpoints for OIDC authentication and OAuth 2.0 authorization on this IDP.\n\nOpenID Connect (OIDC) extends OAuth 2.0 to add user authentication and SSO, while OAuth 2.0 provides authorization through scoped access tokens.\n\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}}]},{"type":"group","label":"Settings","items":[{"type":"group","fsPath":"openapi/oag/oag/tags/settings-authentication-service.yaml","link":"/openapi/oag/oag/tags/settings-authentication-service","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service","label":"Authentication Service","items":[{"type":"group","label":"Authentication Service","link":"/openapi/oag/oag/tags/settings-authentication-service/settings-authentication-service","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/settings-authentication-service","items":[]},{"label":"/api/v2/settings/authentication-service","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/settings/authentication-service"}},"httpPath":"/api/v2/settings/authentication-service"},{"label":"/api/v2/settings/authentication-service","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/settings/authentication-service"}},"httpPath":"/api/v2/settings/authentication-service"},{"label":"Retrieve the authentication service setting","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/other/getauthenticationservicesetting","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/other/getauthenticationservicesetting","metadata":{"seo":{"title":"Retrieve the authentication service setting","description":"Retrieves the current authentication service setting for Access Gateway"}},"httpPath":"/api/v2/settings/authentication-service"},{"label":"Enable the authentication service setting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/other/enableauthenticationservicesetting","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/other/enableauthenticationservicesetting","metadata":{"seo":{"title":"Enable the authentication service setting","description":"Enables the authentication service setting for Access Gateway"}},"httpPath":"/api/v2/settings/authentication-service"},{"label":"Disable the authentication service setting","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/other/disableauthenticationservicesetting","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/other/disableauthenticationservicesetting","metadata":{"seo":{"title":"Disable the authentication service setting","description":"Disables the authentication service setting for Access Gateway"}},"httpPath":"/api/v2/settings/authentication-service"},{"label":"/api/v2/settings/authentication-service/health-check","deprecated":false,"httpVerb":"x-okta-team-detail","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service~1health-check/x-okta-team-detail","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service~1health-check/x-okta-team-detail","metadata":{"seo":{"title":"/api/v2/settings/authentication-service/health-check"}},"httpPath":"/api/v2/settings/authentication-service/health-check"},{"label":"/api/v2/settings/authentication-service/health-check","deprecated":false,"httpVerb":"x-okta-lifecycle","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service~1health-check/x-okta-lifecycle","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/paths/~1api~1v2~1settings~1authentication-service~1health-check/x-okta-lifecycle","metadata":{"seo":{"title":"/api/v2/settings/authentication-service/health-check"}},"httpPath":"/api/v2/settings/authentication-service/health-check"},{"label":"Retrieve the authentication service health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oag/oag/tags/settings-authentication-service/other/getauthenticationservicehealthcheck","routeSlug":"/openapi/oag/oag/tags/settings-authentication-service/other/getauthenticationservicehealthcheck","metadata":{"seo":{"title":"Retrieve the authentication service health check","description":"Retrieves the current health check status of the authentication service for Access Gateway"}},"httpPath":"/api/v2/settings/authentication-service/health-check"}],"metadata":{"type":"openapi","title":"Authentication Service","description":"The Authentication Service API allows you to manage the settings of the authentication service in your Access Gateway cluster. Authentication service settings at the cluster level apply to all applications and IdPs on the Access Gateway instance.\n> **Note:** This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change."}}]}],"menuStyle":"drilldown"}]}