openapi: 3.0.0
info:
  title: Okta Admin Management
  description: |-
    Allows customers to easily access the Okta Management APIs

    Contact Support:
     Name: Okta Developer Team
     Email: devex-public@okta.com
  version: 1.0.0
servers:
  - url: http://{{baseurl}}
components:
  securitySchemes:
    apikeyAuth:
      type: http
      scheme: apikey
    oauth2Auth:
      type: http
      scheme: oauth2
security:
  - oauth2Auth: []
tags:
  - name: Agent Pools
    description: >-
      The Agent Pools API provides operation to manage the update settings of
      the agents for your organization.
  - name: API Service Integrations
    description: >
      This API provides operations to manage API service integration instances
      in your organization.


      For a current list of available API service integrations, see the [Okta
      Integration Network
      catalog](https://www.okta.com/integrations/?capability=api).


      See [Add an API Service
      Integration](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-api-service-integration)
      for corresponding admin instructions using the Admin Console.

      If you want to build an API service integration, see [API service
      integrations in the
      OIN](https://developer.okta.com/docs/guides/oin-api-service-overview/).
  - name: API Tokens
    description: >-
      The API Tokens API provides operations to manage SSWS API tokens for your
      organization.
  - name: Applications
    description: >-
      The Applications API provides operations to manage applications and/or
      assignments to users or groups for your organization.
  - name: Application Connections
    description: >
      The Application Connections API provides operations for configuring
      connections to an app.


      Currently, only the Okta Org2Org app provisioning connection is supported
      in this API.
  - name: Application Credentials
    description: >
      Specifies credentials and scheme for the application's `signOnMode`


      ### Application Key Credential

      The application Key Credential object defines a [JSON Web
      Key](https://datatracker.ietf.org/doc/html/rfc7517) for a signature or
      encryption credential for an application.


      > **Notes:**

      > * To update the app, you can provide just the Signing Credential object
      instead of the entire Application Credential object.

      > * Currently only the X.509 JWK format is supported for applications with
      the `SAML_2_0` sign-on mode.
  - name: Application Features
    description: >
      The Application Features API supports operations to configure app feature
      settings.


      You must have app provisioning enabled to configure provisioning features.
      See [Update the default Provisioning
      Connection](/openapi/okta-management/management/tag/ApplicationConnections/#tag/ApplicationConnections/operation/updateDefaultProvisioningConnectionForApplication).


      The following available provisioning feature is supported by the indicated
      app:


      | <div style="width:200px">Feature</div> | Apps&nbsp;supported |
      Description   |

      | -------------------- | -------------- | ----------- |

      | `USER_PROVISIONING`  | `org2org` | Similar to the app **Provisioning** >
      **To App** setting in the Admin Console, this feature configures the
      **Create Users**, **Update User Attributes**, **Deactivate Users**, and
      **Sync Password** settings. |


      > **Note:** You can't use the `USER_PROVISIONING` feature in an Okta
      Developer-Edition org because the `org2org` app isn't available in
      developer orgs.

      > If you need to test this feature in your Developer-Edition org, contact
      your Okta account team.
  - name: Application Grants
    description: >
      The Application Grants API provides a set of operations to manage scope
      consent grants for an app.


      A scope consent grant represents an app's permission to include specific
      Okta scopes in OAuth 2.0 Bearer tokens.

      If the app doesn't have permission to grant consent for a particular Okta
      scope, token requests that contain the scope are denied.
  - name: Application Groups
    description: Groups assigned to an application
  - name: Application Logos
    description: Provides a resource to manage the application instance logo
  - name: Okta Application Settings
    description: >-
      The Okta Application Settings API provides operations to manage settings
      for Okta applications.
  - name: Application Policies
    description: >-
      Provides a resource to manage authentication policies associated with an
      application
  - name: Application SSO
    description: Provides a Single Sign-On (SSO) resource for an application
  - name: Application Tokens
    description: >
      Resource to manage OAuth 2.0 tokens for an app

      > **Note:** To configure refresh tokens for an app, see

      >
      [grant_types](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=4/settings/oauthClient/grant_types&t=request)

      > and
      [refresh_token](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=4/settings/oauthClient/refresh_token&t=request).
  - name: Application Users
    description: Application user operations
  - name: 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.
  - name: Authenticators
    description: >-
      The Authenticators Administration API provides operations to configure
      which Authenticators are available to end users for use when signing in to
      applications.


      End users are required to use one or more Authenticators depending on the
      security requirements of the authentication policy.


      Okta Identity Engine currently supports Authenticators for the following
      factors:


      **Knowledge-based:**


      * Password

      * Security Question


      **Possession-based:**


      * Phone (SMS, Voice Call)

      * Email

      * WebAuthn

      * Duo

      * Custom App
  - name: 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.


      **Work with the Default Authorization Server**


      Okta 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:


      `https://${yourOktaDomain}/api/v1/authorizationServers/default`


      vs


      `https://${yourOktaDomain}/api/v1/authorizationServers/${authorizationServerId}`
      for other Custom Authorization Servers
  - name: 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://developer.okta.com/docs/guides/set-up-token-exchange/main/#trusted-servers)
      between other authorization servers under the same Okta tenant.
  - name: Authorization Server Claims
    description: >-
      Provides operations to manage custom token claims for the given
      `authServerId` and `claimId`
  - name: Behavior Rules
    description: >-
      The Behavior Rules API provides operations to manage the behavior
      detection rules for your organization.
  - name: 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).


      The 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.


      Before you configure your org to use CAPTCHA, sign in to the vendor of
      your choice or sign up for an account. For more details, refer to [CAPTCHA
      integration](https://help.okta.com/okta_help.htm?type=oie&id=csh-captcha).
  - name: Custom Domains
    description: >-
      The Custom Domains API provides operations to manage custom domains for
      your organization.
  - name: Customizations
    description: >-
      The Brands API allows you to customize the look and feel of pages and
      templates, such as the Okta-hosted sign-in page, error pages, email
      templates, and the Okta End-User Dashboard.


      Each new org contains Okta default branding. You can upload your own
      assets (colors, background image, logo, and favicon) to replace the
      default assets and publish these assets directly to your pages and
      templates.
  - name: 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.


      The Devices API supports the following **Device Operations**:

      * Get, Delete Device objects.

      * 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.

      The Devices API supports the following **Authorization Schemes**:

      * SSWS - [API
      tokens](https://developer.okta.com/docs/reference/core-okta-api/#authentication)

      * Bearer - [OAuth2.0 and OpenID
      Connect](https://developer.okta.com/docs/concepts/oauth-openid/)


      > **Note:** For devices to enroll in Okta and show up in the Devices API,
      the following actions are required:

      > 1. Admins - Enable Okta FastPass. See [Enable
      FastPass](https://help.okta.com/okta_help.htm?type=oie&id=ext-fp-enable)

      > 2. End users with existing mobile Okta Verify enrollments - After you
      upgrade your org to Okta Identity Engine, direct end users with existing
      Okta Verify enrollments to use
      [FastPass](https://help.okta.com/okta_help.htm?type=oie&id=csh-fp-main).


      > **Note:** 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.

      See [Device
      Registration](https://help.okta.com/okta_help.htm?type=oie&id=csh-device-registration),
      [Login Using Okta
      Verify](https://help.okta.com/okta_help.htm?type=eu&id=ext-ov-user-overview).
  - name: Device Assurance Policies
    description: >-
      The Device Assurance Policies API provides operations to manage device
      assurance policies in your organization.
  - name: Email Domains
    description: >-
      The Email Domains API provides operations to manage email domains for your
      organization.
  - name: 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.
  - name: Event Hooks
    description: >-
      The Event Hooks API provides operations to manage event hooks for your
      organization.


      For general information on event hooks and how to create and use them, see
      [Event hooks](https://developer.okta.com/docs/concepts/event-hooks/). The
      following documentation is only for the management API, which provides a
      CRUD interface for registering event hooks.


      For a step-by-step guide on implementing an example event hook, see the
      [Event
      hook](https://developer.okta.com/docs/guides/event-hook-implementation/)
      guide.


      When you create an event hook, you need to specify which events you want
      to subscribe to. To see the list of event types currently eligible for use
      in event hooks, use the [Event
      Types](https://developer.okta.com/docs/reference/api/event-types/#catalog)
      catalog and search with the parameter `event-hook-eligible`.
  - name: Features
    description: >-
      The Okta Features API provides operations to manage self-service Early
      Access (EA) and Beta features in your org.


      > **Note:** Important background information for this API is available on
      the [Feature Lifecycle
      Management](https://developer.okta.com/docs/concepts/feature-lifecycle-management/)
      page.
  - name: Groups
    description: >-
      The Groups API provides operations to manage Okta Groups and their user
      members for your organization.
  - name: Hook Keys
    description: >-
      The Hook Keys API provides operations to manage hook keys for your
      organization.
  - name: Identity Providers
    description: >-
      The Identity Providers API provides operations to manage federations with
      external Identity Providers (IdP). For example, your app can support
      signing in with credentials from Apple, Facebook, Google, LinkedIn,
      Microsoft, an enterprise IdP using SAML 2.0, or an IdP using the OpenID
      Connect (`OIDC`) protocol.
  - name: 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.
  - name: Inline Hooks
    description: >-
      The Inline Hooks API provides operations to manage inline hooks for your
      organization.


      For general information on inline hooks and how to create and use them,
      see [inline
      hooks](https://developer.okta.com/docs/concepts/inline-hooks/). The
      following documentation is only for the management API, which provides a
      CRUD interface for registering inline hooks.
  - name: 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.


      1. 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.

      2. 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.


      For each relationship:


      * 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).

      * A user can be the `primary` in one relationship and the `associated` in
      another.

      * A user can be both the `primary` and `associated` in the same
      relationship.


      Okta Expression Language function for [Linked
      Objects](https://developer.okta.com/docs/reference/okta-expression-language/#linked-object-function)
      provides access to the details about a linked user.


      > **Note:** The Linked Objects feature isn't available for OpenID Connect
      claims.


      ## Example usage


      Okta allows you to create up to 200 Linked Object definitions. These
      definitions are one-to-many, for example:


      * A manager has many subordinates. Each subordinate has one manager.

      * A sales representative has many customers. Each customer has one sales
      rep.

      * A case worker has many clients. Each client has one case worker.


      Most organizations 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.


      You 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 a user can be assigned to
      more than one Linked Object definition.


      For example, assume that you've created one Linked Object definition for
      manager (`primary`) and for subordinates (`associated`):


      * Joe is Frank's manager.

      * Bob is Joe's manager, but Jane's subordinate.

      * Jane is the CEO, so she reports to herself.


      Thus, you can create chains of relationships (Jane > Bob > Joe > Frank) or
      terminal relationships (Jane is both `primary` and `associated` user).


      Then, if you create another Linked Object relationship for scrum team
      membership, you could assign relationships to the same four users:


      * Bob is the scrum lead for the Identity Scrum team.

      * Joe and Frank are both contributors to the team.


      Bob 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.


      To 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.


      ## Links between User Types


      If you created multiple User Types, 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.
  - name: 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.
  - name: Network Zones
    description: >-
      The Okta Network Zones API provides operations to manage Zones in your
      organization. There are two usage Zone types: Policy Network Zones and
      Blocklist Network Zones. Policy Network Zones are used to guide policy
      decisions. Blocklist Network Zones are used to deny access from certain IP
      addresses, locations, proxy types, or Autonomous System Numbers (ASNs)
      before policy evaluation.


      A default system Policy Network Zone is provided in your Okta org. You can
      use the Network Zones API to modify the default Policy Network Zone or to
      create a custom Policy or Blocklist Network Zone. When you create your
      custom Zone, you can specify if the Zone is an IP Zone or a Dynamic Zone.
      An IP Zone allows you to define network perimeters around a set of IPs,
      whereas a Dynamic Zone allows you to define network perimeters around
      location, IP type, and ASNs.


      > **Note:** To create multiple network zones, including Dynamic Zones, you
      must enable Adaptive MFA.
  - name: Org Settings
    description: >-
      The Org Settings API provides operations to manage your org account
      settings such as contact information, granting Okta Support access, and
      more.
  - name: 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, among other things, user session lifetime, whether
      multi-factor authentication is required when logging in, what MFA factors
      may be employed, password complexity requirements, what types of
      self-service operations are permitted under various circumstances, and
      what identity provider to route users to.


      Policy settings for a particular Policy type, such as 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.
  - name: Principal Rate Limits
    description: >-
      The Principal Rate Limits API provides operations to manage Principal Rate
      Limits for your organization.
  - name: 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://developer.okta.com/docs/reference/okta-expression-language).
      More information on Okta User and App User Profiles can be found in Okta's
      [User
      profiles](https://developer.okta.com/docs/concepts/user-profiles/#what-is-the-okta-universal-directory).
  - name: Push Providers
    description: >-
      The Push Providers API provides operations to manage Push Providers for
      your organization.
  - name: Rate Limit Settings
    description: >-
      The Rate Limit Settings APIs provide operations to manage settings and
      configurations surrounding rate limiting in your Okta organization.
  - name: Resource Sets
    description: >-
      The Resource Sets API provides operations to manage Resource Sets as
      custom collections of resources. You can use Resource Sets to assign
      Custom Roles to administrators who are scoped to the designated resources.
      See [Supported
      Resources](https://developer.okta.com/docs/concepts/role-assignment/#supported-resources).
  - name: Risk Events
    description: >-
      The Risk Events API provides the ability for third-party risk providers to
      send risk events to Okta. See [Third-party risk provider
      integration](https://developer.okta.com/docs/guides/third-party-risk-integration/)
      for guidance on integrating third-party risk providers with Okta.
  - name: Risk Providers
    description: >-
      The Risk Providers API provides the ability to manage the Risk Providers
      within Okta. See [Third-party risk provider
      integration](https://developer.okta.com/docs/guides/third-party-risk-integration/)
      for guidance on integrating third-party risk providers with Okta.
  - name: Roles
    description: >-
      The Roles API provides operations to manage administrative Role
      assignments for a User.


      Role listing APIs provide a union of both standard and Custom Roles
      assigned to a User or Group.
  - name: Role Assignments
    description: >-
      These APIs allow you to assign custom roles to user and groups, as well as
      designate Third-Party Administrator status to a user or group.
  - name: Role Targets
    description: >-
      Role targets are a way of defining permissions for admin roles into a
      smaller subset of Groups or Apps within your org. Targets limit an admin's
      permissions to a targeted area of the org. You can define admin roles to
      target Groups, Applications, and Application Instances.


      * **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.

      * **App targets:** Grant an admin permission to manage all instances of
      the specified Apps. Target Apps are Okta catalog Apps. For example, you
      can have multiple configurations of an Okta catalog App, such as
      Salesforce or Facebook. When you add a Salesforce or Facebook App as a
      target, that grants the admin permission to manage all the instances of
      those Apps and create new instances of them.

      * **App Instance targets:** Grant an admin permission to manage an
      instance of one App or instances of multiple Apps. App Instances are
      specific Apps that admins have created in their org. For example, there
      may be a Salesforce App configured differently for each sales region of a
      company. When you create an App Instance target, you can assign an admin
      to manage only two instances of the configured Salesforce Apps and then
      also to manage an instance of another configured App such as Workday.


      > **Note:** Don't use these operations with a Custom Role ID. Custom Role
      assignments always require a target Resource Set. See [Role
      Assignments](https://developer.okta.com/docs/concepts/role-assignment/)
      for more information.
  - name: 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.


      Okta's [Universal
      Directory](https://help.okta.com/okta_help.htm?id=ext_About_Universal_Directory)
      allows administrators to define custom User profiles for Okta Users and
      Applications.

      Okta 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.

      For Log Stream Schemas, Okta uses [JSON Schema Draft
      2020-12](https://json-schema.org/specification.html).

      [JSON Schema](http://json-schema.org/) is a lightweight declarative format
      for describing the structure, constraints, and validation of JSON
      documents.


      > **Note:** Okta implements only a subset of [JSON Schema Draft
      4](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).
  - name: 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.


      >**Note:** Some browsers block third-party cookies by default, which
      disrupts Okta functionality in certain flows. See [FAQ: How Blocked Third
      Party Cookies Can Potentially Impact Your Okta
      Environment](https://support.okta.com/help/s/article/FAQ-How-Blocking-Third-Party-Cookies-Can-Potentially-Impact-Your-Okta-Environment).


      >**Note:** The Sessions API doesn't support direct authentication. Direct
      authentication is supported through the [Authentication
      API](https://developer.okta.com/docs/reference/api/authn/#authentication-operations)
      or through OIDC using the [Resource Owner Password
      flow](https://developer.okta.com/docs/guides/implement-grant-type/ropassword/main/).


      ### Session cookie


      Okta 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.


      ### Session token


      A [session
      token](https://developer.okta.com/docs/reference/api/authn/#session-token)
      is a one-time bearer token that provides proof of authentication and may
      be redeemed for an interactive SSO session in Okta in a user agent.
      Session tokens can only be used **once** to establish a Session for a user
      and are revoked when the token expires.


      Okta provides a very rich [Authentication
      API](https://developer.okta.com/docs/reference/api/authn/) to validate a
      [user's primary
      credentials](https://developer.okta.com/docs/reference/api/authn/#primary-authentication)
      and secondary [MFA
      factor](https://developer.okta.com/docs/reference/api/authn/#verify-factor).
      A session token is returned after successful authentication, which can be
      later exchanged for a session cookie that uses one of the following flows:


      - [Retrieve a session cookie by visiting the OpenID Connect Authorization
      Endpoint](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-through-the-openid-connect-authorization-endpoint)

      - [Retrieve a session cookie by visiting a session redirect
      link](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-by-visiting-a-session-redirect-link)

      - [Retrieve a session cookie by visiting an application embed
      link](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-by-visiting-an-application-embed-link)


      >**Note:** **Session tokens** are secrets and should be protected at rest
      and during transit. A session token for a user is equivalent to having the
      user's actual credentials.
  - name: Subscriptions
    description: >-
      The Subscriptions API provides operations to manage email subscription
      settings for Okta administrator notifications.
  - name: System Log
    description: >-
      The 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.


      The System Log API provides near real-time, read-only access to your
      organization's system log and is the programmatic counterpart of the
      [System Log
      UI](https://help.okta.com/okta_help.htm?id=ext_Reports_SysLog).


      The 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.


      The System Log API supports these primary use cases:
        * Event data export into a security information and event management system (SIEM)
        * System monitoring
        * Development debugging
        * Event introspection and audit

      The System Log API isn't intended for use as a Database as a Service
      (DBaaS) or to serve data directly to downstream consumers without an
      intermediate data store.


      See [Events API
      Migration](https://developer.okta.com/docs/concepts/events-api-migration/)
      for information on migrating from the Events API to the System Log API.
  - name: SMS Templates
    description: >-
      The SMS Templates API provides operations to manage custom SMS templates
      for verification.


      > **Note:** Only SMS custom Templates are available through the API.


      SMS 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.
  - name: ThreatInsight
    description: >-
      [Okta
      ThreatInsight](https://help.okta.com/okta_help.htm?id=ext_threatinsight)
      maintains a

      constantly evolving list of IP addresses that consistently exhibit
      malicious activity.

      Authentication requests that are associated with an IP in this list can be
      logged to the

      [System Log](https://help.okta.com/okta_help.htm?id=ext_Reports_SysLog)
      and blocked.

      ThreatInsight also covers non-authentication requests in limited capacity
      depending on the attack patterns of these malicious IPs.


      The ThreatInsight API provides operations to manage your org ThreatInsight
      configuration.


      > **Note:** To prevent abuse, Okta ThreatInsight works in a limited
      capacity for free trial edition orgs. Please contact Okta support if fully
      functional Okta ThreatInsight is required.
  - name: Trusted Origins
    description: >-
      The Trusted Origins API provides operations to manage Trusted Origins and
      sources.


      When 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.


      You 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. This is an Early Access feature. To enable it, contact
      [Okta Support](https://support.okta.com/help/s/).


      > **Note:** This Early Access feature is supported for Okta domains only.
      It isn't currently supported for custom domains.
  - name: 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.


      If you're not sure which solution you're using, check the footer on any
      page of the Admin Console. The version number is appended with E for
      Identity Engine orgs and C for Classic Engine orgs.
  - name: Users
    description: The User API provides operations to manage users in your organization.
  - name: User Factors
    description: >-
      The Factors API provides operations to enroll, manage, and verify factors
      for multifactor authentication (MFA). Manage both administration and
      end-user accounts, or verify an individual factor at any time.
  - name: User Types
    description: The User Types API provides operations to manage User Types.
  - name: WebAuthnPreregistration
    description: >-
      The WebAuthn Preregistration API provides a flow to initiate and set up
      WebAuthn Preregistration authenticator enrollments through third-party
      providers.
paths:
  /api/v1/agentPools:
    get:
      tags:
        - Agent Pools
      summary: List all Agent Pools
      description: Lists all agent pools with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: limitPerPoolType
          in: query
          schema:
            type: integer
          description: Maximum number of AgentPools being returned
          example: '5'
        - name: poolType
          in: query
          schema:
            type: string
          description: Agent type to search for
          example: RUM
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - agents:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: Excepteur minim nisi commodo
                  name: dolore laboris laborum ut
                  operationalStatus: DEGRADED
                  type: RUM
                - agents:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: anim laboris Excepteur
                  name: laborum ullamco aliquip
                  operationalStatus: DISRUPTED
                  type: LDAP
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates:
    get:
      tags:
        - Agent Pools
      summary: List all Agent Pool updates
      description: Lists all agent pool updates
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: scheduled
          in: query
          schema:
            type: boolean
          description: >-
            Scope the list only to scheduled or ad-hoc updates. If the parameter
            is not provided we will return the whole list of updates.
          example: 'true'
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - agents:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  agentType: Radius
                  enabled: true
                  id: officia ex
                  name: aliqua nulla
                  notifyAdmin: false
                  reason: exercitation enim culpa consequat
                  schedule:
                    cron:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    delay:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    duration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastUpdated:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    timezone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  sortOrder: -99180687
                  status: Success
                  targetVersion: sint tempor occaecat labo
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - agents:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  agentType: MFA
                  enabled: false
                  id: incididunt consectetur
                  name: amet qui elit consectetur non
                  notifyAdmin: false
                  reason: velit adipisicing occaecat
                  schedule:
                    cron:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    delay:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    duration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastUpdated:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    timezone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  sortOrder: 87716461
                  status: Cancelled
                  targetVersion: aliqua non Excepteur
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Agent Pools
      summary: Create an Agent Pool update
      description: >-
        Creates an Agent pool update \n For user flow 2 manual update, starts
        the update immediately. \n For user flow 3, schedules the update based
        on the configured update window and delay.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                agents:
                  - isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: IWA
                enabled: true
                name: adipisicing do ut mollit
                notifyAdmin: false
                reason: Duis minim sit
                schedule:
                  cron: aute dolor ea non
                  delay: -88861825
                  duration: 67673023
                  lastUpdated: '1990-10-05T22:39:15.468Z'
                  timezone: ea pariatur aute
                sortOrder: 23360284
                status: Cancelled
                targetVersion: ipsum laboris
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/settings:
    get:
      tags:
        - Agent Pools
      summary: Retrieve an Agent Pool update's settings
      description: Retrieves the current state of the agent pool update instance settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agentType: MFA
                continueOnError: true
                latestVersion: Lorem
                minimalSupportedVersion: mollit magna
                poolId: irure
                poolName: ex s
                releaseChannel: BETA
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Agent Pools
      summary: Update an Agent Pool update settings
      description: Updates an agent pool update settings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                agentType: AD
                continueOnError: true
                latestVersion: consectetur ut cupidatat tempor
                minimalSupportedVersion: voluptate in
                poolName: in pariatur veniam ut
                releaseChannel: EA
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agentType: MFA
                continueOnError: true
                latestVersion: Lorem
                minimalSupportedVersion: mollit magna
                poolId: irure
                poolName: ex s
                releaseChannel: BETA
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}:
    get:
      tags:
        - Agent Pools
      summary: Retrieve an Agent Pool update by id
      description: Retrieves Agent pool update from updateId
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Agent Pools
      summary: Update an Agent Pool update by id
      description: Updates Agent pool update and return latest agent pool update
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                agents:
                  - isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: IWA
                enabled: true
                name: adipisicing do ut mollit
                notifyAdmin: false
                reason: Duis minim sit
                schedule:
                  cron: aute dolor ea non
                  delay: -88861825
                  duration: 67673023
                  lastUpdated: '1990-10-05T22:39:15.468Z'
                  timezone: ea pariatur aute
                sortOrder: 23360284
                status: Cancelled
                targetVersion: ipsum laboris
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Agent Pools
      summary: Delete an Agent Pool update
      description: Deletes Agent pool update
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/activate:
    post:
      tags:
        - Agent Pools
      summary: Activate an Agent Pool update
      description: Activates scheduled Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/deactivate:
    post:
      tags:
        - Agent Pools
      summary: Deactivate an Agent Pool update
      description: Deactivates scheduled Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/pause:
    post:
      tags:
        - Agent Pools
      summary: Pause an Agent Pool update
      description: Pauses running or queued Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/resume:
    post:
      tags:
        - Agent Pools
      summary: Resume an Agent Pool update
      description: Resumes running or queued Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/retry:
    post:
      tags:
        - Agent Pools
      summary: Retry an Agent Pool update
      description: Retries Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/agentPools/{poolId}/updates/{updateId}/stop:
    post:
      tags:
        - Agent Pools
      summary: Stop an Agent Pool update
      description: Stops Agent pool update
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: poolId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the agent pool for which the settings will apply
          example: mollit occaecat cupidatat
        - name: updateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the update
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                agents:
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isHidden:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isLatestGAedVersion:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastConnection:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    operationalStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    poolId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateMessage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    updateStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                agentType: LDAP
                enabled: false
                id: amet minim quis qui
                name: fugiat consectetur sed irure
                notifyAdmin: false
                reason: culpa dolore sed incididunt
                schedule:
                  cron: eu pariatur
                  delay: -63894301
                  duration: -2967852
                  lastUpdated: '1969-10-13T23:45:28.735Z'
                  timezone: u
                sortOrder: 10190313
                status: Scheduled
                targetVersion: anim tempor proident et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services:
    get:
      tags:
        - API Service Integrations
      summary: List all API Service Integration instances
      description: Lists all API Service Integration instances with a pagination option
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 0oa72lrepvp4WqEET1d9
                  type: my_app_cie
                  name: My App Cloud Identity Engine
                  createdAt: '2023-02-21T20:08:24.000Z'
                  createdBy: 00uu3u0ujW1P6AfZC2d5
                  configGuideUrl: https://{docDomain}/my-app-cie/configuration-guide
                  grantedScopes:
                    - okta.logs.read
                    - okta.groups.read
                    - okta.users.read
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9
                      hints:
                        allow:
                          - GET
                          - DELETE
                    client:
                      href: >-
                        https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9
                      hints:
                        allow:
                          - GET
                    logo:
                      name: small
                      href: https://{logoDomain}/{logoPath}/my_app_cie_small_logo
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - API Service Integrations
      summary: Create an API Service Integration instance
      description: Creates and authorizes an API Service Integration instance
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: my_app_cie
                grantedScopes:
                  - okta.logs.read
                  - okta.groups.read
                  - okta.users.read
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa72lrepvp4WqEET1d9
                type: my_app_cie
                name: My App Cloud Identity Engine
                createdAt: '2023-02-21T20:08:24.000Z'
                createdBy: 00uu3u0ujW1P6AfZC2d5
                clientSecret: CkF69kXtag0q0P4pXU8OnP5IAzgGlwx6eqGy7Fmg
                configGuideUrl: https://{docDomain}/my-app-cie/configuration-guide
                grantedScopes:
                  - okta.logs.read
                  - okta.groups.read
                  - okta.users.read
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9
                    hints:
                      allow:
                        - GET
                        - DELETE
                  client:
                    href: >-
                      https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9
                    hints:
                      allow:
                        - GET
                  logo:
                    name: small
                    href: https://{logoDomain}/{logoPath}/my_app_cie_small_logo
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services/{apiServiceId}:
    get:
      tags:
        - API Service Integrations
      summary: Retrieve an API Service Integration instance
      description: Retrieves an API Service Integration instance by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa72lrepvp4WqEET1d9
                type: my_app_cie
                name: My App Cloud Identity Engine
                createdAt: '2023-02-21T20:08:24.000Z'
                createdBy: 00uu3u0ujW1P6AfZC2d5
                configGuideUrl: https://{docDomain}/my-app-cie/configuration-guide
                grantedScopes:
                  - okta.logs.read
                  - okta.groups.read
                  - okta.users.read
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9
                    hints:
                      allow:
                        - GET
                        - DELETE
                  client:
                    href: >-
                      https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9
                    hints:
                      allow:
                        - GET
                  logo:
                    name: small
                    href: https://{logoDomain}/{logoPath}/my_app_cie_small_logo
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - API Service Integrations
      summary: Delete an API Service Integration instance
      description: >-
        Deletes an API Service Integration instance by `id`. This operation also
        revokes access to scopes that were previously granted to this API
        Service Integration instance.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets:
    get:
      tags:
        - API Service Integrations
      summary: List all API Service Integration instance Secrets
      description: >-
        Lists all client secrets for an API Service Integration instance by
        `apiServiceId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: ocs2f4zrZbs8nUa7p0g4
                  status: INACTIVE
                  client_secret: '***DhOW'
                  secret_hash: yk4SVx4sUWVJVbHt6M-UPA
                  created: '2023-02-21T20:08:24.000Z'
                  lastUpdated: '2023-02-21T20:08:24.000Z'
                  _links:
                    activate:
                      href: >-
                        https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate
                      hints:
                        allow:
                          - POST
                    delete:
                      href: >-
                        https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4
                      hints:
                        allow:
                          - DELETE
                - id: ocs2f50kZB0cITmYU0g4
                  status: ACTIVE
                  client_secret: '***MQGQ'
                  secret_hash: 0WOOvBSzV9clc4Nr7Rbaug
                  created: '2023-04-06T21:32:33.000Z'
                  lastUpdated: '2023-04-06T21:32:33.000Z'
                  _links:
                    deactivate:
                      href: >-
                        https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate
                      hints:
                        allow:
                          - POST
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - API Service Integrations
      summary: Create an API Service Integration instance Secret
      description: >-
        Creates an API Service Integration instance Secret object with a new
        active client secret. You can create up to two Secret objects. An error
        is returned if you attempt to create more than two Secret objects.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ocs2f50kZB0cITmYU0g4
                status: ACTIVE
                client_secret: DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B
                secret_hash: FpCwXwSjTRQNtEI11I00-g
                created: '2023-04-06T21:32:33.000Z'
                lastUpdated: '2023-04-06T21:32:33.000Z'
                _links:
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}:
    delete:
      tags:
        - API Service Integrations
      summary: Delete an API Service Integration instance Secret
      description: >-
        Deletes an API Service Integration instance Secret by `secretId`. You
        can only delete an inactive Secret.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
        - name: secretId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance Secret
          example: ocs2f4zrZbs8nUa7p0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activate:
    post:
      tags:
        - API Service Integrations
      summary: Activate an API Service Integration instance Secret
      description: Activates an API Service Integration instance Secret by `secretId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
        - name: secretId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance Secret
          example: ocs2f4zrZbs8nUa7p0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ocs2f50kZB0cITmYU0g4
                status: ACTIVE
                client_secret: '***MQGQ'
                secret_hash: 0WOOvBSzV9clc4Nr7Rbaug
                created: '2023-04-06T21:32:33.000Z'
                lastUpdated: '2023-04-06T21:32:33.000Z'
                _links:
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivate:
    post:
      tags:
        - API Service Integrations
      summary: Deactivate an API Service Integration instance Secret
      description: Deactivates an API Service Integration instance Secret by `secretId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiServiceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance
          example: 000lr2rLjZ6NsGn1P0g3
        - name: secretId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the API Service Integration instance Secret
          example: ocs2f4zrZbs8nUa7p0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ocs2f4zrZbs8nUa7p0g4
                status: INACTIVE
                client_secret: '***DhOW'
                secret_hash: yk4SVx4sUWVJVbHt6M-UPA
                created: '2023-02-21T20:08:24.000Z'
                lastUpdated: '2023-02-21T20:08:24.000Z'
                _links:
                  activate:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate
                    hints:
                      allow:
                        - POST
                  delete:
                    href: >-
                      https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4
                    hints:
                      allow:
                        - DELETE
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000011
                errorSummary: Invalid token provided
                errorLink: E0000011
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/api-tokens:
    get:
      tags:
        - API Tokens
      summary: List all API Token Metadata
      description: Lists all the metadata of the active API tokens
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - name: My API Token
                  userId: 00uabcdefg1234567890
                  tokenWindow: P30D
                  id: 00Tabcdefg1234567890
                  clientName: Okta API
                  expiresAt: '2021-12-11T20:38:10.000Z'
                  created: '2021-11-09T20:38:10.000Z'
                  lastUpdated: '2021-11-11T20:38:10.000Z'
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/api-tokens/00Tabcdefg1234567890
                      hints:
                        allow:
                          - GET
                          - DELETE
                    user:
                      href: >-
                        https://{yourOktaDomain}/api/v1/users/00uabcdefg1234567890
                      hints:
                        allow:
                          - GET
                - name: Another API Token
                  userId: 00uabcdefg1234567890
                  tokenWindow: PT5M
                  id: 00T1234567890abcdefg
                  clientName: Okta API
                  expiresAt: '2021-11-11T20:43:10.000Z'
                  created: '2021-11-09T20:38:10.000Z'
                  lastUpdated: '2021-11-11T20:38:10.000Z'
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/api-tokens/00T1234567890abcdefg
                      hints:
                        allow:
                          - GET
                          - DELETE
                    user:
                      href: >-
                        https://{yourOktaDomain}/api/v1/users/00uabcdefg1234567890
                      hints:
                        allow:
                          - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/api-tokens/current:
    delete:
      tags:
        - API Tokens
      summary: Revoke the Current API Token
      description: Revokes the API token provided in the Authorization header
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/api-tokens/{apiTokenId}:
    get:
      tags:
        - API Tokens
      summary: Retrieve an API Token's Metadata
      description: Retrieves the metadata for an active API token by id
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiTokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the API Token
          example: 00Tabcdefg1234567890
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: My API Token
                userId: 00uXXXXXXXXXXXXXXXXX
                tokenWindow: P30D
                id: 00Tabcdefg1234567890
                clientName: Okta API
                expiresAt: '2021-12-11T20:38:10.000Z'
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/api-tokens/00Tabcdefg1234567890
                    hints:
                      allow:
                        - GET
                        - DELETE
                  user:
                    href: https://{yourOktaDomain}/api/v1/users/00uXXXXXXXXXXXXXXXXX
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - API Tokens
      summary: Revoke an API Token
      description: Revokes an API token by `apiTokenId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: apiTokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the API Token
          example: 00Tabcdefg1234567890
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps:
    get:
      tags:
        - Applications
      summary: List all Applications
      description: >-
        Lists all applications with pagination. A subset of apps can be returned
        that match a supported filter expression or query.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of apps
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          description: Specifies the number of results for a page
          example: '-1'
        - name: filter
          in: query
          schema:
            type: string
          description: >-
            Filters apps by status, user.id, group.id or credentials.signing.kid
            expression
          example: mollit occaecat cupidatat
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            Traverses users link relationship and optionally embeds Application
            User resource
          example: mollit occaecat cupidatat
        - name: includeNonDeleted
          in: query
          schema:
            type: boolean
          example: 'false'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1951-12-07T03:04:53.719Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: et amet Ut sunt consequat
                  label: consectetur eu dolor
                  lastUpdated: '1976-01-05T02:25:24.470Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    autea:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    et3:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: SAML_2_0
                  status: DELETED
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    ipsum_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    cillum_69:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolor3:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1980-09-12T22:59:05.849Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: occaecat sunt commod
                  label: dolor
                  lastUpdated: '1956-01-27T04:10:23.472Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    ad1d5:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    adipisicing_cc6:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: WS_FEDERATION
                  status: INACTIVE
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    aliquip7a0:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Applications
      summary: Create an Application
      description: Creates a new application to your Okta organization
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                accessibility:
                  errorRedirectUrl: enim in sed consectetur
                  loginRedirectUrl: cupidatat esse
                  selfService: false
                features:
                  - id
                  - ul
                label: incididunt aliquip
                licensing:
                  seatCount: 27405937
                profile:
                  commodo_a: {}
                  proident_06: {}
                  sed_: {}
                  voluptate_6b: {}
                signOnMode: WS_FEDERATION
                visibility:
                  appLinks:
                    ipsum_4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    enim_a79:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    aliqua_adc:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    doa:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  autoLaunch: false
                  autoSubmitToolbar: false
                  hide:
                    iOS:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    web:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: OktaAccessGateway-Agent
          in: header
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: activate
          in: query
          schema:
            type: boolean
          description: Executes activation lifecycle operation when creating the app
          example: 'true'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                accessibility:
                  errorRedirectUrl: officia
                  loginRedirectUrl: est elit occaecat qui
                  selfService: false
                created: '1991-10-13T08:50:06.105Z'
                features:
                  - ad velit magna ea
                  - esse
                id: eiusmod fugiat
                label: ad pariatur enim dolor Duis
                lastUpdated: '2019-09-29T01:07:09.075Z'
                licensing:
                  seatCount: -19644082
                profile:
                  Utf0: {}
                  deserunt77c: {}
                signOnMode: BOOKMARK
                status: DELETED
                visibility:
                  appLinks:
                    eub45:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  autoLaunch: true
                  autoSubmitToolbar: false
                  hide:
                    iOS:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    web:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _embedded:
                  ad_6a: {}
                  ipsumaa8: {}
                _links:
                  accessPolicy:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  groups:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  metadata:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}:
    get:
      tags:
        - Applications
      summary: Retrieve an Application
      description: Retrieves an application from your Okta organization by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                accessibility:
                  errorRedirectUrl: officia
                  loginRedirectUrl: est elit occaecat qui
                  selfService: false
                created: '1991-10-13T08:50:06.105Z'
                features:
                  - ad velit magna ea
                  - esse
                id: eiusmod fugiat
                label: ad pariatur enim dolor Duis
                lastUpdated: '2019-09-29T01:07:09.075Z'
                licensing:
                  seatCount: -19644082
                profile:
                  Utf0: {}
                  deserunt77c: {}
                signOnMode: BOOKMARK
                status: DELETED
                visibility:
                  appLinks:
                    eub45:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  autoLaunch: true
                  autoSubmitToolbar: false
                  hide:
                    iOS:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    web:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _embedded:
                  ad_6a: {}
                  ipsumaa8: {}
                _links:
                  accessPolicy:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  groups:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  metadata:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Applications
      summary: Replace an Application
      description: Replaces an application
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                accessibility:
                  errorRedirectUrl: 'do '
                  loginRedirectUrl: ipsum reprehenderit ut voluptate
                  selfService: true
                features:
                  - aliqua
                  - quis Ut sed voluptate dolore
                label: in veniam incididunt ut ea
                licensing:
                  seatCount: 23508628
                profile:
                  dolor3: {}
                  essea5: {}
                  labore_bc: {}
                  voluptated: {}
                signOnMode: WS_FEDERATION
                visibility:
                  appLinks:
                    elit_653:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  autoLaunch: true
                  autoSubmitToolbar: false
                  hide:
                    iOS:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    web:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                accessibility:
                  errorRedirectUrl: officia
                  loginRedirectUrl: est elit occaecat qui
                  selfService: false
                created: '1991-10-13T08:50:06.105Z'
                features:
                  - ad velit magna ea
                  - esse
                id: eiusmod fugiat
                label: ad pariatur enim dolor Duis
                lastUpdated: '2019-09-29T01:07:09.075Z'
                licensing:
                  seatCount: -19644082
                profile:
                  Utf0: {}
                  deserunt77c: {}
                signOnMode: BOOKMARK
                status: DELETED
                visibility:
                  appLinks:
                    eub45:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  autoLaunch: true
                  autoSubmitToolbar: false
                  hide:
                    iOS:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    web:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _embedded:
                  ad_6a: {}
                  ipsumaa8: {}
                _links:
                  accessPolicy:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  groups:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  metadata:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Applications
      summary: Delete an Application
      description: Deletes an inactive application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/lifecycle/activate:
    post:
      tags:
        - Applications
      summary: Activate an Application
      description: Activates an inactive application
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/lifecycle/deactivate:
    post:
      tags:
        - Applications
      summary: Deactivate an Application
      description: Deactivates an active application
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/connections/default:
    get:
      tags:
        - Application Connections
      summary: Retrieve the default Provisioning Connection
      description: Retrieves the default Provisioning Connection for an app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                authScheme: TOKEN
                status: ENABLED
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default
                    hints:
                      allow:
                        - GET
                        - POST
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Application Connections
      summary: Update the default Provisioning Connection
      description: Updates the default Provisioning Connection for an app
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                profile:
                  authScheme: TOKEN
                  token: 00NgAPZqUVy8cX9ehNzzahEE5b-On9sImTcInvWp-x
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: activate
          in: query
          schema:
            type: boolean
          description: Activates the Provisioning Connection
          example: 'true'
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                authScheme: TOKEN
                status: ENABLED
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default
                    hints:
                      allow:
                        - GET
                        - POST
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/connections/default/lifecycle/activate:
    post:
      tags:
        - Application Connections
      summary: Activate the default Provisioning Connection
      description: Activates the default Provisioning Connection for an app
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/connections/default/lifecycle/deactivate:
    post:
      tags:
        - Application Connections
      summary: Deactivate the default Provisioning Connection
      description: Deactivates the default Provisioning Connection for an app
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/csrs:
    get:
      tags:
        - Application Credentials
      summary: List all Certificate Signing Requests
      description: Lists all Certificate Signing Requests for an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2012-07-21T16:40:33.566Z'
                  csr: laborum ut aliquip
                  id: reprehenderit id incididunt dolore commodo
                  kty: labore commodo labor
                - created: '1955-08-01T22:28:28.383Z'
                  csr: sit veniam
                  id: id sed non incididunt
                  kty: deserunt mollit Duis enim culpa
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Application Credentials
      summary: Generate a Certificate Signing Request
      description: >-
        Generates a new key pair and returns the Certificate Signing Request for
        it
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                subject:
                  commonName: ut
                  countryName: officia esse dolor in amet
                  localityName: consectetur veniam
                  organizationalUnitName: quis ea
                  organizationName: amet sit
                  stateOrProvinceName: occaecat nisi deserunt
                subjectAltNames:
                  dnsNames:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1965-02-16T08:36:23.841Z'
                csr: veniam in nisi magna ipsum
                id: ut ex adipisicing
                kty: ullamco voluptate
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/csrs/{csrId}:
    get:
      tags:
        - Application Credentials
      summary: Retrieve a Certificate Signing Request
      description: Retrieves a certificate signing request for the app by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: csrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the CSR
          example: fd7x1h7uTcZFx22rU1f7
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1965-02-16T08:36:23.841Z'
                csr: veniam in nisi magna ipsum
                id: ut ex adipisicing
                kty: ullamco voluptate
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Credentials
      summary: Revoke a Certificate Signing Request
      description: >-
        Revokes a certificate signing request and deletes the key pair from the
        application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: csrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the CSR
          example: fd7x1h7uTcZFx22rU1f7
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish:
    post:
      tags:
        - Application Credentials
      summary: Publish a Certificate Signing Request
      description: >-
        Publishes a certificate signing request for the app with a signed X.509
        certificate and adds it into the application key credentials
      requestBody:
        content:
          text/plain: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-x509-ca-cert
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: csrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the CSR
          example: fd7x1h7uTcZFx22rU1f7
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/keys:
    get:
      tags:
        - Application Credentials
      summary: List all Key Credentials
      description: Lists all key credentials for an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - alg: veniam anim proident in
                  created: '1987-05-28T09:19:57.006Z'
                  e: sunt Excepteur commodo et
                  expiresAt: '1966-09-22T19:48:59.232Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: consectetur ut culpa
                  kty: elit pariatur ipsum
                  lastUpdated: '2012-11-14T11:23:59.664Z'
                  'n': Lorem
                  status: eu amet ut ut
                  use: sunt esse minim ad
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: in Ut
                  x5t#S256: irure exercitation
                  x5u: sunt dolore fugiat cupidatat
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - alg: culpa elit aliquip
                  created: '2009-07-25T19:02:30.973Z'
                  e: aute laboris mollit
                  expiresAt: '1992-08-06T04:23:52.783Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: dolor proident
                  kty: enim exercitation dolore commodo
                  lastUpdated: '2003-02-11T03:15:07.846Z'
                  'n': dolore ut
                  status: labore eu
                  use: ullamco magna minim ea
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: nulla ullam
                  x5t#S256: enim dolore est
                  x5u: id in dolor ut aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/keys/generate:
    post:
      tags:
        - Application Credentials
      summary: Generate a Key Credential
      description: Generates a new X.509 certificate for an application key credential
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: validityYears
          in: query
          schema:
            type: integer
          example: '79905859'
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/keys/{keyId}:
    get:
      tags:
        - Application Credentials
      summary: Retrieve a Key Credential
      description: Retrieves a specific application key credential by kid
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: keyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Key Credential for the application
          example: sjP9eiETijYz110VkhHN
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/credentials/keys/{keyId}/clone:
    post:
      tags:
        - Application Credentials
      summary: Clone a Key Credential
      description: >-
        Clones a X.509 certificate for an application key credential from a
        source application to target application.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: targetAid
          in: query
          schema:
            type: string
          description: (Required) Unique key of the target Application
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: keyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Key Credential for the application
          example: sjP9eiETijYz110VkhHN
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/features:
    get:
      tags:
        - Application Features
      summary: List all Features
      description: >
        Lists all features for an application

        > **Note:** This request returns an error if provisioning isn't enabled
        for the application.

        > To set up provisioning, see [Update the default Provisioning
        Connection](/openapi/okta-management/management/tag/ApplicationConnections/#tag/ApplicationConnections/operation/updateDefaultProvisioningConnectionForApplication).
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - name: USER_PROVISIONING
                  status: ENABLED
                  description: >-
                    User provisioning settings from Okta to a downstream
                    application
                  capabilities:
                    create:
                      lifecycleCreate:
                        status: DISABLED
                    update:
                      profile:
                        status: DISABLED
                      lifecycleDeactivate:
                        status: DISABLED
                      password:
                        status: DISABLED
                        seed: RANDOM
                        change: KEEP_EXISTING
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING
                      hints:
                        allow:
                          - GET
                          - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: feature'
                errorLink: E0000001
                errorId: oaeZLxeiHUUQomPkM8xOqvu1A
                errorCauses:
                  - errorSummary: Provisioning is not enabled for the app instance.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/features/{featureName}:
    get:
      tags:
        - Application Features
      summary: Retrieve a Feature
      description: Retrieves a Feature object for an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: featureName
          in: path
          schema:
            type: string
          required: true
          description: (Required) Name of the Feature
          example: USER_PROVISIONING
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: USER_PROVISIONING
                status: ENABLED
                description: >-
                  User provisioning settings from Okta to a downstream
                  application
                capabilities:
                  create:
                    lifecycleCreate:
                      status: DISABLED
                  update:
                    profile:
                      status: DISABLED
                    lifecycleDeactivate:
                      status: DISABLED
                    password:
                      status: DISABLED
                      seed: RANDOM
                      change: KEEP_EXISTING
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING
                    hints:
                      allow:
                        - GET
                        - PUT
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Application Features
      summary: Update a Feature
      description: |
        Updates a Feature object for an application
        > **Note:** This endpoint supports partial updates.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                create:
                  lifecycleCreate:
                    status: ENABLED
                update:
                  lifecycleDeactivate:
                    status: ENABLED
                  profile:
                    status: ENABLED
                  password:
                    status: ENABLED
                    seed: RANDOM
                    change: CHANGE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: featureName
          in: path
          schema:
            type: string
          required: true
          description: (Required) Name of the Feature
          example: USER_PROVISIONING
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: USER_PROVISIONING
                status: ENABLED
                description: >-
                  User provisioning settings from Okta to a downstream
                  application
                capabilities:
                  create:
                    lifecycleCreate:
                      status: ENABLED
                  update:
                    lifecycleDeactivate:
                      status: ENABLED
                    profile:
                      status: ENABLED
                    password:
                      status: ENABLED
                      seed: RANDOM
                      change: CHANGE
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING
                    hints:
                      allow:
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/grants:
    get:
      tags:
        - Application Grants
      summary: List all app Grants
      description: Lists all scope consent Grants for the app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            An optional parameter to include scope details in the `_embedded`
            attribute. Valid value: `scope`
          example: scope
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: oag91n9ruw3dsaXzP0h6
                  status: ACTIVE
                  created: '2023-02-21T16:54:00.000Z'
                  createdBy:
                    id: 00u6eltha0nrSc47i0h7
                    type: User
                  lastUpdated: '2023-02-21T16:54:00.000Z'
                  issuer: '{yourOktaDomain}'
                  clientId: '{clientId}'
                  scopeId: okta.users.read
                  source: ADMIN
                  _embedded:
                    scope:
                      id: okta.users.read
                  _links:
                    app:
                      href: https://{yourOktaDomain}/api/v1/apps/{appId}
                      title: Application name
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6
                      hints:
                        allow:
                          - GET
                          - DELETE
                    client:
                      href: https://{yourOktaDomain}/oauth2/v1/clients/{clientId}
                      title: Client name
                - id: oaghm3sh9ukdkvDmO0h6
                  status: ACTIVE
                  created: '2023-02-03T21:57:49.000Z'
                  createdBy:
                    id: 00u6eltha0nrSc47i0h7
                    type: User
                  lastUpdated: '2023-02-03T21:57:49.000Z'
                  issuer: '{yourOktaDomain}'
                  clientId: '{clientId}'
                  scopeId: okta.apps.manage
                  source: ADMIN
                  _embedded:
                    scope:
                      id: okta.apps.manage
                  _links:
                    app:
                      href: https://{yourOktaDomain}/api/v1/apps/{appId}
                      title: Application name
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oaghm3sh9ukdkvDmO0h6
                      hints:
                        allow:
                          - GET
                          - DELETE
                    client:
                      href: https://{yourOktaDomain}/oauth2/v1/clients/{clientId}
                      title: Client name
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Application Grants
      summary: Grant consent to scope
      description: Grants consent for the app to request an OAuth 2.0 Okta scope
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                issuer: '{yourOktaDomain}'
                scopeId: okta.users.read
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: oag91n9ruw3dsaXzP0h6
                status: ACTIVE
                created: '2023-02-21T16:54:00.000Z'
                createdBy:
                  id: 00u6eltha0nrSc47i0h7
                  type: User
                lastUpdated: '2023-02-21T16:54:00.000Z'
                issuer: '{yourOktaDomain}'
                clientId: '{clientId}'
                scopeId: okta.users.read
                source: ADMIN
                _embedded:
                  scope:
                    id: okta.users.read
                _links:
                  app:
                    href: https://{yourOktaDomain}/api/v1/apps/{appId}
                    title: Application name
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6
                    hints:
                      allow:
                        - GET
                        - DELETE
                  client:
                    href: https://{yourOktaDomain}/oauth2/v1/clients/{clientId}
                    title: Client name
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/grants/{grantId}:
    get:
      tags:
        - Application Grants
      summary: Retrieve an app Grant
      description: Retrieves a single scope consent Grant object for the app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            An optional parameter to include scope details in the `_embedded`
            attribute. Valid value: `scope`
          example: scope
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: grantId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Grant ID
          example: iJoqkwx50mrgX4T9LcaH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: oag91n9ruw3dsaXzP0h6
                status: ACTIVE
                created: '2023-02-21T16:54:00.000Z'
                createdBy:
                  id: 00u6eltha0nrSc47i0h7
                  type: User
                lastUpdated: '2023-02-21T16:54:00.000Z'
                issuer: '{yourOktaDomain}'
                clientId: '{clientId}'
                scopeId: okta.users.read
                source: ADMIN
                _embedded:
                  scope:
                    id: okta.users.read
                _links:
                  app:
                    href: https://{yourOktaDomain}/api/v1/apps/{appId}
                    title: Application name
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6
                    hints:
                      allow:
                        - GET
                        - DELETE
                  client:
                    href: https://{yourOktaDomain}/oauth2/v1/clients/{clientId}
                    title: Client name
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Grants
      summary: Revoke an app Grant
      description: Revokes permission for the app to grant the given scope
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: grantId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Grant ID
          example: iJoqkwx50mrgX4T9LcaH
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/groups:
    get:
      tags:
        - Application Groups
      summary: List all Assigned Groups
      description: Lists all group assignments for an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of assignments
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          description: Specifies the number of results for a page
          example: '-1'
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: amet ut aliquip
                  lastUpdated: '1991-11-16T03:45:35.634Z'
                  priority: -81269230
                  profile:
                    amet_e:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    cillum_0:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    incididunt_90c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    anim6:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - id: aute et consequat
                  lastUpdated: '1981-07-16T11:29:12.917Z'
                  priority: -3433864
                  profile:
                    culpa_030:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    qui_51:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    Excepteur_d2:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    anim1b:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    Lorem_4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    adb:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/groups/{groupId}:
    get:
      tags:
        - Application Groups
      summary: Retrieve an Assigned Group
      description: Retrieves an application group assignment
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: amet culpa aliqua in
                lastUpdated: '1966-11-29T12:18:21.501Z'
                priority: -39525059
                profile:
                  minim_9: {}
                  et_a3: {}
                _embedded:
                  nostrud_ae8: {}
                  in__48: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Application Groups
      summary: Assign a Group
      description: Assigns a group to an application
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                priority: -28839326
                profile:
                  in_5: {}
                  cillumfce: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: amet culpa aliqua in
                lastUpdated: '1966-11-29T12:18:21.501Z'
                priority: -39525059
                profile:
                  minim_9: {}
                  et_a3: {}
                _embedded:
                  nostrud_ae8: {}
                  in__48: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Groups
      summary: Unassign a Group
      description: Unassigns a group from an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/logo:
    post:
      tags:
        - Application Logos
      summary: Upload an application Logo
      description: >
        Uploads a logo for the app instance.

        If the app already has a logo, this operation replaces the previous
        logo.


        The logo is visible in the Admin Console as an icon for your app
        instance.

        If you have one `appLink` object configured, this logo also appears in
        the End-User Dashboard as an icon for your app.

        > **Note:** If you have multiple `appLink` objects, use the Admin
        Console to add logos for each app link.

        > You can't use the API to add logos for multiple app links.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: >
                    (Required) The image file containing the logo.


                    The file must be in PNG, JPG, SVG, or GIF format, and less
                    than one MB in size.

                    For best results, use an image with a transparent background
                    and a square dimension of 200 x 200 pixels to prevent
                    upscaling.
                  format: binary
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/first-party-app-settings/{appName}:
    get:
      tags:
        - Okta Application Settings
      summary: Retrieve the Okta app settings
      description: Retrieves the settings for the first party Okta app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: (Required) `appName` of the application
          example: admin-console
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                sessionMaxLifetimeMinutes: 720
                sessionIdleTimeoutMinutes: 15
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Okta Application Settings
      summary: Replace the Okta app settings
      description: Replaces the settings for the first party Okta app
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                sessionMaxLifetimeMinutes: 720
                sessionIdleTimeoutMinutes: 15
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: (Required) `appName` of the application
          example: admin-console
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                sessionMaxLifetimeMinutes: 720
                sessionIdleTimeoutMinutes: 15
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/policies/{policyId}:
    put:
      tags:
        - Application Policies
      summary: Assign an application to a Policy
      description: >-
        Assigns an application to an [authentication
        policy](/openapi/okta-management/management/tag/Policy/), identified by
        `policyId`.

        If the application was previously assigned to another policy, this
        operation replaces that assignment with the updated policy identified by
        `policyId`.


        > **Note:** When you [merge duplicate authentication
        policies](https://help.okta.com/okta_help.htm?type=oie&id=ext-merge-auth-policies),

        the policy and mapping CRUD operations may be unavailable during the
        consolidation. When the consolidation is complete, you receive an email.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/sso/saml/metadata:
    get:
      tags:
        - Application SSO
      summary: Preview the application SAML metadata
      description: Previews the SSO SAML metadata for an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: text/xml
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/xml
          content:
            text/plain:
              schema:
                type: string
              example: >-
                <element><?xml version="1.0" encoding="UTF-8"?>
                  <md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="exk39sivhuytV2D8H0h7">
                    <md:IDPSSODescriptor WantAuthnRequestsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
                        <md:KeyDescriptor use="signing">
                            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                                <ds:X509Data>
                                    <ds:X509Certificate>MIIDqDCCApCgAwIBAgIGAVGNO4qeMA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEG
                A1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU

                MBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJ

                ARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODUwMDhaFw0xNzEyMTAxODUxMDdaMIGUMQswCQYD

                VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsG

                A1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEc

                MBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC

                ggEBALAakG48bgcTWHdwmVLHig0mkiRejxIVm3wbzrNSJcBruTq2zCYZ1rGfVxTYON8kJqvkXPmv

                kzWKhpEkvhubL+mx29XpXY0AsNIfgcm5xIV56yhXSvlMdqzGo3ciRwoACaF+ClNLxmXK9UTZD89B

                bVVGCG5AEvja0eCQ0GYsO5i9aSI5aTroab8Aew31PuWl/RGQWmjVy8+7P4wwkKKJNKCpxMYDlhfa

                WRp0zwUSbUCO0qEyeAYdZx6CLES4FGrDi/7D6G+ewWC+kbz1tL1XpF2Dcg3+IOlHrV6VWzz3rG39

                v9zFIncjvoQJFDGWhpqGqcmXvgH0Ze3SVcVF01T+bK0CAwEAATANBgkqhkiG9w0BAQUFAAOCAQEA

                AHmnSZ4imjNrIf9wxfQIcqHXEBoJ+oJtd59cw1Ur/YQY9pKXxoglqCQ54ZmlIf4GghlcZhslLO+m

                NdkQVwSmWMh6KLxVM18/xAkq8zyKbMbvQnTjFB7x45bgokwbjhivWqrB5LYHHCVN7k/8mKlS4eCK

                Ci6RGEmErjojr4QN2xV0qAqP6CcGANgpepsQJCzlWucMFKAh0x9Kl8fmiQodfyLXyrebYsVnLrMf

                jxE1b6dg4jKvv975tf5wreQSYZ7m//g3/+NnuDKkN/03HqhV7hTNi1fyctXk8I5Nwgyr+pT5LT2k

                YoEdncuy+GQGzE9yLOhC4HNfHQXpqp2tMPdRlw==</ds:X509Certificate>
                                </ds:X509Data>
                            </ds:KeyInfo>
                        </md:KeyDescriptor>
                        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>
                        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
                        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://{yourOktaDomain}/app/sample-app/exk39sivhuytV2D8H0h7/sso/saml"/>
                        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://{yourOktaDomain}/app/sample-app/exk39sivhuytV2D8H0h7/sso/saml"/>
                    </md:IDPSSODescriptor>
                </md:EntityDescriptor>

                </element>
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/tokens:
    get:
      tags:
        - Application Tokens
      summary: List all application refresh Tokens
      description: >
        Lists all refresh tokens for an app


        > **Note:** The results are [paginated](/#pagination) according to the
        `limit` parameter.

        > If there are multiple pages of results, the Link header contains a
        `next` link that you need to use as an opaque value (follow it, don't
        parse it).
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            An optional parameter to include scope details in the `_embedded`
            attribute. Valid value: `scope`
          example: scope
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It's an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: proident occaecat ut
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: oar579Mcp7OUsNTlo0g3
                  status: ACTIVE
                  created: '2023-03-09T03:18:06.000Z'
                  lastUpdated: '2023-03-09T03:18:06.000Z'
                  expiresAt: '2023-03-16T03:18:06.000Z'
                  issuer: https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7
                  clientId: 0oabskvc6442nkvQO0h7
                  userId: 00u5t60iloOHN9pBi0h7
                  scopes:
                    - offline_access
                    - car:drive
                  _embedded:
                    scopes:
                      - id: scppb56cIl4GvGxy70g3
                        name: offline_access
                        description: >-
                          Requests a refresh token by default and is used to
                          obtain more access tokens without re-prompting the
                          user for authentication
                        _links:
                          scope:
                            href: >-
                              https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3
                            title: offline_access
                      - id: scp142iq2J8IGRUCS0g4
                        name: car:drive
                        displayName: Drive car
                        description: Allows the user to drive a car
                        _links:
                          scope:
                            href: >-
                              https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4
                            title: Drive car
                  _links:
                    app:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7
                      title: Native
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3
                    revoke:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3
                      hints:
                        allow:
                          - DELETE
                    client:
                      href: >-
                        https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7
                      title: Example Client App
                    user:
                      href: >-
                        https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3
                      title: Saml Jackson
                    authorizationServer:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7
                      title: Example Authorization Server
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Tokens
      summary: Revoke all application Tokens
      description: >-
        Revokes all OAuth 2.0 refresh tokens for the specified app. Any access
        tokens issued with these refresh tokens are also revoked, but access
        tokens issued without a refresh token aren't affected.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/tokens/{tokenId}:
    get:
      tags:
        - Application Tokens
      summary: Retrieve an application Token
      description: Retrieves a refresh token for the specified app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            An optional parameter to include scope details in the `_embedded`
            attribute. Valid value: `scope`
          example: scope
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: oar579Mcp7OUsNTlo0g3
                status: ACTIVE
                created: '2023-03-09T03:18:06.000Z'
                lastUpdated: '2023-03-09T03:18:06.000Z'
                expiresAt: '2023-03-16T03:18:06.000Z'
                issuer: https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7
                clientId: 0oabskvc6442nkvQO0h7
                userId: 00u5t60iloOHN9pBi0h7
                scopes:
                  - offline_access
                  - car:drive
                _embedded:
                  scopes:
                    - id: scppb56cIl4GvGxy70g3
                      name: offline_access
                      description: >-
                        Requests a refresh token by default and is used to
                        obtain more access tokens without re-prompting the user
                        for authentication
                      _links:
                        scope:
                          href: >-
                            https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3
                          title: offline_access
                    - id: scp142iq2J8IGRUCS0g4
                      name: car:drive
                      displayName: Drive car
                      description: Allows the user to drive a car
                      _links:
                        scope:
                          href: >-
                            https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4
                          title: Drive car
                _links:
                  app:
                    href: https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7
                    title: Native
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3
                  revoke:
                    href: >-
                      https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3
                    hints:
                      allow:
                        - DELETE
                  client:
                    href: >-
                      https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7
                    title: Example Client App
                  user:
                    href: https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3
                    title: Saml Jackson
                  authorizationServer:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7
                    title: Example Authorization Server
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Tokens
      summary: Revoke an application Token
      description: Revokes the specified token for the specified app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/users:
    get:
      tags:
        - Application Users
      summary: List all assigned Users
      description: Lists all assigned users for an app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: query_scope
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: specifies the pagination cursor for the next page of assignments
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          description: specifies the number of results for a page
          example: '-1'
        - name: filter
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scope: USER
                  status: ACTIVE
                  statusChanged: '2014-06-24T15:28:14.000Z'
                  _links:
                    app:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    user:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    password:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  externalId: 70c14cc17d3745e8a9f98d599a68329c
                  id: 00u11z6WHMYCGPCHCRFK
                  lastSync: '2014-06-24T15:27:59.000Z'
                  passwordChanged: '2014-06-24T15:27:59.000Z'
                  profile:
                    labore_7:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  syncState: SYNCHRONIZED
                  _embedded:
                    Ut355:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    magna89:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolor_c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scope: USER
                  status: ACTIVE
                  statusChanged: '2014-06-24T15:28:14.000Z'
                  _links:
                    app:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    user:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    password:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  externalId: 70c14cc17d3745e8a9f98d599a68329c
                  id: 00u11z6WHMYCGPCHCRFK
                  lastSync: '2014-06-24T15:27:59.000Z'
                  passwordChanged: '2014-06-24T15:27:59.000Z'
                  profile:
                    officiacc:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    Excepteurfd3:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  syncState: SYNCHRONIZED
                  _embedded:
                    dolore51:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    quis_c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Application Users
      summary: Assign a User
      description: >-
        Assigns a user to an app with credentials and an app-specific
        [profile](/openapi/okta-management/management/tag/Application/#tag/Application/operation/assignUserToApplication!c=200&path=profile&t=response).

        Profile mappings defined for the app are applied first before applying
        any profile properties that are specified in the request.


        > **Notes:**

        > * You need to specify the `id` and omit the `credentials` parameter in
        the request body only for

        `signOnMode` or authentication schemes (`credentials.scheme`) that don't
        require credentials.

        > * You can only specify profile properties that aren't defined by
        profile mappings when Universal Directory is enabled.

        > * If your SSO app requires a profile but doesn't have provisioning
        enabled, you need to add a profile to the request body.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                created: '2014-06-24T15:27:59.000Z'
                lastUpdated: '2014-06-24T15:28:14.000Z'
                scope: USER
                credentials:
                  password:
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  userName: testuser
                id: 00u11z6WHMYCGPCHCRFK
                profile:
                  esse7_: {}
                  magna_9c: {}
                  mollit_c: {}
                  magna_f: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2014-06-24T15:27:59.000Z'
                lastUpdated: '2014-06-24T15:28:14.000Z'
                scope: USER
                credentials:
                  password: {}
                  userName: testuser
                externalId: 70c14cc17d3745e8a9f98d599a68329c
                id: 00u11z6WHMYCGPCHCRFK
                lastSync: '2014-06-24T15:27:59.000Z'
                passwordChanged: '2014-06-24T15:27:59.000Z'
                profile:
                  eiusmod_d: {}
                  eiusmod_bc8: {}
                status: ACTIVE
                statusChanged: '2014-06-24T15:28:14.000Z'
                syncState: SYNCHRONIZED
                _embedded:
                  do_07b: {}
                _links:
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  user:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/apps/{appId}/users/{userId}:
    get:
      tags:
        - Application Users
      summary: Retrieve an assigned User
      description: Retrieves a specific user assignment for app by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2014-06-24T15:27:59.000Z'
                lastUpdated: '2014-06-24T15:28:14.000Z'
                scope: USER
                credentials:
                  password: {}
                  userName: testuser
                externalId: 70c14cc17d3745e8a9f98d599a68329c
                id: 00u11z6WHMYCGPCHCRFK
                lastSync: '2014-06-24T15:27:59.000Z'
                passwordChanged: '2014-06-24T15:27:59.000Z'
                profile:
                  eiusmod_d: {}
                  eiusmod_bc8: {}
                status: ACTIVE
                statusChanged: '2014-06-24T15:28:14.000Z'
                syncState: SYNCHRONIZED
                _embedded:
                  do_07b: {}
                _links:
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  user:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Application Users
      summary: Update an App Profile for an assigned User
      description: Updates a user's profile for an application
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                created: '2014-06-24T15:27:59.000Z'
                lastUpdated: '2014-06-24T15:28:14.000Z'
                scope: USER
                credentials:
                  password:
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  userName: testuser
                id: 00u11z6WHMYCGPCHCRFK
                profile:
                  esse7_: {}
                  magna_9c: {}
                  mollit_c: {}
                  magna_f: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2014-06-24T15:27:59.000Z'
                lastUpdated: '2014-06-24T15:28:14.000Z'
                scope: USER
                credentials:
                  password: {}
                  userName: testuser
                externalId: 70c14cc17d3745e8a9f98d599a68329c
                id: 00u11z6WHMYCGPCHCRFK
                lastSync: '2014-06-24T15:27:59.000Z'
                passwordChanged: '2014-06-24T15:27:59.000Z'
                profile:
                  eiusmod_d: {}
                  eiusmod_bc8: {}
                status: ACTIVE
                statusChanged: '2014-06-24T15:28:14.000Z'
                syncState: SYNCHRONIZED
                _embedded:
                  do_07b: {}
                _links:
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  user:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Application Users
      summary: Unassign an App User
      description: Unassigns a user from an application
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          example: 'false'
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /attack-protection/api/v1/user-lockout-settings:
    get:
      tags:
        - Attack Protection
      summary: Retrieve the User Lockout Settings
      description: Retrieves the User Lockout Settings for an org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - preventBruteForceLockoutFromUnknownDevices: false
                - preventBruteForceLockoutFromUnknownDevices: false
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Attack Protection
      summary: Replace the User Lockout Settings
      description: Replaces the User Lockout Settings for an org
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                preventBruteForceLockoutFromUnknownDevices: false
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                preventBruteForceLockoutFromUnknownDevices: false
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /.well-known/app-authenticator-configuration:
    get:
      tags:
        - Authenticators
      summary: Retrieve the Well-Known App Authenticator Configuration
      description: >-
        Retrieves the well-known app authenticator configuration, which includes
        an app authenticator's settings, supported methods and various other
        configuration details
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: oauthClientId
          in: query
          schema:
            type: string
          description: >-
            (Required) Filters app authenticator configurations by
            `oauthClientId`
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - appAuthenticatorEnrollEndpoint: do in cillum
                  authenticatorId: esse velit laborum
                  createdDate: '2013-06-20T02:30:16.942Z'
                  key: ipsum ex consequat eiusmod irure
                  lastUpdated: '1981-09-18T22:22:15.130Z'
                  name: dolore sit in
                  orgId: elit pariatur Excep
                  settings:
                    userVerification:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  supportedMethods:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  type: app
                - appAuthenticatorEnrollEndpoint: laboris id et dolore deserunt
                  authenticatorId: sunt
                  createdDate: '2023-09-12T21:55:41.406Z'
                  key: nisi cupidatat mollit sed
                  lastUpdated: '1978-12-04T19:17:37.601Z'
                  name: aute ad Excepteur
                  orgId: sed Excepteur
                  settings:
                    userVerification:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  supportedMethods:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  type: app
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000028
                errorSummary: The request is missing a required parameter.
                errorLink: E0000028
                errorId: sampleiCF-l7mr9XqM1NQ
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators:
    get:
      tags:
        - Authenticators
      summary: List all Authenticators
      description: Lists all authenticators
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata for the response
          example: methods,methods
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - value:
                    type: email
                    id: aut1nbsPHh7jNjjyP0g4
                    key: okta_email
                    status: ACTIVE
                    name: Email
                    created: '2020-07-26T21:05:23.000Z'
                    lastUpdated: '2020-07-28T21:45:52.000Z'
                    settings:
                      allowedFor: any
                      tokenLifetimeInMinutes: 5
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4
                        hints:
                          allow:
                            - GET
                            - PUT
                      methods:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/methods
                        hints:
                          allow:
                            - GET
                      deactivate:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/lifecycle/deactivate
                        hints:
                          allow:
                            - POST
                - value:
                    type: password
                    id: aut1nbtrJKKA9m45a0g4
                    key: okta_password
                    status: ACTIVE
                    name: Password
                    created: '2020-07-26T21:05:23.000Z'
                    lastUpdated: '2020-07-26T21:05:23.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4
                        hints:
                          allow:
                            - GET
                            - PUT
                      methods:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4/methods
                        hints:
                          allow:
                            - GET
                - value:
                    type: phone
                    id: aut1nbuyD8m1ckAYc0g4
                    key: phone_number
                    status: INACTIVE
                    name: Phone
                    created: '2020-07-26T21:05:23.000Z'
                    lastUpdated: '2020-07-29T00:21:29.000Z'
                    settings:
                      allowedFor: none
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4
                        hints:
                          allow:
                            - GET
                            - PUT
                      methods:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/methods
                        hints:
                          allow:
                            - GET
                      activate:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/lifecycle/activate
                        hints:
                          allow:
                            - POST
                - value:
                    type: security_key
                    id: aut1nd8PQhGcQtSxB0g4
                    key: webauthn
                    status: ACTIVE
                    name: Security Key or Biometric
                    created: '2020-07-26T21:16:37.000Z'
                    lastUpdated: '2020-07-27T18:59:30.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4
                        hints:
                          allow:
                            - GET
                            - PUT
                      methods:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods
                        hints:
                          allow:
                            - GET
                      deactivate:
                        href: >-
                          https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate
                        hints:
                          allow:
                            - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authenticators
      summary: Create an Authenticator
      description: Creates an authenticator
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                key: duo
                name: Duo Security
                provider:
                  type: DUO
                  configuration:
                    userNameTemplate:
                      template: oktaId
                    integrationKey: testIntegrationKey
                    secretKey: testSecretKey
                    host: https://api-xxxxxxxx.duosecurity.com
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: activate
          in: query
          schema:
            type: boolean
          description: >-
            Whether to execute the activation lifecycle operation when Okta
            creates the authenticator
          example: 'false'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: app
                id: aut9gnvcjUHIWb37J0g4
                key: duo
                status: ACTIVE
                name: Duo Security
                created: '2022-07-15T21:14:02.000Z'
                lastUpdated: '2022-07-15T21:14:02.000Z'
                settings: {}
                provider:
                  type: DUO
                  configuration:
                    host: https://api-xxxxxxxx.duosecurity.com
                    userNameTemplate:
                      template: oktaId
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                  methods:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods
                    hints:
                      allow:
                        - GET
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}:
    get:
      tags:
        - Authenticators
      summary: Retrieve an Authenticator
      description: >-
        Retrieves an authenticator from your Okta organization by
        `authenticatorId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata for the response
          example: authenticationPolicy,methods
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: app
                id: aut9gnvcjUHIWb37J0g4
                key: duo
                status: ACTIVE
                name: Duo Security
                created: '2022-07-15T21:14:02.000Z'
                lastUpdated: '2022-07-15T21:14:02.000Z'
                settings: {}
                provider:
                  type: DUO
                  configuration:
                    host: https://api-xxxxxxxx.duosecurity.com
                    userNameTemplate:
                      template: oktaId
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                  methods:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authenticators
      summary: Replace an Authenticator
      description: >-
        Replaces the properties for an Authenticator identified by
        `authenticatorId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                key: duo
                name: Duo Security
                provider:
                  type: DUO
                  configuration:
                    userNameTemplate:
                      template: oktaId
                    integrationKey: testIntegrationKey
                    secretKey: testSecretKey
                    host: https://api-xxxxxxxx.duosecurity.com
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: app
                id: aut9gnvcjUHIWb37J0g4
                key: duo
                status: ACTIVE
                name: Duo Security
                created: '2022-07-15T21:14:02.000Z'
                lastUpdated: '2022-07-15T21:14:02.000Z'
                settings: {}
                provider:
                  type: DUO
                  configuration:
                    host: https://api-xxxxxxxx.duosecurity.com
                    userNameTemplate:
                      template: oktaId
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                  methods:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods
                    hints:
                      allow:
                        - GET
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/lifecycle/activate:
    post:
      tags:
        - Authenticators
      summary: Activate an Authenticator
      description: Activates an authenticator by `authenticatorId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: app
                id: aut9gnvcjUHIWb37J0g4
                key: duo
                status: ACTIVE
                name: Duo Security
                created: '2022-07-15T21:14:02.000Z'
                lastUpdated: '2022-07-15T21:14:02.000Z'
                settings: {}
                provider:
                  type: DUO
                  configuration:
                    host: https://api-xxxxxxxx.duosecurity.com
                    userNameTemplate:
                      template: oktaId
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                  methods:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate:
    post:
      tags:
        - Authenticators
      summary: Deactivate an Authenticator
      description: Deactivates an authenticator by `authenticatorId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: app
                id: aut9gnvcjUHIWb37J0g4
                key: duo
                status: ACTIVE
                name: Duo Security
                created: '2022-07-15T21:14:02.000Z'
                lastUpdated: '2022-07-15T21:14:02.000Z'
                settings: {}
                provider:
                  type: DUO
                  configuration:
                    host: https://api-xxxxxxxx.duosecurity.com
                    userNameTemplate:
                      template: oktaId
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                  methods:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/methods:
    get:
      tags:
        - Authenticators
      summary: List all Methods of an Authenticator
      description: Lists all Methods of an Authenticator identified by `authenticatorId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - status: INACTIVE
                  type: webauthn
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - status: INACTIVE
                  type: security_question
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/methods/{methodType}:
    get:
      tags:
        - Authenticators
      summary: Retrieve a Method
      description: >-
        Retrieves a Method identified by `methodType` of an Authenticator
        identified by `authenticatorId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
        - name: methodType
          in: path
          schema:
            type: string
          required: true
          description: (Required) Type of the authenticator method
          example: duo
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: ACTIVE
                type: idp
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authenticators
      summary: Replace a Method
      description: >-
        Replaces a Method of `methodType` for an Authenticator identified by
        `authenticatorId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                status: ACTIVE
                type: idp
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
        - name: methodType
          in: path
          schema:
            type: string
          required: true
          description: (Required) Type of the authenticator method
          example: duo
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: ACTIVE
                type: idp
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate:
    post:
      tags:
        - Authenticators
      summary: Activate an Authenticator Method
      description: >-
        Activates a Method for an Authenticator identified by `authenticatorId`
        and `methodType`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
        - name: methodType
          in: path
          schema:
            type: string
          required: true
          description: (Required) Type of the authenticator method
          example: duo
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: ACTIVE
                type: idp
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate:
    post:
      tags:
        - Authenticators
      summary: Deactivate an Authenticator Method
      description: >-
        Deactivates a Method for an Authenticator identified by
        `authenticatorId` and `methodType`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authenticatorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authenticator
          example: aut1nd8PQhGcQtSxB0g4
        - name: methodType
          in: path
          schema:
            type: string
          required: true
          description: (Required) Type of the authenticator method
          example: duo
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: ACTIVE
                type: idp
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers:
    get:
      tags:
        - Authorization Servers
      summary: List all Authorization Servers
      description: Lists all custom authorization servers in the org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Searches the `name` and `audiences` of authorization servers for
            matching values
          example: customasone
        - name: limit
          in: query
          schema:
            type: integer
          description: >-
            Specifies the number of authorization server results on a page.
            Maximum value: 200
          example: '200'
        - name: after
          in: query
          schema:
            type: string
          description: >-
            Specifies the pagination cursor for the next page of authorization
            servers. Treat as an opaque value and obtain through the next link
            relationship.
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{authorizationServerId}'
                  name: Sample Authorization Server
                  description: Sample Authorization Server description
                  audiences:
                    - https://api.resource.com
                  issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                  issuerMode: ORG_URL
                  status: ACTIVE
                  created: '2023-05-17T22:25:57.000Z'
                  lastUpdated: '2023-05-17T22:25:57.000Z'
                  credentials:
                    signing:
                      rotationMode: AUTO
                      lastRotated: '2023-05-17T22:25:57.000Z'
                      nextRotation: '2023-08-15T22:25:57.000Z'
                      kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                  _links:
                    scopes:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes
                      hints:
                        allow:
                          - GET
                    claims:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims
                      hints:
                        allow:
                          - GET
                    policies:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies
                      hints:
                        allow:
                          - GET
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                      hints:
                        allow:
                          - GET
                          - DELETE
                          - PUT
                    metadata:
                      - name: oauth-authorization-server
                        href: >-
                          https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server
                        hints:
                          allow:
                            - GET
                      - name: openid-configuration
                        href: >-
                          https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration
                        hints:
                          allow:
                            - GET
                    rotateKey:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate
                      hints:
                        allow:
                          - POST
                    deactivate:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate
                      hints:
                        allow:
                          - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Servers
      summary: Create an Authorization Server
      description: Creates an authorization server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Sample Authorization Server
                description: Sample Authorization Server description
                audiences:
                  - api://default
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: '{authorizationServerId}'
                name: Sample Authorization Server
                description: Sample Authorization Server description
                audiences:
                  - https://api.resource.com
                issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                issuerMode: ORG_URL
                status: ACTIVE
                created: '2023-05-17T22:25:57.000Z'
                lastUpdated: '2023-05-17T22:25:57.000Z'
                credentials:
                  signing:
                    rotationMode: AUTO
                    lastRotated: '2023-05-17T22:25:57.000Z'
                    nextRotation: '2023-08-15T22:25:57.000Z'
                    kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                _links:
                  scopes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes
                    hints:
                      allow:
                        - GET
                  claims:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims
                    hints:
                      allow:
                        - GET
                  policies:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies
                    hints:
                      allow:
                        - GET
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                    hints:
                      allow:
                        - GET
                        - DELETE
                        - PUT
                  metadata:
                    - name: oauth-authorization-server
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server
                      hints:
                        allow:
                          - GET
                    - name: openid-configuration
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration
                      hints:
                        allow:
                          - GET
                  rotateKey:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}:
    get:
      tags:
        - Authorization Servers
      summary: Retrieve an Authorization Server
      description: Retrieves an authorization server
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: '{authorizationServerId}'
                name: Sample Authorization Server
                description: Sample Authorization Server description
                audiences:
                  - https://api.resource.com
                issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                issuerMode: ORG_URL
                status: ACTIVE
                created: '2023-05-17T22:25:57.000Z'
                lastUpdated: '2023-05-17T22:25:57.000Z'
                credentials:
                  signing:
                    rotationMode: AUTO
                    lastRotated: '2023-05-17T22:25:57.000Z'
                    nextRotation: '2023-08-15T22:25:57.000Z'
                    kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                _links:
                  scopes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes
                    hints:
                      allow:
                        - GET
                  claims:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims
                    hints:
                      allow:
                        - GET
                  policies:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies
                    hints:
                      allow:
                        - GET
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                    hints:
                      allow:
                        - GET
                        - DELETE
                        - PUT
                  metadata:
                    - name: oauth-authorization-server
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server
                      hints:
                        allow:
                          - GET
                    - name: openid-configuration
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration
                      hints:
                        allow:
                          - GET
                  rotateKey:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authorization Servers
      summary: Replace an Authorization Server
      description: Replaces an authorization server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: New Authorization Server
                description: Authorization Server description
                audiences:
                  - api://default
                credentials:
                  signing:
                    rotationMode: AUTO
                    use: sig
                issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                issuerMode: ORG_URL
                status: ACTIVE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: '{authorizationServerId}'
                name: Sample Authorization Server
                description: Sample Authorization Server description
                audiences:
                  - https://api.resource.com
                issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                issuerMode: ORG_URL
                status: ACTIVE
                created: '2023-05-17T22:25:57.000Z'
                lastUpdated: '2023-05-17T22:25:57.000Z'
                credentials:
                  signing:
                    rotationMode: AUTO
                    lastRotated: '2023-05-17T22:25:57.000Z'
                    nextRotation: '2023-08-15T22:25:57.000Z'
                    kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                _links:
                  scopes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes
                    hints:
                      allow:
                        - GET
                  claims:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims
                    hints:
                      allow:
                        - GET
                  policies:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies
                    hints:
                      allow:
                        - GET
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                    hints:
                      allow:
                        - GET
                        - DELETE
                        - PUT
                  metadata:
                    - name: oauth-authorization-server
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server
                      hints:
                        allow:
                          - GET
                    - name: openid-configuration
                      href: >-
                        https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration
                      hints:
                        allow:
                          - GET
                  rotateKey:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Delete an Authorization Server
      description: Deletes an authorization server
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/clients:
    get:
      tags:
        - Authorization Servers
      summary: List all Clients
      description: Lists all clients
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - client_id: ipsum sit
                  client_name: aliquip esse tempor
                  client_uri: et null
                  logo_uri: proi
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - client_id: laboris Lorem non eu
                  client_name: est esse ut sint
                  client_uri: Lorem non ea sunt
                  logo_uri: ut dolore sit
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens:
    get:
      tags:
        - Authorization Servers
      summary: List all Refresh Tokens for a Client
      description: Lists all refresh tokens for a client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          example: '-1'
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - clientId: et ut pariatur sit
                  created: '1995-03-14T01:40:39.748Z'
                  expiresAt: '1985-09-18T11:02:42.561Z'
                  id: i
                  issuer: enim
                  lastUpdated: '1974-03-08T03:46:05.805Z'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  userId: esse elit reprehenderit id
                  _embedded:
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - clientId: irure aute consequat incididunt officia
                  created: '1990-04-25T00:36:48.526Z'
                  expiresAt: '1972-07-25T03:24:42.073Z'
                  id: culpa Duis proident
                  issuer: eu aute
                  lastUpdated: '1953-11-18T15:38:02.665Z'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  userId: dolore irure
                  _embedded:
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Revoke all Refresh Tokens for a Client
      description: Revokes all refresh tokens for a client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}:
    get:
      tags:
        - Authorization Servers
      summary: Retrieve a Refresh Token for a Client
      description: Retrieves a refresh token for a client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                clientId: et
                created: '1990-03-29T20:52:35.637Z'
                expiresAt: '1982-04-26T07:50:45.360Z'
                id: amet minim
                issuer: ut Duis enim
                lastUpdated: '1950-02-01T12:19:57.446Z'
                scopes:
                  - eiusmod
                  - sint ex culpa magna
                status: ACTIVE
                userId: incididunt mollit sunt nostrud ullamco
                _embedded:
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  revoke:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  client:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  user:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authorizationServer:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Revoke a Refresh Token for a Client
      description: Revokes a refresh token for a client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/credentials/keys:
    get:
      tags:
        - Authorization Servers
      summary: List all Credential Keys
      description: Lists all credential keys
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - alg: veniam anim proident in
                  created: '1987-05-28T09:19:57.006Z'
                  e: sunt Excepteur commodo et
                  expiresAt: '1966-09-22T19:48:59.232Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: consectetur ut culpa
                  kty: elit pariatur ipsum
                  lastUpdated: '2012-11-14T11:23:59.664Z'
                  'n': Lorem
                  status: eu amet ut ut
                  use: sunt esse minim ad
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: in Ut
                  x5t#S256: irure exercitation
                  x5u: sunt dolore fugiat cupidatat
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - alg: culpa elit aliquip
                  created: '2009-07-25T19:02:30.973Z'
                  e: aute laboris mollit
                  expiresAt: '1992-08-06T04:23:52.783Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: dolor proident
                  kty: enim exercitation dolore commodo
                  lastUpdated: '2003-02-11T03:15:07.846Z'
                  'n': dolore ut
                  status: labore eu
                  use: ullamco magna minim ea
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: nulla ullam
                  x5t#S256: enim dolore est
                  x5u: id in dolor ut aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate:
    post:
      tags:
        - Authorization Servers
      summary: Rotate all Credential Keys
      description: Rotates all credential keys
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                use: sig
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - alg: veniam anim proident in
                  created: '1987-05-28T09:19:57.006Z'
                  e: sunt Excepteur commodo et
                  expiresAt: '1966-09-22T19:48:59.232Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: consectetur ut culpa
                  kty: elit pariatur ipsum
                  lastUpdated: '2012-11-14T11:23:59.664Z'
                  'n': Lorem
                  status: eu amet ut ut
                  use: sunt esse minim ad
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: in Ut
                  x5t#S256: irure exercitation
                  x5u: sunt dolore fugiat cupidatat
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - alg: culpa elit aliquip
                  created: '2009-07-25T19:02:30.973Z'
                  e: aute laboris mollit
                  expiresAt: '1992-08-06T04:23:52.783Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: dolor proident
                  kty: enim exercitation dolore commodo
                  lastUpdated: '2003-02-11T03:15:07.846Z'
                  'n': dolore ut
                  status: labore eu
                  use: ullamco magna minim ea
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: nulla ullam
                  x5t#S256: enim dolore est
                  x5u: id in dolor ut aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/lifecycle/activate:
    post:
      tags:
        - Authorization Servers
      summary: Activate an Authorization Server
      description: Activates an authorization server
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate:
    post:
      tags:
        - Authorization Servers
      summary: Deactivate an Authorization Server
      description: Deactivates an authorization server
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies:
    get:
      tags:
        - Authorization Servers
      summary: List all Policies
      description: Lists all policies
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Servers
      summary: Create a Policy
      description: Creates a policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: quis consectetur ullamco Duis
                name: nostrud magna sunt
                priority: 66483757
                status: INACTIVE
                system: true
                type: PASSWORD
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-09-20T00:10:45.740Z'
                description: reprehenderit
                id: deserunt id voluptate officia reprehen
                lastUpdated: '1961-03-15T23:21:38.694Z'
                name: dolore pariatur aliqua
                priority: 42576189
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  fugiat_762:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  laboris_70:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consecteturf:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consequat_d3:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  irured:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}:
    get:
      tags:
        - Authorization Servers
      summary: Retrieve a Policy
      description: Retrieves a policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-09-20T00:10:45.740Z'
                description: reprehenderit
                id: deserunt id voluptate officia reprehen
                lastUpdated: '1961-03-15T23:21:38.694Z'
                name: dolore pariatur aliqua
                priority: 42576189
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  fugiat_762:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  laboris_70:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consecteturf:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consequat_d3:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  irured:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authorization Servers
      summary: Replace a Policy
      description: Replaces a policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: quis consectetur ullamco Duis
                name: nostrud magna sunt
                priority: 66483757
                status: INACTIVE
                system: true
                type: PASSWORD
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-09-20T00:10:45.740Z'
                description: reprehenderit
                id: deserunt id voluptate officia reprehen
                lastUpdated: '1961-03-15T23:21:38.694Z'
                name: dolore pariatur aliqua
                priority: 42576189
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  fugiat_762:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  laboris_70:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consecteturf:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  consequat_d3:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  irured:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Delete a Policy
      description: Deletes a policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate:
    post:
      tags:
        - Authorization Servers
      summary: Activate a Policy
      description: Activates an authorization server policy
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate:
    post:
      tags:
        - Authorization Servers
      summary: Deactivate a Policy
      description: Deactivates an authorization server policy
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules:
    get:
      tags:
        - Authorization Servers
      summary: List all Policy Rules
      description: >-
        Lists all policy rules for the specified Custom Authorization Server and
        Policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  actions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  actions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Servers
      summary: Create a Policy Rule
      description: >-
        Creates a policy rule for the specified Custom Authorization Server and
        Policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: minim nulla ut dolor elit
                name: veniam dolore
                priority: 51826059
                status: INACTIVE
                system: false
                type: SIGN_ON
                actions:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  grantTypes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2023-01-05T20:35:34.104Z'
                id: sit ut
                lastUpdated: '2015-01-27T11:25:08.147Z'
                name: adipisicing non
                priority: 34806610
                status: INACTIVE
                system: false
                type: SIGN_ON
                actions:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  grantTypes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}:
    get:
      tags:
        - Authorization Servers
      summary: Retrieve a Policy Rule
      description: Retrieves a policy rule by `ruleId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2023-01-05T20:35:34.104Z'
                id: sit ut
                lastUpdated: '2015-01-27T11:25:08.147Z'
                name: adipisicing non
                priority: 34806610
                status: INACTIVE
                system: false
                type: SIGN_ON
                actions:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  grantTypes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authorization Servers
      summary: Replace a Policy Rule
      description: >-
        Replaces the configuration of the Policy Rule defined in the specified
        Custom Authorization Server and Policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: minim nulla ut dolor elit
                name: veniam dolore
                priority: 51826059
                status: INACTIVE
                system: false
                type: SIGN_ON
                actions:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  grantTypes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2023-01-05T20:35:34.104Z'
                id: sit ut
                lastUpdated: '2015-01-27T11:25:08.147Z'
                name: adipisicing non
                priority: 34806610
                status: INACTIVE
                system: false
                type: SIGN_ON
                actions:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  clients:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  grantTypes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Delete a Policy Rule
      description: >-
        Deletes a Policy Rule defined in the specified Custom Authorization
        Server and Policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate:
    post:
      tags:
        - Authorization Servers
      summary: Activate a Policy Rule
      description: Activates an authorization server policy rule
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate:
    post:
      tags:
        - Authorization Servers
      summary: Deactivate a Policy Rule
      description: Deactivates an authorization server policy rule
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/scopes:
    get:
      tags:
        - Authorization Servers
      summary: List all Custom Token Scopes
      description: Lists all custom token scopes
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: filter
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: cursor
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          example: '-1'
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - consent: IMPLICIT
                  default: false
                  description: in veniam nostrud ipsum
                  displayName: anim dolore
                  id: 'magna et sed '
                  metadataPublish: NO_CLIENTS
                  name: nisi elit sunt adipisicing
                  optional: true
                  system: false
                - consent: IMPLICIT
                  default: true
                  description: laborum commodo cupidatat
                  displayName: mollit laborum
                  id: elit aliquip
                  metadataPublish: NO_CLIENTS
                  name: aute ea irure
                  optional: false
                  system: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Servers
      summary: Create a Custom Token Scope
      description: Creates a custom token scope
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                consent: IMPLICIT
                default: false
                description: velit sint sit
                displayName: id esse ipsum
                metadataPublish: NO_CLIENTS
                name: mollit nostrud cillum proident laborum
                optional: false
                system: false
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                consent: IMPLICIT
                default: true
                description: enim cupidatat
                displayName: dolore in elit sint
                id: aliqua labor
                metadataPublish: NO_CLIENTS
                name: sunt elit do fugiat
                optional: false
                system: false
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}:
    get:
      tags:
        - Authorization Servers
      summary: Retrieve a Custom Token Scope
      description: Retrieves a custom token scope
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: scopeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Scope
          example: 0TMRpCWXRKFjP7HiPFNM
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                consent: IMPLICIT
                default: true
                description: enim cupidatat
                displayName: dolore in elit sint
                id: aliqua labor
                metadataPublish: NO_CLIENTS
                name: sunt elit do fugiat
                optional: false
                system: false
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authorization Servers
      summary: Replace a Custom Token Scope
      description: Replaces a custom token scope
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                consent: IMPLICIT
                default: false
                description: velit sint sit
                displayName: id esse ipsum
                metadataPublish: NO_CLIENTS
                name: mollit nostrud cillum proident laborum
                optional: false
                system: false
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: scopeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Scope
          example: 0TMRpCWXRKFjP7HiPFNM
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                consent: IMPLICIT
                default: true
                description: enim cupidatat
                displayName: dolore in elit sint
                id: aliqua labor
                metadataPublish: NO_CLIENTS
                name: sunt elit do fugiat
                optional: false
                system: false
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Servers
      summary: Delete a Custom Token Scope
      description: Deletes a custom token scope
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: scopeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Scope
          example: 0TMRpCWXRKFjP7HiPFNM
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/associatedServers:
    get:
      tags:
        - Authorization Server Associated Servers
      summary: List all associated Authorization Servers
      description: >-
        Lists all associated Authorization Servers by trusted type for the given
        `authServerId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trusted
          in: query
          schema:
            type: boolean
          description: >-
            Searches trusted authorization servers when `true` or searches
            untrusted authorization servers when `false`
          example: 'true'
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Searches for the name or audience of the associated authorization
            servers
          example: customasone
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of results for a page
          example: '200'
        - name: after
          in: query
          schema:
            type: string
          description: >-
            Specifies the pagination cursor for the next page of the associated
            authorization servers
          example: mollit occaecat cupidatat
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{authorizationServerId}'
                  name: Sample Authorization Server
                  description: Sample Authorization Server description
                  audiences:
                    - https://api.resource.com
                  issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                  issuerMode: CUSTOM_URL
                  status: ACTIVE
                  created: '2023-05-17T22:25:57.000Z'
                  lastUpdated: '2023-05-17T22:25:57.000Z'
                  credentials:
                    signing:
                      rotationMode: DYNAMIC
                      lastRotated: '2023-05-17T22:25:57.000Z'
                      nextRotation: '2023-08-15T22:25:57.000Z'
                      kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                      use: sig
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                      hints:
                        allow:
                          - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Server Associated Servers
      summary: Create an associated Authorization Server
      description: >-
        Creates trusted relationships between the given authorization server and
        other authorization servers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - trusted: '{authorizationServerId}'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{authorizationServerId}'
                  name: Sample Authorization Server
                  description: Sample Authorization Server description
                  audiences:
                    - https://api.resource.com
                  issuer: https://{yourOktaDomain}/oauth2/{authorizationServerId}
                  issuerMode: CUSTOM_URL
                  status: ACTIVE
                  created: '2023-05-17T22:25:57.000Z'
                  lastUpdated: '2023-05-17T22:25:57.000Z'
                  credentials:
                    signing:
                      rotationMode: AUTO
                      lastRotated: '2023-05-17T22:25:57.000Z'
                      nextRotation: '2023-08-15T22:25:57.000Z'
                      kid: WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4
                      use: sig
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}
                      hints:
                        allow:
                          - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}:
    delete:
      tags:
        - Authorization Server Associated Servers
      summary: Delete an associated Authorization Server
      description: Deletes an associated Authorization Server
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: associatedServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the associated Authorization Server
          example: aus6xt9jKPmCyn6kg0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/claims:
    get:
      tags:
        - Authorization Server Claims
      summary: List all custom token Claims
      description: >-
        Lists all custom token Claims defined for a specified custom
        authorization server
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{claimId}'
                  name: sub
                  status: ACTIVE
                  claimType: RESOURCE
                  valueType: EXPRESSION
                  value: '(appuser != null) ? appuser.userName : app.clientId'
                  conditions:
                    scopes:
                      - profile
                  system: true
                  alwaysIncludeInToken: true
                  apiResourceId: null
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Authorization Server Claims
      summary: Create a custom token Claim
      description: Creates a custom token Claim for a custom authorization server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - alwaysIncludeInToken: true
                  claimType: IDENTITY
                  conditions:
                    scopes:
                      - profile
                  group_filter_type: CONTAINS
                  name: Support
                  status: ACTIVE
                  system: false
                  value: Support
                  valueType: GROUPS
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{claimId}'
                  name: Support
                  status: ACTIVE
                  claimType: IDENTITY
                  valueType: GROUPS
                  value: Support
                  conditions:
                    scopes:
                      - profile
                  system: false
                  alwaysIncludeInToken: true
                  apiResourceId: null
                  group_filter_type: CONTAINS
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/authorizationServers/{authServerId}/claims/{claimId}:
    get:
      tags:
        - Authorization Server Claims
      summary: Retrieve a custom token Claim
      description: Retrieves a custom token Claim by the specified `claimId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: claimId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Claim
          example: hNJ3Uk76xLagWkGx5W3N
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{claimId}'
                  name: Support
                  status: ACTIVE
                  claimType: IDENTITY
                  valueType: GROUPS
                  value: Support
                  conditions:
                    scopes:
                      - profile
                  system: false
                  alwaysIncludeInToken: true
                  apiResourceId: null
                  group_filter_type: CONTAINS
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Authorization Server Claims
      summary: Replace a custom token Claim
      description: Replaces a custom token Claim specified by the `claimId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - alwaysIncludeInToken: true
                  claimType: IDENTITY
                  conditions:
                    scopes:
                      - profile
                  group_filter_type: CONTAINS
                  name: Knowledge_Base
                  status: ACTIVE
                  system: false
                  value: Knowledge Base
                  valueType: GROUPS
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: claimId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Claim
          example: hNJ3Uk76xLagWkGx5W3N
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: '{claimId}'
                  name: Knowledge_Base
                  status: ACTIVE
                  claimType: IDENTITY
                  valueType: GROUPS
                  value: Knowledge Base
                  conditions:
                    scopes:
                      - profile
                  system: false
                  alwaysIncludeInToken: true
                  apiResourceId: null
                  group_filter_type: CONTAINS
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Authorization Server Claims
      summary: Delete a custom token Claim
      description: Deletes a custom token Claim specified by the `claimId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: authServerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Authorization Server
          example: GeGRTEr7f3yu2n7grw22
        - name: claimId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Claim
          example: hNJ3Uk76xLagWkGx5W3N
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/behaviors:
    get:
      tags:
        - Behavior Rules
      summary: List all Behavior Detection Rules
      description: Lists all behavior detection rules with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - name: aute
                  type: ANOMALOUS_LOCATION
                  created: '1953-06-14T21:13:52.851Z'
                  id: eiusmod ut dolor
                  lastUpdated: '2012-08-05T19:41:41.957Z'
                  status: ACTIVE
                  _link:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - name: nulla aliquip sint
                  type: ANOMALOUS_IP
                  created: '1995-09-07T11:37:02.146Z'
                  id: non ut amet ex
                  lastUpdated: '2016-04-02T02:58:15.747Z'
                  status: INACTIVE
                  _link:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Behavior Rules
      summary: Create a Behavior Detection Rule
      description: Creates a new behavior detection rule
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: My Behavior Rule
                type: VELOCITY
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: My Behavior Rule
                type: VELOCITY
                settings:
                  velocityKph: 805
                status: ACTIVE
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _link:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/behaviors/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/behaviors/{behaviorId}:
    get:
      tags:
        - Behavior Rules
      summary: Retrieve a Behavior Detection Rule
      description: Retrieves a Behavior Detection Rule by `behaviorId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: behaviorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Behavior Detection Rule
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: incididunt ut eiusmod do
                type: VELOCITY
                created: '1995-04-02T19:12:14.541Z'
                id: velit eu enim
                lastUpdated: '1972-05-31T14:17:27.531Z'
                status: INACTIVE
                _link:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Behavior Rules
      summary: Replace a Behavior Detection Rule
      description: Replaces a Behavior Detection Rule by `behaviorId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: My Behavior Rule
                type: VELOCITY
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: behaviorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Behavior Detection Rule
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: My Behavior Rule
                type: VELOCITY
                settings:
                  velocityKph: 805
                status: ACTIVE
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _link:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/behaviors/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Behavior Rules
      summary: Delete a Behavior Detection Rule
      description: Deletes a Behavior Detection Rule by `behaviorId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: behaviorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Behavior Detection Rule
          example: abcd1234
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/behaviors/{behaviorId}/lifecycle/activate:
    post:
      tags:
        - Behavior Rules
      summary: Activate a Behavior Detection Rule
      description: Activates a behavior detection rule
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: behaviorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Behavior Detection Rule
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: My Behavior Rule
                type: VELOCITY
                settings:
                  velocityKph: 805
                status: ACTIVE
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _link:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/behaviors/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/behaviors/{behaviorId}/lifecycle/deactivate:
    post:
      tags:
        - Behavior Rules
      summary: Deactivate a Behavior Detection Rule
      description: Deactivates a behavior detection rule
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: behaviorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Behavior Detection Rule
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: My Behavior Rule
                type: VELOCITY
                settings:
                  velocityKph: 805
                status: ACTIVE
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _link:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/behaviors/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/captchas:
    get:
      tags:
        - CAPTCHAs
      summary: List all CAPTCHA Instances
      description: >-
        Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA
        instances can be returned that match a supported filter expression or
        query.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: laboris sunt ex quis
                  name: dolor labore ad eiusmod
                  siteKey: adipisicing do in cupidatat
                  type: RECAPTCHA_V2
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - id: elit tempor
                  name: dolor nulla cillum
                  siteKey: eiusmod fugiat laboris ea oc
                  type: RECAPTCHA_V2
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - CAPTCHAs
      summary: Create a CAPTCHA instance
      description: >-
        Creates a new CAPTCHA instance. Currently, an org can only configure a
        single CAPTCHA instance.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: myHCaptcha
                secretKey: xxxxxxxxxxx
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: myHCaptcha
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/captchas/{captchaId}:
    get:
      tags:
        - CAPTCHAs
      summary: Retrieve a CAPTCHA Instance
      description: Retrieves the properties of a specified CAPTCHA instance
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: captchaId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique key used to identify your CAPTCHA instance
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: myHCaptcha
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - CAPTCHAs
      summary: Update a CAPTCHA Instance
      description: Partially updates the properties of a specified CAPTCHA instance
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: myHCaptcha
                secretKey: xxxxxxxxxxx
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: captchaId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique key used to identify your CAPTCHA instance
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: myHCaptcha
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - CAPTCHAs
      summary: Replace a CAPTCHA Instance
      description: Replaces the properties for a specified CAPTCHA instance
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: myHCaptcha
                secretKey: xxxxxxxxxxx
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: captchaId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique key used to identify your CAPTCHA instance
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                name: myHCaptcha
                siteKey: xxxxxxxxxxx
                type: HCAPTCHA
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd1234
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - CAPTCHAs
      summary: Delete a CAPTCHA Instance
      description: >-
        Deletes a specified CAPTCHA instance

        > **Note:** If your CAPTCHA instance is still associated with your org,
        the request fails. You must first update your Org-wide CAPTCHA settings
        to remove the CAPTCHA instance.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: captchaId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique key used to identify your CAPTCHA instance
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/captcha:
    get:
      tags:
        - CAPTCHAs
      summary: Retrieve the Org-wide CAPTCHA Settings
      description: >-
        Retrieves the CAPTCHA settings object for your organization.

        > **Note**: If the current organization hasn't configured CAPTCHA
        Settings, the request returns an empty object.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                captchaId: abcd4567
                enabledPages:
                  - SSR
                  - SIGN_IN
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd4567
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - CAPTCHAs
      summary: Replace the Org-wide CAPTCHA Settings
      description: >-
        Replaces the CAPTCHA settings object for your organization.

        > **Note**: You can disable CAPTCHA for your organization by setting
        `captchaId` and `enabledPages` to `null`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                captchaId: abcd4567
                enabledPages:
                  - SSR
                  - SIGN_IN
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                captchaId: abcd4567
                enabledPages:
                  - SSR
                  - SIGN_IN
                _links:
                  self:
                    href: https://your-subdomain.okta.com/api/v1/captchas/abcd4567
                    hints:
                      allow:
                        - GET
                        - POST
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: captchaId'
                errorLink: E0000001
                errorId: oae-hk3rssXQmOWDRsaFfxe8A
                errorCauses:
                  errorSummary: >-
                    captchaId: Invalid CAPTCHA ID. The value of captchaId cannot
                    be blank when enabledPages is not empty. Please resubmit
                    with an existing CAPTCHA ID or disable CAPTCHA support on
                    all supported pages.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - CAPTCHAs
      summary: Delete the Org-wide CAPTCHA Settings
      description: Deletes the CAPTCHA settings object for your organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/domains:
    get:
      tags:
        - Custom Domains
      summary: List all Custom Domains
      description: Lists all verified custom domains for the org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                domains:
                  - brandId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    certificateSourceType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dnsRecords:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    domain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    publicCertificate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    validationStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - brandId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    certificateSourceType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dnsRecords:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    domain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    publicCertificate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    validationStatus:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    _links:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Custom Domains
      summary: Create a Custom Domain
      description: Creates your custom domain
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                certificateSourceType: MANUAL
                domain: login.example.com
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                brandId: bndul904tTZ6kWVhP0g3
                certificateSourceType: OKTA_MANAGED
                dnsRecords:
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                domain: login.example.com
                id: OcDz6iRyjkaCTXkdo0g3
                publicCertificate:
                  expiration: '2021-05-11T05:13:05.000Z'
                  fingerprint: >-
                    73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4
                  subject: CN=login.example.com
                validationStatus: VERIFIED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  brand:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  certificate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  verify:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/domains/{domainId}:
    get:
      tags:
        - Custom Domains
      summary: Retrieve a Custom Domain
      description: Retrieves a custom domain by `domainId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: domainId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Domain
          example: OmWNeywfTzElSLOBMZsL
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                brandId: bndul904tTZ6kWVhP0g3
                certificateSourceType: OKTA_MANAGED
                dnsRecords:
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                domain: login.example.com
                id: OcDz6iRyjkaCTXkdo0g3
                publicCertificate:
                  expiration: '2021-05-11T05:13:05.000Z'
                  fingerprint: >-
                    73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4
                  subject: CN=login.example.com
                validationStatus: VERIFIED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  brand:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  certificate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  verify:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Custom Domains
      summary: Replace a Custom Domain's Brand
      description: Replaces a custom domain's brand
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                brandId: bndul904tTZ6kWVhP0g3
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: domainId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Domain
          example: OmWNeywfTzElSLOBMZsL
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                brandId: bndul904tTZ6kWVhP0g3
                certificateSourceType: OKTA_MANAGED
                dnsRecords:
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                domain: login.example.com
                id: OcDz6iRyjkaCTXkdo0g3
                publicCertificate:
                  expiration: '2021-05-11T05:13:05.000Z'
                  fingerprint: >-
                    73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4
                  subject: CN=login.example.com
                validationStatus: VERIFIED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  brand:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  certificate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  verify:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Custom Domains
      summary: Delete a Custom Domain
      description: Deletes a custom domain by `domainId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: domainId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Domain
          example: OmWNeywfTzElSLOBMZsL
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/domains/{domainId}/certificate:
    put:
      tags:
        - Custom Domains
      summary: Upsert the Custom Domain's Certificate
      description: >-
        Upserts (creates or renews) the `MANUAL` certificate for the custom
        domain. If the `certificateSourceType` in the domain is `OKTA_MANAGED`,
        it becomes `MANUAL` and Okta no longer manages and renews certificates
        for this domain since a user-managed certificate has been provided.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                certificate: >-
                  "-----BEGIN
                  CERTIFICATE-----\nMIIFNzCCBB+gAwIBAgHTAAXomJWRama3ypu8TIxdA9wzMA0GCSqGSIb3DQEBCwUA\nMDIzCzAJCgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MQswCQYDVQQD\nEwJSMzAeFw0yMTAyMTAwNTEzMDVaFw0yMTA1MTEwNTEzMDVaMCQxIjAgBgNVBAMT\nGWFuaXRhdGVzdC5zaWdtYW5ldGNvcnAudXMwggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQC5cyk6x63iBJSWvtgsOBqIxfO8euPHcRnyWsL9dsvnbNyOnyvc\nqFWxdiW3sh2cItzYtoN1Zfgj5lWGOVXbHxP0VaNG9fHVX3+NHP6LFHQz92BzAYQm\npqi9zaP/aKJklk6LdPFbVLGhuZfm34+ijW9YsgLTKR2WTaZJK5QtamVVmP+VsSCl\na2ifFzjz2FCkMMEc/Y0zUyP+en/mbL71K+VnpZdlEC1s38EvjRTFKFZTKVw5wpWg\nCZQq/AZYj9RxR23IIuRcUJ8TQ2pyoc3kIXPWjiIarSgBlA8G9kCsxgzXP2RyLwKr\nIBIo+qyHweifpPYW28ipdSbPjiypAMdpbGLDAgMBAAGjggJTMIICTzAOBgNVHQ8B\nAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMAwGA1UdEwEB\n/wQCMAAwHQYDVR0OBBYEFPVZKiovtIK4Av/IBUQeLUs29pT6MB8GA1UdIwQYMBaA\nFBQusxe3WFbLrlAJQOYfr52LFMLGMFUGCCsGAQUFBwEBBEkwRzAhBggrBgEFBQcw\nAYYVaHR0cDovL3IzLm8ubGVuY3Iub3JnMCIGCCsGAQUFBzAChhZodHRwOi8vcjMu\naS5sZW5jci5vcmcvMCQGA1UdEQQdMBuCGWFuaXRhdGVzdC5zaWdtYW5ldGNvcnAu\ndXMwTAYDVR0gBEUwQzAIBgZngQwBAgEwNwYLKwYBBAGC3xMBAQEwKDAmBggrBgEF\nBQcCARYaaHR0cDovL2Nwcy5sZXRzZW5jcnlwdC5vcmcwggEDBgorBgEEAdZ5AgQC\nBIH0BIHxAO8AdgBc3EOS/uarRUSxXprUVuYQN/vV+kfcoXOUsl7m9scOygAAAXeK\nkmOsAAAEAwBHMEUCIQDSudPEWXk969BT8yz3ag6BJWCMRU5tefEw9nXEQMsh5gIg\nUmfGIuUlcNNI5PydVIHj+zns+SR8P7zfd3FIxW4gK0QAdQD2XJQv0XcwIhRUGAgw\nlFaO400TGTO/3wwvIAvMTvFk4wAAAXeKkmOlAAAEAwBGMEQCIHQkr2qOGuInvonv\nW4vvdI61nraax5V6SC3E0D2JSO91AiBVhpX4BBafRAh36r7l8LrxAfxBM3CjBmAC\nq8fUrWfIWDANBgkqhkiG9w0BAQsFAAOCAQEAgGDMKXofKpDdv5kkID3s5GrKdzaj\njFmb/6kyqd1E6eGXZAewCP1EF5BVvR6lBP2aRXiZ6sJVZktoIfztZnbxBGgbPHfv\nR3iXIG6fxkklzR9Y8puPMBFadANE/QV78tIRAlyaqeSNsoxHi7ssQjHTP111B2lf\n3KmuTpsruut1UesEJcPReLk/1xTkRx262wAncach5Wp+6GWWduTZYJbsNFyrK1RP\nYQ0qYpP9wt2qR+DGaRUBG8i1XLnZS8pkyxtKhVw/a5Fowt+NqCpEBjjJiWJRSGnG\nNSgRtSXq11j8O4JONi8EXe7cEtvzUiLR5PL3itsK2svtrZ9jIwQ95wOPaA==\n-----END
                  CERTIFICATE-----",
                certificateChain: >-
                  "-----BEGIN
                  CERTIFICATE-----\nMIIFPjCCBCbjAwIBAgISA7RikMltj36DkLk1DUzjwfYBMA0GCSqGSIb3DQEBCwUA\nMDIxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MQswCQYDVQQD\nEwJSMzAeFw0yMTEwMTExOTQ3MjRaFw0yMjAxMDkxOTQ3MjNaMCgxJjAkBgNVBAMT\nHWFuaXRhdGVzdHJhaW4uc2lnbWFuZXRjb3JwLnVzMIIBIjANBgkqhkiG9w0BAQEF\nAAOCAQ8AMIIBCgKCAQEA40EsG7YrFlsH3XdZKirdKKOC7/cca5g9L4rwyA/PlfeU\nB7mJhbQI/a3yZbtY+GjHmedBx15aPtyq+NFZLOkiRCXx0k2zNIJB4yC6Jr/Yp8C2\nrXO6mrCcuqpX7SuDPBtrfdYcIg8G6m0wjj1V1p2/XR8G//CBe8I2XTaTpHsx/VC8\nMNOAA27aSbeX4Nz6TQ69rFuxRG+neUbcz2hQKwroCsCHi6iBmqRkg19Uh8315Cx2\nBUqY0JecpP42KMiktzIoSlqS9yZSuNQh1kP1tPwkEzbs/t3FrfCnnRx5RDr2pJpV\nnonL3sB3TVotS3nFgPNHCfp65O0Bg/3ZpU9IvUpcdQIDAQABo4ICVjCCAlIwDgYD\nVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNV\nHRMBAf8EAjAAMB0GA1UdDgQWBBSzWt3Dvp71cKA2Z54ESjjyM4dp+jAfBgNVHSME\nGDAWgBQULrMXt1hWy65QCUDmH6+dixTCxjBVBggrBgEFBQcBAQRJMEcwIQYIKwYB\nBQUHMAGGFWh0dHA6Ly9yMy5vLmxlbmNyLm9yZzAiBggrBgEFBQcwAoYWaHR0cDov\nL3IzLmkubGVuY3Iub3JnLzAoBgNVHREEITAfgh1hbml0YXRlc3RyYWluLnNpZ21h\nbmV0Y29ycC51czBMBgNVHSAERTBDMAgGBmeBDAECATA3BgsrBgEEAYLfEwEBATAo\nMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxldHNlbmNyeXB0Lm9yZzCCAQIGCisG\nAQQB1nkCBAIEgfMEgfAA7gB1AG9Tdqwx8DEZ2JkApFEV/3cVHBHZAsEAKQaNsgia\nN9kTAAABfHEcLqAAAAQDAEYwRAIgMlyQ61FjuIKDfATjz0wfkskChD0csVe0TStq\nmC7NbLACICp3CYMvvDiWt1pr5pzCwTQO8F6v0/qNjmH4mjCutAgyAHUARqVV63X6\nkSAwtaKJafTzfREsQXS+/Um4havy/HD+bUcAAAF8cRwvRAAABAMARjBEAiAZd6Vn\n7MLXT7JeIxZrfbNARrf5oCM4UAVjjJeaUhB1MwIgSLW5cVAZvkiwbQW+vIutFjBz\na8cNb/i+nM7RxFW+JPgwDQYJKoZIhvcNAQELBQADggEBAIlHZiHIuOvYFteqpwvR\n0ElqinIpkYsfI+0O5FwHBXz7vMCPGtfdlcX5M10eW3aEBo9lR59mjDMsMufbTb60\nJuSnguelkUoq4WzqjZI+2uy/FTztI5GPpXmXW3IyzbqmCWQt7u8N607g1TYLBaLL\nrbFIhl+LbTJAa//mxI6bb4l/86j/kSjht6U0OIde7ylscb+3MHobbpIWJYp8Jr1D\nubm/0glL46ExnuLbIKojLhDBnG/wHVunB0rJxGh1vPvwD75O1nSIdxuNlVcGwws+\n7wsOyPA1s0VWzrMN1olLMyIPFCwPvfCm1E8Dje1AXMpmyDlqjEoQsoMUH//GKF0S\nTgM=\n-----END
                  CERTIFICATE-----\n-----BEGIN
                  CERTIFICATE-----\nMIIFFjCCAv6gAwIBAgIRAJErCErPDBinU/bWLiWnX1owDQYJKoZIhvcNAQELBQAw\nTzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\ncmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMjAwOTA0MDAwMDAw\nWhcNMjUwOTE1MTYwMDAwWjAyMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNTGV0J3Mg\nRW5jcnlwdDELMAkGA1UEAxMCUjMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQC7AhUozPaglNMPEuyNVZLD+ILxmaZ6QoinXSaqtSu5xUyxr45r+XXIo9cP\nR5QUVTVXjJ6oojkZ9YI8QqlObvU7wy7bjcCwXPNZOOftz2nwWgsbvsCUJCWH+jdx\nsxPnHKzhm+/b5DtFUkWWqcFTzjTIUu61ru2P3mBw4qVUq7ZtDpelQDRrK9O8Zutm\nNHz6a4uPVymZ+DAXXbpyb/uBxa3Shlg9F8fnCbvxK/eG3MHacV3URuPMrSXBiLxg\nZ3Vms/EY96Jc5lP/Ooi2R6X/ExjqmAl3P51T+c8B5fWmcBcUr2Ok/5mzk53cU6cG\n/kiFHaFpriV1uxPMUgP17VGhi9sVAgMBAAGjggEIMIIBBDAOBgNVHQ8BAf8EBAMC\nAYYwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMBIGA1UdEwEB/wQIMAYB\nAf8CAQAwHQYDVR0OBBYEFBQusxe3WFbLrlAJQOYfr52LFMLGMB8GA1UdIwQYMBaA\nFHm0WeZ7tuXkAXOACIjIGlj26ZtuMDIGCCsGAQUFBwEBBCYwJDAiBggrBgEFBQcw\nAoYWaHR0cDovL3gxLmkubGVuY3Iub3JnLzAnBgNVHR8EIDAeMBygGqAYhhZodHRw\nOi8veDEuYy5sZW5jci5vcmcvMCIGA1UdIAQbMBkwCAYGZ4EMAQIBMA0GCysGAQQB\ngt8TAQEBMA0GCSqGSIb3DQEBCwUAA4ICAQCFyk5HPqP3hUSFvNVneLKYY611TR6W\nPTNlclQtgaDqw+34IL9fzLdwALduO/ZelN7kIJ+m74uyA+eitRY8kc607TkC53wl\nikfmZW4/RvTZ8M6UK+5UzhK8jCdLuMGYL6KvzXGRSgi3yLgjewQtCPkIVz6D2QQz\nCkcheAmCJ8MqyJu5zlzyZMjAvnnAT45tRAxekrsu94sQ4egdRCnbWSDtY7kh+BIm\nlJNXoB1lBMEKIq4QDUOXoRgffuDghje1WrG9ML+Hbisq/yFOGwXD9RiX8F6sw6W4\navAuvDszue5L3sz85K+EC4Y/wFVDNvZo4TYXao6Z0f+lQKc0t8DQYzk1OXVu8rp2\nyJMC6alLbBfODALZvYH7n7do1AZls4I9d1P4jnkDrQoxB3UqQ9hVl3LEKQ73xF1O\nyK5GhDDX8oVfGKF5u+decIsH4YaTw7mP3GFxJSqv3+0lUFJoi5Lc5da149p90Ids\nhCExroL1+7mryIkXPeFM5TgO9r0rvZaBFOvV2z0gp35Z0+L4WPlbuEjN/lxPFin+\nHlUjr8gRsI3qfJOQFy/9rKIJR0Y/8Omwt/8oTWgy1mdeHmmjk7j1nYsvC9JSQ6Zv\nMldlTTKB3zhThV1+XWYp6rjd5JW1zbVWEkLNxE7GJThEUG3szgBVGP7pSWTUTsqX\nnLRbwHOoq7hHwg==\n-----END
                  CERTIFICATE-----\n-----BEGIN
                  CERTIFICATE-----\nMIIFYDCCBEigAwIBAgIQQAF3ITfU6UK47naqPGQKtzANBgkqhkiG9w0BAQsFADA/\nMSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT\nDkRTVCBSb290IENBIFgzMB4XDTIxMDEyMDE5MTQwM1oXDTI0MDkzMDE4MTQwM1ow\nTzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\ncmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwggIiMA0GCSqGSIb3DQEB\nAQUAA4ICDwAwggIKAoICAQCt6CRz9BQ385ueK1coHIe+3LffOJCMbjzmV6B493XC\nov71am72AE8o295ohmxEk7axY/0UEmu/H9LqMZshftEzPLpI9d1537O4/xLxIZpL\nwYqGcWlKZmZsj348cL+tKSIG8+TA5oCu4kuPt5l+lAOf00eXfJlII1PoOK5PCm+D\nLtFJV4yAdLbaL9A4jXsDcCEbdfIwPPqPrt3aY6vrFk/CjhFLfs8L6P+1dy70sntK\n4EwSJQxwjQMpoOFTJOwT2e4ZvxCzSow/iaNhUd6shweU9GNx7C7ib1uYgeGJXDR5\nbHbvO5BieebbpJovJsXQEOEO3tkQjhb7t/eo98flAgeYjzYIlefiN5YNNnWe+w5y\nsR2bvAP5SQXYgd0FtCrWQemsAXaVCg/Y39W9Eh81LygXbNKYwagJZHduRze6zqxZ\nXmidf3LWicUGQSk+WT7dJvUkyRGnWqNMQB9GoZm1pzpRboY7nn1ypxIFeFntPlF4\nFQsDj43QLwWyPntKHEtzBRL8xurgUBN8Q5N0s8p0544fAQjQMNRbcTa0B7rBMDBc\nSLeCO5imfWCKoqMpgsy6vYMEG6KDA0Gh1gXxG8K28Kh8hjtGqEgqiNx2mna/H2ql\nPRmP6zjzZN7IKw0KKP/32+IVQtQi0Cdd4Xn+GOdwiK1O5tmLOsbdJ1Fu/7xk9TND\nTwIDAQABo4IBRjCCAUIwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYw\nSwYIKwYBBQUHAQEEPzA9MDsGCCsGAQUFBzAChi9odHRwOi8vYXBwcy5pZGVudHJ1\nc3QuY29tL3Jvb3RzL2RzdHJvb3RjYXgzLnA3YzAfBgNVHSMEGDAWgBTEp7Gkeyxx\n+tvhS5B1/8QVYIWJEDBUBgNVHSAETTBLMAgGBmeBDAECATA/BgsrBgEEAYLfEwEB\nATAwMC4GCCsGAQUFBwIBFiJodHRwOi8vY3BzLnJvb3QteDEubGV0c2VuY3J5cHQu\nb3JnMDwGA1UdHwQ1MDMwMaAvoC2GK2h0dHA6Ly9jcmwuaWRlbnRydXN0LmNvbS9E\nU1RST09UQ0FYM0NSTC5jcmwwHQYDVR0OBBYEFHm0WeZ7tuXkAXOACIjIGlj26Ztu\nMA0GCSqGSIb3DQEBCwUAA4IBAQAKcwBslm7/DlLQrt2M51oGrS+o44+/yQoDFVDC\n5WxCu2+b9LRPwkSICHXM6webFGJueN7sJ7o5XPWioW5WlHAQU7G75K/QosMrAdSW\n9MUgNTP52GE24HGNtLi1qoJFlcDyqSMo59ahy2cI2qBDLKobkx/J3vWraV0T9VuG\nWCLKTVXkcGdtwlfFRjlBz4pYg1htmf5X6DYO8A4jqv2Il9DjXA6USbW1FzXSLr9O\nhe8Y4IWS6wY7bCkjCWDcRQJMEhg76fsO3txE+FiYruq9RUWhiF1myv4Q6W+CyBFC\nDfvp7OOGAN6dEOM4+qR9sdjoSYKEBpsr6GtPAQw4dy753ec5\n-----END
                  CERTIFICATE-----"
                privateKey: >-
                  "-----BEGIN PRIVATE
                  KEY-----\nMIIEvgIBADANBgkqhkiG9w0AAQEFAASCBKgwghSkAgEAAoIBAQC5cyk6y63iBJSW\nstgsOBqIxfO8euPHcRnyWsL9dsvnbNyOnyvcqFWxdiW3sh2cItzYtoN1Zfgj5lWG\nOVXbHxP0VaNG9fHVX3+NHP6LFHQz92BzAYQmpqi9zaP/aKJklk6LdPFbVLGhuZfm\n34+ijW9YsgLTKR2WTaZJK5QtamVVmP+VsSCla2ifFzjz2FCkMMEc/Y0zUyP+en/m\nbL71K+VnpZdlEC1s38EvjRTFKFZTKVw5wpWgCZQq/AZYj9RxR23IIuRcUJ8TQ2py\noc3kIXPWjiIarSgBlA8G9kCsxgzXP2RyLwKrIBIo+qyHweifpPYW28ipdSbPjiyp\nAMdpbGLDAgMBAAECggEAUXVfT91z6IqghhKwO8QtC5T/+fN06B8rCYSKj/FFoZL0\n0oTiLFuYwImoCadoUDQUE/Efj0rKE2LSgFHg/44IItQXE01m+5WmHmL1ADxsyoLH\nz9yDosKj7jNM7RyV8F8Bg0pL1hU+rU4rhhL/MaS0mx4eFYjC4UmcWBmXTdelSVJa\nkvXvQLT5y86bqh7tqMjM/kALTWRz5CgNJFk/ONA1yo5RTX9S7SIXimBgAvuGqP8i\nMPEhJou7U3DfzXVfvP8byqNdsZs6ZNhG3wXspl61mRyrY+51SOaNLA7Bkji7x4bH\nNw6mJI0IJTAP9oc1Z8fYeMuxT1bfuD7VOupSP0mAMQKBgQDk+KuyQkmPymeP/Wwu\nII4DUpleVzxTK9obMQQoCEEElbQ6+jTb+8ixP0bWLvBXg/rX734j7OWfn/bljWLH\nXLrSoqQZF1+XMVeY4g4wx9UuTK/D2n791zdOgQivxbIPdWL3a4ap86ar8uyMgJu8\nBLXfFBAOc+9myqUkbeO7wt0e6QKBgQDPV04jPtIJoMrggpQDNreGrANKOmsXWxj4\nOHW13QNdJ2KGQpoTdoqQ8ZmlxuA8Bf2RjHsnB2kgGVTVQR74zRib4MByhvsdhvVm\nF2LNsJoIDfqtv3c+oj13VonRUGuzUeJpwT/snyaL+jQ/ZZcYz0jDgDhIODTcFYj8\nDMSD5SHgywKBgHH6MwWuJ44TNBAiF2qyu959jGjAxf+k0ZI9iRMgYLUWjDvbdtqW\ncCWDGRDfFraJtSEuTz003GzkJPPJuIUC7OCTI1p2HxhU8ITi6itwHfdJJyk4J4TW\nT+qdIqTUpTk6tsPw23zYE3x+lS+viVZDhgEArKl1HpOthh0nMnixnH6ZAoGBAKGn\nV+xy1h9bldFk/TFkP8Jn6ki9MzGKfPVKT7vzDORcCJzU4Hu8OFy5gSmW3Mzvfrsz\n4/CR/oxgM5vwoc0pWr5thJ3GT5K93iYypX3o6q7M91zvonDa3UFl3x2qrc2pUfVS\nDhzWGJ+Z+5JSCnP1aK3EEh18dPoCcELTUYPj6X3xAoGBALAllTb3RCIaqIqk+s3Y\n6KDzikgwGM6j9lmOI2MH4XmCVym4Z40YGK5nxulDh2Ihn/n9zm13Z7ul2DJwgQSO\n0zBc7/CMOsMEBaNXuKL8Qj4enJXMtub4waQ/ywqHIdc50YaPI5Ax8dD/10h9M6Qc\nnUFLNE8pXSnsqb0eOL74f3uQ\n-----END
                  PRIVATE KEY-----"
                type: PEM
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: domainId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Domain
          example: OmWNeywfTzElSLOBMZsL
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/domains/{domainId}/verify:
    post:
      tags:
        - Custom Domains
      summary: Verify a Custom Domain
      description: >-
        Verifies the custom domain and validity of DNS records by `domainId`.
        Furthermore, if the `certificateSourceType` in the domain is
        `OKTA_MANAGED`, then an attempt is made to obtain and install a
        certificate. After a certificate is obtained and installed by Okta, Okta
        manages the certificate including certificate renewal.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: domainId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Domain
          example: OmWNeywfTzElSLOBMZsL
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                brandId: bndul904tTZ6kWVhP0g3
                certificateSourceType: OKTA_MANAGED
                dnsRecords:
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fqdn:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recordType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    values:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                domain: login.example.com
                id: OcDz6iRyjkaCTXkdo0g3
                publicCertificate:
                  expiration: '2021-05-11T05:13:05.000Z'
                  fingerprint: >-
                    73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4
                  subject: CN=login.example.com
                validationStatus: VERIFIED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  brand:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  certificate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  verify:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands:
    get:
      tags:
        - Customizations
      summary: List all Brands
      description: Lists all the brands in your org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: emailDomain,domains
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: q
          in: query
          schema:
            type: string
          description: Searches the records for matching value
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: bnd114iNkrcN6aR680g4
                  name: Okta Default
                  isDefault: true
                  removePoweredByOkta: false
                  customPrivacyPolicyUrl: null
                  locale: en
                  emailDomainId: OeD114iNkrcN6aR680g4
                  defaultApp:
                    appInstanceId: 0oa114iNkrcN6aR680g4
                    appLinkName: null
                    classicApplicationUri: null
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
                    themes:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes
                      hints:
                        allow:
                          - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Customizations
      summary: Create a Brand
      description: Creates a new brand in your org
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: My Awesome Brand
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: themes,emailDomain
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: q
          in: query
          schema:
            type: string
          description: Searches the records for matching value
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: bnd114iNkrcN6aR680g5
                removePoweredByOkta: false
                customPrivacyPolicyUrl: null
                name: My Awesome Brand
                locale: en
                defaultApp:
                  appInstanceId: 0oa114iNkrcN6aR680g4
                  appLinkName: null
                  classicApplicationUri: null
                isDefault: false
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g5
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  themes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g5/themes
                    hints:
                      allow:
                        - GET
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}:
    get:
      tags:
        - Customizations
      summary: Retrieve a Brand
      description: Retrieves a brand by `brandId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: themes,emailDomain
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: bnd114iNkrcN6aR680g4
                removePoweredByOkta: false
                customPrivacyPolicyUrl: null
                name: Okta Default
                isDefault: true
                locale: en
                emailDomainId: OeD114iNkrcN6aR680g4
                defaultApp:
                  appInstanceId: 0oa114iNkrcN6aR680g4
                  appLinkName: null
                  classicApplicationUri: null
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  themes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace a Brand
      description: Replaces a brand by `brandId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                customPrivacyPolicyUrl: https://www.someHost.com/privacy-policy
                agreeToCustomPrivacyPolicy: true
                removePoweredByOkta: true
                name: New Name For Brand
                emailDomainId: OeD114iNkrcN6aR680g4
                locale: en
                defaultApp:
                  appInstanceId: 0oa114iNkrcN6aR680g4
                  appLinkName: null
                  classicApplicationUri: null
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: themes,emailDomain
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: bnd114iNkrcN6aR680g4
                removePoweredByOkta: true
                agreeToCustomPrivacyPolicy: true
                name: New Name For Brand
                isDefault: true
                customPrivacyPolicyUrl: https://www.someHost.com/privacy-policy
                emailDomainId: OeD114iNkrcN6aR680g4
                defaultApp:
                  appInstanceId: 0oa114iNkrcN6aR680g4
                  appLinkName: null
                  classicApplicationUri: null
                locale: en
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  themes:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes
                    hints:
                      allow:
                        - GET
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete a brand
      description: Deletes a brand by `brandId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: themes,emailDomain
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000200
                errorSummary: A default brand cannot be deleted
                errorLink: E0000200
                errorId: oaeAdRqprFuTyKokyYPbURJkA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/domains:
    get:
      tags:
        - Customizations
      summary: List all Domains associated with a Brand
      description: Lists all domains associated with a brand by `brandId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - brandId: bndul904tTZ6kWVhP0g3
                  certificateSourceType: OKTA_MANAGED
                  dnsRecords:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  domain: login.example.com
                  id: OcDz6iRyjkaCTXkdo0g3
                  publicCertificate:
                    expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fingerprint:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    subject:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  validationStatus: VERIFIED
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - brandId: bndul904tTZ6kWVhP0g3
                  certificateSourceType: OKTA_MANAGED
                  dnsRecords:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  domain: login.example.com
                  id: OcDz6iRyjkaCTXkdo0g3
                  publicCertificate:
                    expiration:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    fingerprint:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    subject:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  validationStatus: VERIFIED
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/error:
    get:
      tags:
        - Customizations
      summary: Retrieve the Error Page Sub-Resources
      description: >-
        Retrieves the error page sub-resources. The `expand` query parameter
        specifies which sub-resources to include in the response.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: customized,customized
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                _embedded:
                  default:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  customized:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  customizedUrl: https://wodykoB.gcbH-r-2Ksse
                  preview:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  previewUrl: >-
                    https://FfIxWSeimJUxacplNh.sqsp691qmH,xW6yzMihqIqnnUZQFtcbvExVkZencFD87y
                _links:
                  value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/error/customized:
    get:
      tags:
        - Customizations
      summary: Retrieve the Customized Error Page
      description: >-
        Retrieves the customized error page. The customized error page appears
        in your live environment.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Customized Error Page
      description: >-
        Replaces the customized error page. The customized error page appears in
        your live environment.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Customized Error Page
      description: >-
        Deletes the customized error page. As a result, the default error page
        appears in your live environment.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/error/default:
    get:
      tags:
        - Customizations
      summary: Retrieve the Default Error Page
      description: >-
        Retrieves the default error page. The default error page appears when no
        customized error page exists.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/error/preview:
    get:
      tags:
        - Customizations
      summary: Retrieve the Preview Error Page Preview
      description: >-
        Retrieves the preview error page. The preview error page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/error/preview`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Preview Error Page
      description: >-
        Replaces the preview error page. The preview error page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/error/preview`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: eu aliquip est ut eiusmod
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Preview Error Page
      description: >-
        Deletes the preview error page. The preview error page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/error/preview`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-in:
    get:
      tags:
        - Customizations
      summary: Retrieve the Sign-in Page Sub-Resources
      description: >-
        Retrieves the sign-in page sub-resources. The `expand` query parameter
        specifies which sub-resources to include in the response.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: previewUrl,previewUrl
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                _embedded:
                  default:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  customized:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  customizedUrl: https://wodykoB.gcbH-r-2Ksse
                  preview:
                    pageContent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  previewUrl: >-
                    https://FfIxWSeimJUxacplNh.sqsp691qmH,xW6yzMihqIqnnUZQFtcbvExVkZencFD87y
                _links:
                  value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-in/customized:
    get:
      tags:
        - Customizations
      summary: Retrieve the Customized Sign-in Page
      description: >-
        Retrieves the customized sign-in page. The customized sign-in page
        appears in your live environment.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Customized Sign-in Page
      description: >-
        Replaces the customized sign-in page. The customized sign-in page
        appears in your live environment.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Customized Sign-in Page
      description: >-
        Deletes the customized sign-in page. As a result, the default sign-in
        page appears in your live environment.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-in/default:
    get:
      tags:
        - Customizations
      summary: Retrieve the Default Sign-in Page
      description: >-
        Retrieves the default sign-in page. The default sign-in page appears
        when no customized sign-in page exists.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-in/preview:
    get:
      tags:
        - Customizations
      summary: Retrieve the Preview Sign-in Page Preview
      description: >-
        Retrieves the preview sign-in page. The preview sign-in page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/login/preview`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Preview Sign-in Page
      description: >-
        Replaces the preview sign-in page. The preview sign-in page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/login/preview`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Location:
              schema:
                type: string
                example: >-
                  https://tYTJILELpmiUPYGAhImwZAWYzC.gltiZ,o189Mq68YkWb5uOFfRj.ujDzU2ZTgcllwDd8IBLlPVaVDNHbLErDD7yveXBDCHsCwk
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                pageContent: occaecat commodo
                contentSecurityPolicySetting:
                  mode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reportUri:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  srcList:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetCustomizations:
                  signInLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  usernameInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  passwordInfoTip:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showPasswordVisibilityToggle:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  showUserIdentifier:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPasswordUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlockAccountUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  helpUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink1Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Label:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  customLink2Url:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticatorPageCustomLinkUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  classicRecoveryFlowEmailOrUsernameLabel:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  widgetGeneration:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                widgetVersion: 6652227.40.0
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Preview Sign-in Page
      description: >-
        Deletes the preview sign-in page. The preview sign-in page contains
        unpublished changes and isn't shown in your live environment. Preview it
        at `${yourOktaDomain}/login/preview`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-in/widget-versions:
    get:
      tags:
        - Customizations
      summary: List all Sign-in Widget Versions
      description: Lists all sign-in widget versions supported by the current org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - '28894160.641242'
                - '170.833'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/pages/sign-out/customized:
    get:
      tags:
        - Customizations
      summary: Retrieve the Sign-out Page Settings
      description: Retrieves the sign-out page settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: EXTERNALLY_HOSTED
                url: eu aliqua dolor sint
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Sign-out Page Settings
      description: Replaces the sign-out page settings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: EXTERNALLY_HOSTED
                url: eu aliqua dolor sint
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: EXTERNALLY_HOSTED
                url: eu aliqua dolor sint
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email:
    get:
      tags:
        - Customizations
      summary: List all Email Templates
      description: Lists all email templates
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: customizationCount,customizationCount
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: mollit occaecat cupidatat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - name: UserActivation
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                      hints:
                        allow:
                          - GET
                    settings:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings
                      hints:
                        allow:
                          - GET
                          - PUT
                    defaultContent:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content
                      hints:
                        allow:
                          - GET
                    customizations:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations
                      hints:
                        allow:
                          - GET
                          - POST
                          - DELETE
                    test:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                      hints:
                        allow:
                          - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}:
    get:
      tags:
        - Customizations
      summary: Retrieve an Email Template
      description: Retrieves the details of an email template by name
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: customizationCount,customizationCount
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: UserActivation
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  settings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings
                    hints:
                      allow:
                        - GET
                        - PUT
                  defaultContent:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content
                    hints:
                      allow:
                        - GET
                  customizations:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations
                    hints:
                      allow:
                        - GET
                        - POST
                        - DELETE
                  test:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/customizations:
    get:
      tags:
        - Customizations
      summary: List all Email Customizations
      description: >
        Lists all customizations of an email template


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is enabled, all existing customizations are retrieved,
        including customizations for additional languages. If disabled, only
        customizations for Okta-supported languages are returned.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - language: en
                  isDefault: true
                  subject: Welcome to ${org.name}!
                  body: >-
                    <!DOCTYPE html><html><body><p>Hello,
                    ${user.profile.firstName}. Click <a
                    href="${activationLink}">here</a> to activate your
                    account.</body></html>
                  id: oel11u6DqUiMbQkpl0g4
                  created: '2021-11-09T20:38:10.000Z'
                  lastUpdated: '2021-11-11T20:38:10.000Z'
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
                    template:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                      hints:
                        allow:
                          - GET
                    preview:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview
                      hints:
                        allow:
                          - GET
                    test:
                      href: >-
                        https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                      hints:
                        allow:
                          - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Customizations
      summary: Create an Email Customization
      description: >
        Creates a new Email Customization


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is enabled, you can create a customization for any BCP47
        language in addition to the Okta-supported languages.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                language: fr
                subject: Bienvenue dans ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Bonjour
                  ${user.profile.firstName}. <a href="${activationLink}">Activer
                  le compte</a></p></body></html>
                isDefault: false
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                language: fr
                subject: Bienvenue dans ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Bonjour
                  ${user.profile.firstName}. <a href="${activationLink}">Activer
                  le compte</a></p></body></html>
                isDefault: false
                id: oel11u6DqUiMbQkpl0g4
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  preview:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview
                    hints:
                      allow:
                        - GET
                  test:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000182
                errorSummary: A default email template customization already exists.
                errorLink: E0000182
                errorId: oaeXYwTiMvASsC3O4HCzjFaCA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete all Email Customizations
      description: >
        Deletes all customizations for an email template


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is enabled, all customizations are deleted, including
        customizations for additional languages. If disabled, only
        customizations in Okta-supported languages are deleted.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}:
    get:
      tags:
        - Customizations
      summary: Retrieve an Email Customization
      description: >
        Retrieves an email customization by its unique identifier


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is disabled, requests to retrieve an additional language
        customization by ID result in a `404 Not Found` error response.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
        - name: customizationId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the email customization
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                language: en
                isDefault: true
                subject: Welcome to ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Hello,
                  ${user.profile.firstName}. Click <a
                  href="${activationLink}">here</a> to activate your
                  account.</body></html>
                id: oel11u6DqUiMbQkpl0g4
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  preview:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview
                    hints:
                      allow:
                        - GET
                  test:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace an Email Customization
      description: >
        Replaces an email customization using property values


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is disabled, requests to update a customization for an
        additional language return a `404 Not Found` error response.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                language: fr
                subject: Bienvenue dans ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Bonjour
                  ${user.profile.firstName}. <a href="${activationLink}">Activer
                  le compte</a></p></body></html>
                isDefault: false
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
        - name: customizationId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the email customization
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                language: fr
                subject: Bienvenue dans ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Bonjour
                  ${user.profile.firstName}. <a href="${activationLink}">Activer
                  le compte</a></p></body></html>
                isDefault: false
                id: oel11u6DqUiMbQkpl0g4
                created: '2021-11-09T20:38:10.000Z'
                lastUpdated: '2021-11-11T20:38:10.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  preview:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview
                    hints:
                      allow:
                        - GET
                  test:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000182
                errorSummary: A default email template customization already exists.
                errorLink: E0000182
                errorId: oaeXYwTiMvASsC3O4HCzjFaCA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete an Email Customization
      description: >
        Deletes an Email Customization by its unique identifier


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is disabled, deletion of an existing additional language
        customization by ID doesn't register.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
        - name: customizationId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the email customization
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000184
                errorSummary: A default email template customization can't be deleted.
                errorLink: E0000184
                errorId: oaeAdRqprFuTyKokyYPbURJkA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview:
    get:
      tags:
        - Customizations
      summary: Retrieve a Preview of an Email Customization
      description: >
        Retrieves a Preview of an Email Customization. All variable references
        are populated from the current user's context. For example,
        `${user.profile.firstName}`.


        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is disabled, requests for the preview of an additional
        language customization by ID return a `404 Not Found` error response.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
        - name: customizationId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the email customization
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                subject: Welcome to Okta!
                body: >-
                  <!DOCTYPE html><html><body><p>Hello, John. Click <a
                  href="https://{yourOktaDomain}/...">here</a> to activate your
                  account.</body></html>
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel2kk1zYJBJbeaGo0g4/preview
                    hints:
                      allow:
                        - GET
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  test:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/default-content:
    get:
      tags:
        - Customizations
      summary: Retrieve an Email Template Default Content
      description: >
        Retrieves an email template's default content


        <x-lifecycle class="ea"></x-lifecycle> Defaults to the current user's
        language given the following: 

        - Custom languages for Okta Email Templates is enabled

        - An additional language is specified for the `language` parameter
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: language
          in: query
          schema:
            type: string
          description: >-
            The language to use for the email. Defaults to the current user's
            language if unspecified.
          example: enim pariatur irure voluptate
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                subject: Welcome to ${org.name}!
                body: >-
                  <!DOCTYPE html><html><body><p>Hello,
                  ${user.profile.firstName}. Click <a
                  href="${activationLink}">here</a> to activate your
                  account.</body></html>
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content
                    hints:
                      allow:
                        - GET
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  preview:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview:
    get:
      tags:
        - Customizations
      summary: Retrieve a Preview of the Email Template default content
      description: >
        Retrieves a preview of an Email Template's default content. All variable
        references are populated using the current user's context. For example,
        `${user.profile.firstName}`.


        <x-lifecycle class="ea"></x-lifecycle> Defaults to the current user's
        language given the following:

        - Custom languages for Okta Email Templates is enabled

        - An additional language is specified for the `language` parameter
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: language
          in: query
          schema:
            type: string
          description: >-
            The language to use for the email. Defaults to the current user's
            language if unspecified.
          example: enim pariatur irure voluptate
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                subject: Welcome to Okta!
                body: >-
                  <!DOCTYPE html><html><body><p>Hello, John. Click <a
                  href="https://{yourOktaDomain}/...">here</a> to activate your
                  account.</body></html>
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview
                    hints:
                      allow:
                        - GET
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
                  defaultContent:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test/default-content
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/settings:
    get:
      tags:
        - Customizations
      summary: Retrieve the Email Template Settings
      description: Retrieves an email template's settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                recipients: ALL_USERS
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings
                    hints:
                      allow:
                        - GET
                        - PUT
                  template:
                    href: >-
                      https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation
                    hints:
                      allow:
                        - GET
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace the Email Template Settings
      description: Replaces an email template's settings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                recipients: ADMINS_ONLY
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '422':
          description: Unprocessable Entity (WebDAV) (RFC 4918)
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000189
                errorSummary: This template does not support the recipients value.
                errorLink: E0000189
                errorId: oae8L1-UkcNTeGi5xVQ28_lww
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/templates/email/{templateName}/test:
    post:
      tags:
        - Customizations
      summary: Send a Test Email
      description: >-
        Sends a test email to the current user’s primary and secondary email
        addresses. The email content is selected based on the following
        priority:

        1. The email customization for the language specified in the `language`
        query parameter.

        <x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta
        Email Templates is enabled and the `language` parameter is an additional
        language, the test email uses the customization corresponding to the
        language.

        2. The email template's default customization.

        3. The email template’s default content, translated to the current
        user's language.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: language
          in: query
          schema:
            type: string
          description: >-
            The language to use for the email. Defaults to the current user's
            language if unspecified.
          example: enim pariatur irure voluptate
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: templateName
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of the email template
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/themes:
    get:
      tags:
        - Customizations
      summary: List all Themes
      description: Lists all the themes in your brand
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - backgroundImage: ex sint incididunt veniam consectetur
                  emailTemplateTouchPointVariant: OKTA_DEFAULT
                  endUserDashboardTouchPointVariant: WHITE_LOGO_BACKGROUND
                  errorPageTouchPointVariant: BACKGROUND_IMAGE
                  favicon: consequat dolo
                  id: cupidatat nostrud et
                  loadingPageTouchPointVariant: NONE
                  logo: eiusmod
                  primaryColorContrastHex: et exercitation
                  primaryColorHex: ut adipisicing
                  secondaryColorContrastHex: adipisicing in minim do dolore
                  secondaryColorHex: est proident ex elit
                  signInPageTouchPointVariant: OKTA_DEFAULT
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - backgroundImage: sint in commodo
                  emailTemplateTouchPointVariant: FULL_THEME
                  endUserDashboardTouchPointVariant: WHITE_LOGO_BACKGROUND
                  errorPageTouchPointVariant: BACKGROUND_SECONDARY_COLOR
                  favicon: officia in
                  id: consequat culpa veniam sit
                  loadingPageTouchPointVariant: NONE
                  logo: aliquip proident
                  primaryColorContrastHex: deserunt occaecat es
                  primaryColorHex: ut eiusmod nostrud ullamco
                  secondaryColorContrastHex: non exercitation i
                  secondaryColorHex: dolore aute incididunt non quis
                  signInPageTouchPointVariant: BACKGROUND_SECONDARY_COLOR
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/themes/{themeId}:
    get:
      tags:
        - Customizations
      summary: Retrieve a Theme
      description: Retrieves a theme for a brand
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                backgroundImage: anim ipsum
                emailTemplateTouchPointVariant: OKTA_DEFAULT
                endUserDashboardTouchPointVariant: LOGO_ON_FULL_WHITE_BACKGROUND
                errorPageTouchPointVariant: BACKGROUND_SECONDARY_COLOR
                favicon: adipisi
                id: fugiat Lorem enim
                loadingPageTouchPointVariant: OKTA_DEFAULT
                logo: Ut
                primaryColorContrastHex: laboris
                primaryColorHex: Ut occaecat cillum
                secondaryColorContrastHex: cillum reprehenderit commodo qui enim
                secondaryColorHex: 'labore '
                signInPageTouchPointVariant: BACKGROUND_IMAGE
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Customizations
      summary: Replace a Theme
      description: Replaces a theme for a brand
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                emailTemplateTouchPointVariant: OKTA_DEFAULT
                endUserDashboardTouchPointVariant: WHITE_LOGO_BACKGROUND
                errorPageTouchPointVariant: OKTA_DEFAULT
                loadingPageTouchPointVariant: OKTA_DEFAULT
                primaryColorContrastHex: in id ut pariatur
                primaryColorHex: Ut nulla voluptate
                secondaryColorContrastHex: minim qui aliquip in
                secondaryColorHex: Duis Lorem proident
                signInPageTouchPointVariant: BACKGROUND_IMAGE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                backgroundImage: anim ipsum
                emailTemplateTouchPointVariant: OKTA_DEFAULT
                endUserDashboardTouchPointVariant: LOGO_ON_FULL_WHITE_BACKGROUND
                errorPageTouchPointVariant: BACKGROUND_SECONDARY_COLOR
                favicon: adipisi
                id: fugiat Lorem enim
                loadingPageTouchPointVariant: OKTA_DEFAULT
                logo: Ut
                primaryColorContrastHex: laboris
                primaryColorHex: Ut occaecat cillum
                secondaryColorContrastHex: cillum reprehenderit commodo qui enim
                secondaryColorHex: 'labore '
                signInPageTouchPointVariant: BACKGROUND_IMAGE
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/themes/{themeId}/background-image:
    post:
      tags:
        - Customizations
      summary: Upload the Background Image
      description: >-
        Uploads and replaces the background image for the theme. The file must
        be in PNG, JPG, or GIF format and less than 2 MB in size.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: '(Required) '
                  format: binary
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                url: officia sed
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Background Image
      description: Deletes a Theme background image
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/themes/{themeId}/favicon:
    post:
      tags:
        - Customizations
      summary: Upload the Favicon
      description: Uploads and replaces the favicon for the theme
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: '(Required) '
                  format: binary
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                url: officia sed
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Favicon
      description: Deletes a Theme favicon. The theme will use the default Okta favicon.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/brands/{brandId}/themes/{themeId}/logo:
    post:
      tags:
        - Customizations
      summary: Upload the Logo
      description: >-
        Uploads and replaces the logo for the theme. The file must be in PNG,
        JPG, or GIF format and less than 100kB in size. For best results use
        landscape orientation, a transparent background, and a minimum size of
        300px by 50px to prevent upscaling.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: '(Required) '
                  format: binary
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                url: officia sed
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Customizations
      summary: Delete the Logo
      description: Deletes a Theme logo. The theme will use the default Okta logo.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: brandId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the brand
          example: mollit occaecat cupidatat
        - name: themeId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the theme
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices:
    get:
      tags:
        - Devices
      summary: List all Devices
      description: >-
        Lists all devices with pagination support.

        You can return a subset of Devices that match a supported search
        criteria using the `search` query parameter.

        Searches for devices based on the properties specified in the `search`
        parameter conforming SCIM filter specifications (case-insensitive). This
        data is eventually consistent. The API returns different results
        depending on specified queries in the request. Empty list is returned if
        no objects match `search` request.

        > **Note:** Listing devices with `search` should not be used as a part
        of any critical flows—such as authentication or updates—to prevent
        potential data loss. `search` results may not reflect the latest
        information, as this endpoint uses a search index which may not be
        up-to-date with recent updates to the object. <br> Don't use search
        results directly for record updates, as the data might be stale and
        therefore overwrite newer data, resulting in data loss. <br> Use an `id`
        lookup for records that you update to ensure your results contain the
        latest data.

        This operation requires [URL
        encoding](https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1).
        For example, `search=profile.displayName eq "Bob"` is encoded as
        `search=profile.displayName%20eq%20%22Bob%22`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: 200u3des4afA47rYJu1d7
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return (recommend `20`)
          example: '20'
        - name: search
          in: query
          schema:
            type: string
          description: >-
            A SCIM filter expression that filters the results. Searches include
            all Device `profile` properties and the Device `id`, `status`, and
            `lastUpdated` properties.
          example: status eq "ACTIVE"
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            Includes associated user details and management status for the
            device in the `_embedded` attribute
          example: user
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: guo4a5u7YAHhjXrMK0g4
                  status: CREATED
                  created: '2019-10-02T18:03:07.000Z'
                  lastUpdated: '2019-10-02T18:03:07.000Z'
                  profile:
                    displayName: Example Device name 1
                    platform: WINDOWS
                    serialNumber: XXDDRFCFRGF3M8MD6D
                    sid: S-1-11-111
                    registered: true
                    secureHardwarePresent: false
                    diskEncryptionType: ALL_INTERNAL_VOLUMES
                  resourceType: UDDevice
                  resourceDisplayName:
                    value: Example Device name 1
                    sensitive: false
                  resourceAlternateId: null
                  resourceId: guo4a5u7YAHhjXrMK0g4
                  _links:
                    activate:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/lifecycle/activate
                      hints:
                        allow:
                          - POST
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4
                      hints:
                        allow:
                          - GET
                          - PATCH
                          - PUT
                    users:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/users
                      hints:
                        allow:
                          - GET
                  _embedded:
                    users: []
                - id: guo4a5u7YAHhjXrMK0g5
                  status: ACTIVE
                  created: '2023-06-21T23:24:02.000Z'
                  lastUpdated: '2023-06-21T23:24:02.000Z'
                  profile:
                    displayName: Example Device name 2
                    platform: ANDROID
                    manufacturer: Google
                    model: Pixel 6
                    osVersion: 13:2023-05-05
                    registered: true
                    secureHardwarePresent: true
                    diskEncryptionType: USER
                  resourceType: UDDevice
                  resourceDisplayName:
                    value: Example Device name 2
                    sensitive: false
                  resourceAlternateId: null
                  resourceId: guo4a5u7YAHhjXrMK0g5
                  _links:
                    activate:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/lifecycle/activate
                      hints:
                        allow:
                          - POST
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5
                      hints:
                        allow:
                          - GET
                          - PATCH
                          - PUT
                    users:
                      href: >-
                        https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/users
                      hints:
                        allow:
                          - GET
                  _embedded:
                    users:
                      - managementStatus: MANAGED
                        created: '2021-10-01T16:52:41.000Z'
                        screenLockType: BIOMETRIC
                        user:
                          id: 00u17vh0q8ov8IU881d7
                          realmId: 00u17vh0q8ov8IU8T0g5
                          profile:
                            firstName: fname
                            lastName: lname
                            login: email@email.com
                            email: email@email.com
                          _links:
                            self:
                              href: >-
                                https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}:
    get:
      tags:
        - Devices
      summary: Retrieve a Device
      description: Retrieves a device by `deviceId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: guo8jx5vVoxfvJeLb0w4
                status: ACTIVE
                created: '2020-11-03T21:47:01.000Z'
                lastUpdated: '2020-11-03T23:46:27.000Z'
                profile:
                  displayName: DESKTOP-EHAD3IE
                  platform: WINDOWS
                  manufacturer: International Corp
                  model: VMware7,1
                  osVersion: 10.0.18362
                  serialNumber: 56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce
                  udid: 954F4D56-C574-E7D3-FC3A-579CC2F85DCE
                  sid: S-1-5-21-3992267483-1860856704-2413701314-500
                  registered: true
                  secureHardwarePresent: false
                  diskEncryptionType: NONE
                resourceId: guo8jx5vVoxfvJeLb0w4
                resourceDisplayName:
                  value: DESKTOP-EHAD3IE
                  sensitive: false
                resourceType: UDDevice
                resourceAlternateId: null
                _links:
                  suspend:
                    href: >-
                      https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend
                    hints:
                      allow:
                        - POST
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4
                    hints:
                      allow:
                        - GET
                        - PATCH
                        - PUT
                  users:
                    href: >-
                      https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users
                    hints:
                      allow:
                        - GET
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Devices
      summary: Delete a Device
      description: >-
        Deletes (permanently) a device by `deviceId` if it has a status of
        `DEACTIVATED`. You can transition the device to `DEACTIVATED` status
        using the [Deactivate a Device](#tag/Device/operation/deactivateDevice)
        endpoint.

        This request is destructive and deletes all of the profile data related
        to the device. Once deleted, device data can't be recovered. However,
        reenrollment creates a new device record.

        > **Note:** Attempts to delete a device that isn't in a `DEACTIVATED`
        state raise an error.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}/lifecycle/activate:
    post:
      tags:
        - Devices
      summary: Activate a Device
      description: |-
        Activates a Device by setting its status to ACTIVE by `deviceId`.
        Activated devices are used to create and delete Device user links.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}/lifecycle/deactivate:
    post:
      tags:
        - Devices
      summary: Deactivate a Device
      description: |-
        Deactivates a Device by setting its status to DEACTIVATED by `deviceId`.
        Deactivation causes a Device to lose all device user links.
        Set the Device status to DEACTIVATED before deleting it.
        > **Note:** When deactivating a Device, keep in mind the following:
          - Device deactivation is a destructive operation for device factors and client certificates. Device reenrollment using Okta Verify allows end users to set up new factors on the device.
          - Device deletion removes the device record from Okta. Reenrollment creates a new device record.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}/lifecycle/suspend:
    post:
      tags:
        - Devices
      summary: Suspend a Device
      description: >-
        Suspends a Device by setting its status to SUSPENDED.

        Use suspended devices to create and delete device user links.

        You can only unsuspend or deactivate suspended devices.

        > **Note:** SUSPENDED status is meant to be temporary, so it isn't
        destructive.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}/lifecycle/unsuspend:
    post:
      tags:
        - Devices
      summary: Unsuspend a Device
      description: |-
        Unsuspends a Device by returning its `status` to ACTIVE.
        >**Note:** Only devices with a SUSPENDED status can be unsuspended.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/devices/{deviceId}/users:
    get:
      tags:
        - Devices
      summary: List all Users for a Device
      description: Lists all Users for a Device by `deviceId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the device
          example: guo4a5u7JHHhjXrMK0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2021-08-20T17:13:35.000Z'
                  managementStatus: NOT_MANAGED
                  screenLockType: BIOMETRIC
                  user:
                    id: 00u17vh0q8ov8IU881d7
                    status: ACTIVE
                    created: '2021-08-20T16:08:25.000Z'
                    activated: null
                    statusChanged: '2021-08-20T16:39:41.000Z'
                    lastLogin: '2023-04-18T17:54:12.000Z'
                    lastUpdated: '2021-12-20T18:27:30.000Z'
                    passwordChanged: '2021-12-20T18:27:30.000Z'
                    type:
                      id: oty17vh0n2EHVnbYF1d7
                    profile:
                      firstName: Bunk
                      lastName: Moreland
                      mobilePhone: null
                      secondEmail: null
                      login: bunk.moreland@example.com
                      email: bunk.moreland@example.com
                    credentials:
                      password: null
                      provider:
                        type: OKTA
                        name: OKTA
                    _links:
                      suspend:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/suspend
                        method: POST
                      schema:
                        href: >-
                          https://{yourOktaDomain}/api/v1/meta/schemas/user/osc17vh0n2EHVnbYF1d7
                      resetPassword:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/reset_password
                        method: POST
                      forgotPassword:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/forgot_password
                        method: POST
                      expirePassword:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/expire_password
                        method: POST
                      changeRecoveryQuestion:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_recovery_question
                        method: POST
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7
                      resetFactors:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/reset_factors
                        method: POST
                      type:
                        href: >-
                          https://{yourOktaDomain}/api/v1/meta/types/user/oty17vh0n2EHVnbYF1d7
                      changePassword:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_password
                        method: POST
                      deactivate:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/deactivate
                        method: POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/device-assurances:
    get:
      tags:
        - Device Assurance Policies
      summary: List all Device Assurance Policies
      description: Lists all device assurance policies
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - createdBy: elit cul
                  createdDate: elit reprehenderit culpa esse officia
                  id: aliqua dolore do minim occaecat
                  lastUpdate: ''
                  lastUpdatedBy: sint esse voluptate
                  name: adipisicing
                  platform: ANDROID
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - createdBy: nostrud aute consectetur nisi
                  createdDate: officia eu exercitation sit ea
                  id: occaecat in ad labore
                  lastUpdate: tempor fugiat
                  lastUpdatedBy: Excepteur officia
                  name: Lorem minim Duis ut
                  platform: WINDOWS
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Device Assurance Policies
      summary: Create a Device Assurance Policy
      description: Creates a new Device Assurance Policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Device Assurance Android
                osVersion:
                  minimum: 12
                diskEncryptionType:
                  include:
                    - USER
                    - FULL
                jailbreak: false
                platform: ANDROID
                screenLockType:
                  include:
                    - BIOMETRIC
                secureHardwarePresent: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: dae3m8o4rWhwReDeM1c5
                name: Device Assurance Android
                lastUpdate: '2022-01-01T00:00:00.000Z'
                createdUpdate: '2022-01-01T00:00:00.000Z'
                lastUpdatedBy: 00u217pyf72CdUrBt1c5
                createdBy: 00u217pyf72CdUrBt1c5
                osVersion:
                  minimum: 12.4.5
                diskEncryptionType:
                  include:
                    - USER
                    - FULL
                jailbreak: false
                platform: ANDROID
                screenLockType:
                  include:
                    - BIOMETRIC
                secureHardwarePresent: true
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/device-assurances/{deviceAssuranceId}:
    get:
      tags:
        - Device Assurance Policies
      summary: Retrieve a Device Assurance Policy
      description: Retrieves a Device Assurance Policy by `deviceAssuranceId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceAssuranceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the Device Assurance Policy
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: dae3m8o4rWhwReDeM1c5
                name: Device Assurance Android
                lastUpdate: '2022-01-01T00:00:00.000Z'
                createdUpdate: '2022-01-01T00:00:00.000Z'
                lastUpdatedBy: 00u217pyf72CdUrBt1c5
                createdBy: 00u217pyf72CdUrBt1c5
                osVersion:
                  minimum: 12.4.5
                diskEncryptionType:
                  include:
                    - USER
                    - FULL
                jailbreak: false
                platform: ANDROID
                screenLockType:
                  include:
                    - BIOMETRIC
                secureHardwarePresent: true
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Device Assurance Policies
      summary: Replace a Device Assurance Policy
      description: Replaces a Device Assurance Policy by `deviceAssuranceId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Device Assurance Android
                osVersion:
                  minimum: 12
                diskEncryptionType:
                  include:
                    - USER
                    - FULL
                jailbreak: false
                platform: ANDROID
                screenLockType:
                  include:
                    - BIOMETRIC
                secureHardwarePresent: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceAssuranceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the Device Assurance Policy
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: dae3m8o4rWhwReDeM1c5
                name: Device Assurance Android
                lastUpdate: '2022-01-01T00:00:00.000Z'
                createdUpdate: '2022-01-01T00:00:00.000Z'
                lastUpdatedBy: 00u217pyf72CdUrBt1c5
                createdBy: 00u217pyf72CdUrBt1c5
                osVersion:
                  minimum: 12.4.5
                diskEncryptionType:
                  include:
                    - USER
                    - FULL
                jailbreak: false
                platform: ANDROID
                screenLockType:
                  include:
                    - BIOMETRIC
                secureHardwarePresent: true
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Device Assurance Policies
      summary: Delete a Device Assurance Policy
      description: >-
        Deletes a Device Assurance Policy by `deviceAssuranceId`. If the Device
        Assurance Policy is currently being used in the org Authentication
        Policies, the delete will not be allowed.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: deviceAssuranceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the Device Assurance Policy
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorSummary: Device assurance is in use and cannot be deleted.
                errorId: oaenwA1ra80S9W-pvbh4m6haA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-domains:
    get:
      tags:
        - Email Domains
      summary: List all Email Domains
      description: Lists all the Email Domains in your org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: brands,brands
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: OeD114iNkrcN6aR680g4
                validationStatus: NOT_STARTED
                displayName: Admin
                userName: admin
                domain: example.com
                validationSubdomain: mail
                dnsValidationRecords:
                  - recordType: TXT
                    fqdn: _oktaverification.example.com
                    verificationValue: 759080212bda43e3bc825a7d73b4bb64
                  - recordType: CNAME
                    fqdn: mail.example.com
                    verificationValue: u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t02._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t022._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Email Domains
      summary: Create an Email Domain
      description: Creates an Email Domain in your org
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                displayName: Admin
                userName: admin
                domain: example.com
                brandId: bnd100iSrkcN6aR680g1
                validationSubdomain: mail
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: brands,brands
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: OeD114iNkrcN6aR680g4
                validationStatus: NOT_STARTED
                displayName: Admin
                userName: admin
                domain: example.com
                validationSubdomain: mail
                dnsValidationRecords:
                  - recordType: TXT
                    fqdn: _oktaverification.example.com
                    verificationValue: 759080212bda43e3bc825a7d73b4bb64
                  - recordType: CNAME
                    fqdn: mail.example.com
                    verificationValue: u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t02._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t022._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000197
                errorSummary: Email domain already exists.
                errorLink: E0000197
                errorId: oaeEdRqprFuTyKokyYPbURJkA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-domains/{emailDomainId}:
    get:
      tags:
        - Email Domains
      summary: Retrieve an Email Domain
      description: Retrieves an Email Domain by `emailDomainId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: brands,brands
        - name: emailDomainId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: ipsum minim anim
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: OeD114iNkrcN6aR680g4
                validationStatus: NOT_STARTED
                displayName: Admin
                userName: admin
                domain: example.com
                validationSubdomain: mail
                dnsValidationRecords:
                  - recordType: TXT
                    fqdn: _oktaverification.example.com
                    verificationValue: 759080212bda43e3bc825a7d73b4bb64
                  - recordType: CNAME
                    fqdn: mail.example.com
                    verificationValue: u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t02._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t022._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Email Domains
      summary: Replace an Email Domain
      description: Replaces associated username and sender display name by `emailDomainId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                displayName: IT Admin
                userName: noreply
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: brands,brands
        - name: emailDomainId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: ipsum minim anim
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: OeD114iNkrcN6aR680g4
                validationStatus: NOT_STARTED
                displayName: IT Admin
                userName: noreply
                domain: example.com
                validationSubdomain: mail
                dnsValidationRecords:
                  - recordType: TXT
                    fqdn: _oktaverification.example.com
                    verificationValue: 759080212bda43e3bc825a7d73b4bb64
                  - recordType: CNAME
                    fqdn: mail.example.com
                    verificationValue: u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t02._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t022._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Email Domains
      summary: Delete an Email Domain
      description: Deletes an Email Domain by `emailDomainId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: Specifies additional metadata to be included in the response
          example: brands,brands
        - name: emailDomainId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: ipsum minim anim
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000216
                errorSummary: >-
                  Email domain can't be deleted due to mail provider
                  restrictions.
                errorLink: E0000216
                errorId: oaeEdRqprFuTyKokyYPbURJkB
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-domains/{emailDomainId}/verify:
    post:
      tags:
        - Email Domains
      summary: Verify an Email Domain
      description: Verifies an Email Domain by `emailDomainId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: emailDomainId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: ipsum minim anim
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: OeD114iNkrcN6aR680g4
                validationStatus: VERIFIED
                displayName: IT Admin
                userName: noreply
                domain: example.com
                validationSubdomain: mail
                dnsValidationRecords:
                  - recordType: TXT
                    fqdn: _oktaverification.example.com
                    verificationValue: 759080212bda43e3bc825a7d73b4bb64
                  - recordType: CNAME
                    fqdn: mail.example.com
                    verificationValue: u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t02._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
                  - recordType: CNAME
                    fqdn: t022._domainkey.example.com
                    verificationValue: t02.domainkey.u22224444.wl024.sendgrid.net
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000218
                errorSummary: Email domain couldn't be verified by mail provider.
                errorLink: E0000218
                errorId: oaeEdRqprFuTyKokyYPbURJkC
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-servers:
    get:
      tags:
        - Email Servers
      summary: List all enrolled SMTP servers
      description: Lists all the enrolled custom SMTP server configurations
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                email-servers:
                  - value: '<Error: Too many levels of nesting to fake this schema>'
                  - value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Email Servers
      summary: Create a custom SMTP server
      description: Creates a custom email SMTP server configuration for your org
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                host:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                port:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                username:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                password:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                alias:
                  value: '<Error: Too many levels of nesting to fake this schema>'
                enabled:
                  value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alias: CustomServer1
                enabled: false
                host: 192.168.160.1
                port: 587
                username: aUser
                id: repre
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-servers/{emailServerId}:
    get:
      tags:
        - Email Servers
      summary: Retrieve an SMTP Server configuration
      description: Retrieves the specified custom SMTP server configuration
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: emailServerId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: nostrud tempor laboris
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                email-servers:
                  - value: '<Error: Too many levels of nesting to fake this schema>'
                  - value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    patch:
      tags:
        - Email Servers
      summary: Update an SMTP Server configuration
      description: Updates the specified custom SMTP server configuration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                alias: CustomServer1
                enabled: true
                host: 192.168.160.1
                port: 587
                username: aUser
                password: in aliqua enim sint
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: emailServerId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: nostrud tempor laboris
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alias: CustomServer1
                enabled: false
                host: 192.168.160.1
                port: 587
                username: aUser
                id: repre
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Email Servers
      summary: Delete an SMTP Server configuration
      description: Deletes the specified custom SMTP server configuration
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: emailServerId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: nostrud tempor laboris
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/email-servers/{emailServerId}/test:
    post:
      tags:
        - Email Servers
      summary: Test an SMTP Server configuration
      description: Tests the specified custom SMTP Server configuration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                from: sender@host.com
                to: receiver@host.com
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: emailServerId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: nostrud tempor laboris
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/eventHooks:
    get:
      tags:
        - Event Hooks
      summary: List all Event Hooks
      description: Lists all event hooks
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: who8tsqyrhCdmetzx135
                  status: ACTIVE
                  verificationStatus: VERIFIED
                  name: Event Hook Test
                  description: null
                  created: '2023-07-07T17:41:56.000Z'
                  createdBy: 00u7xut94qEWYx5ss1e5
                  lastUpdated: '2023-07-07T17:43:03.000Z'
                  events:
                    type: EVENT_TYPE
                    items:
                      - user.lifecycle.deactivate
                      - user.lifecycle.activate
                    filter: null
                  channel:
                    type: HTTP
                    version: 1.0.0
                    config:
                      uri: https://example_external_service/userDeactivate
                      headers: []
                      method: POST
                      authScheme:
                        type: HEADER
                        key: authorization
                  _links:
                    self:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135
                    verify:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135/lifecycle/verify
                      hints:
                        allow:
                          - POST
                    deactivate:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135/lifecycle/deactivate
                      hints:
                        allow:
                          - POST
                - id: who8vt36qfNpCGz9H1e6
                  status: ACTIVE
                  verificationStatus: VERIFIED
                  name: Event Hook with Filter
                  description: An event hook using an Okta Expression Language filter
                  created: '2023-07-07T13:41:56.000Z'
                  createdBy: 00u7xut94qEWYx5ss1e5
                  lastUpdated: '2023-07-07T13:43:03.000Z'
                  events:
                    type: EVENT_TYPE
                    items:
                      - group.user_membership.add
                    filter:
                      type: EXPRESSION_LANGUAGE
                      eventFilterMap:
                        - event: group.user_membership.add
                          condition:
                            version: null
                            expression: >-
                              event.target.?[type eq 'UserGroup'].size()>0 &&
                              event.target.?[displayName eq 'Sales'].size()>0
                  channel:
                    type: HTTP
                    version: 1.0.0
                    config:
                      uri: https://example_external_service/userAdded
                      headers: []
                      method: POST
                      authScheme:
                        type: HEADER
                        key: authorization
                  _links:
                    self:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                    verify:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                      hints:
                        allow:
                          - POST
                    deactivate:
                      href: >-
                        https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                      hints:
                        allow:
                          - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Event Hooks
      summary: Create an Event Hook
      description: >-
        Creates a new event hook for your organization in `ACTIVE` status. You
        pass an event hook object in the JSON payload

        of your request. That object represents the set of required information
        about the event hook you're registering, including:
          * The URI of your external service
          * The [events](https://developer.okta.com/docs/reference/api/event-types/) in Okta you want to subscribe to
          * An optional event hook filter that can reduce the number of event hook calls. This is a self-service Early Access (EA) feature.
            See [Create an event hook filter](https://developer.okta.com/docs/concepts/event-hooks/#create-an-event-hook-filter).

            Additionally, you can specify a secret API key for Okta to pass to your external service endpoint for security verification. Note that the API key you set here is unrelated to the Okta API token
        you must supply when making calls to Okta APIs. Optionally, you can
        specify extra headers that Okta passes to your external

        service with each call.

        Your external service must use a valid HTTPS endpoint.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Event Hook Test
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    authScheme:
                      type: HEADER
                      key: Authorization
                      value: my-shared-secret
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: ACTIVE
                verificationStatus: VERIFIED
                name: Event Hook Test
                description: null
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter: null
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/eventHooks/{eventHookId}:
    get:
      tags:
        - Event Hooks
      summary: Retrieve an Event Hook
      description: Retrieves an event hook
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: ACTIVE
                verificationStatus: VERIFIED
                name: Event Hook Test
                description: null
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter: null
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Event Hooks
      summary: Replace an Event Hook
      description: >-
        Replaces an event hook. Okta validates the new properties before
        replacing the existing values.

        Some event hook properties are immutable and can't be updated. Refer to
        the parameter description in the request body schema.


        >**Note:** Updating the `channel` property requires you to verify the
        hook again.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Event Hook with Filter
                description: An event hook using an Okta Expression Language filter
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter:
                    type: EXPRESSION_LANGUAGE
                    eventFilterMap:
                      - event: group.user_membership.add
                        condition:
                          expression: >-
                            event.target.?[type eq 'UserGroup'].size()>0 &&
                            event.target.?[displayName eq 'Sales'].size()>0
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    authScheme:
                      type: HEADER
                      key: Authorization
                      value: my-shared-secret
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: ACTIVE
                verificationStatus: VERIFIED
                name: Event Hook with Filter
                description: An event hook using an Okta Expression Language filter
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter:
                    type: EXPRESSION_LANGUAGE
                    eventFilterMap:
                      - event: group.user_membership.add
                        condition:
                          version: null
                          expression: >-
                            event.target.?[type eq 'UserGroup'].size()>0 &&
                            event.target.?[displayName eq 'Sales'].size()>0
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                  hints:
                    allow:
                      - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Event Hooks
      summary: Delete an Event Hook
      description: >-
        Deletes the event hook that matches the provided `id`. After deletion,
        the event hook is unrecoverable.

        As a safety precaution, you can only delete event hooks with a status of
        `INACTIVE`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/eventHooks/{eventHookId}/lifecycle/activate:
    post:
      tags:
        - Event Hooks
      summary: Activate an Event Hook
      description: Activates the event hook that matches the provided `id`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: ACTIVE
                verificationStatus: VERIFIED
                name: Event Hook Test
                description: null
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter: null
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate:
    post:
      tags:
        - Event Hooks
      summary: Deactivate an Event Hook
      description: Deactivates the event hook that matches the provided `id`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: INACTIVE
                verificationStatus: VERIFIED
                name: Event Hook Test
                description: null
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter: null
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/eventHooks/{eventHookId}/lifecycle/verify:
    post:
      tags:
        - Event Hooks
      summary: Verify an Event Hook
      description: >-
        Verifies that the event hook matches the provided `eventHookId`. To
        verify ownership, your endpoint must send information back to Okta in
        JSON format. See [Event
        hooks](https://developer.okta.com/docs/concepts/event-hooks/#one-time-verification-request).


        Only `ACTIVE` and `VERIFIED` event hooks can receive events from Okta.


        If a response is not received within 3 seconds, the outbound request
        times out. One retry is attempted after a timeout or error response.

        If a successful response still isn't received, this operation returns a
        400 error with more information about the failure.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: eventHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Event Hook
          example: who8vt36qfNpCGz9H1e6
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: who8vt36qfNpCGz9H1e6
                status: ACTIVE
                verificationStatus: VERIFIED
                name: Event Hook Test
                description: null
                created: '2023-07-07T13:41:56.000Z'
                createdBy: 00u7xut94qEWYx5ss1e5
                lastUpdated: '2023-07-07T13:43:03.000Z'
                events:
                  type: EVENT_TYPE
                  items:
                    - group.user_membership.add
                  filter: null
                channel:
                  type: HTTP
                  version: 1.0.0
                  config:
                    uri: https://example_external_service/userAdded
                    headers:
                      - key: X-Other-Header
                        value: my-header-value
                    method: POST
                    authScheme:
                      type: HEADER
                      key: authorization
                _links:
                  self:
                    href: https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6
                  verify:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify
                    hints:
                      allow:
                        - POST
                  deactivate:
                    href: >-
                      https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/features:
    get:
      tags:
        - Features
      summary: List all Features
      description: Lists all self-service features for your org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: ftrZooGoT8b41iWRiQs7
                  description: Example feature description
                  name: Example feature name
                  stage:
                    state: CLOSED
                    value: BETA
                  status: DISABLED
                  type: self-service
                  _links:
                    self:
                      hints:
                        allow:
                          - POST
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7
                    dependents:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents
                    dependencies:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/features/{featureId}:
    get:
      tags:
        - Features
      summary: Retrieve a Feature
      description: Retrieves a feature by ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: featureId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the feature
          example: R5HjqNn1pEqWGy48E9jg
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ftrZooGoT8b41iWRiQs7
                description: Example feature description
                name: Example feature name
                stage:
                  state: CLOSED
                  value: BETA
                status: DISABLED
                type: self-service
                _links:
                  self:
                    hints:
                      allow:
                        - POST
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7
                  dependents:
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents
                  dependencies:
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/features/{featureId}/dependencies:
    get:
      tags:
        - Features
      summary: List all dependencies
      description: >-
        Lists all feature dependencies for a specified feature.


        A feature's dependencies are the features that it requires to be enabled
        in order for itself to be enabled.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: featureId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the feature
          example: R5HjqNn1pEqWGy48E9jg
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: ftrZooGoT8b41iWRiQs7
                  description: Example feature description
                  name: Example feature name
                  stage:
                    state: OPEN
                    value: EA
                  status: ENABLED
                  type: self-service
                  _links:
                    self:
                      hints:
                        allow:
                          - POST
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7
                    dependents:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents
                    dependencies:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/features/{featureId}/dependents:
    get:
      tags:
        - Features
      summary: List all dependents
      description: >-
        Lists all feature dependents for the specified feature.


        A feature's dependents are the features that need to be disabled in
        order for the feature itself to be disabled.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: featureId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the feature
          example: R5HjqNn1pEqWGy48E9jg
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: ftrZooGoT8b41iWRiQs7
                  description: Example feature description
                  name: Example feature name
                  stage:
                    state: OPEN
                    value: EA
                  status: ENABLED
                  type: self-service
                  _links:
                    self:
                      hints:
                        allow:
                          - POST
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7
                    dependents:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents
                    dependencies:
                      href: >-
                        https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/features/{featureId}/{lifecycle}:
    post:
      tags:
        - Features
      summary: Update a Feature lifecycle
      description: >-
        Updates a feature's lifecycle status. Use this endpoint to enable or
        disable a feature for your org.


        Use the `mode=force` parameter to override dependency restrictions for a
        particular feature. Normally, you can't enable a feature if it has one
        or more dependencies that aren't enabled.


        When you use the `mode=force` parameter while enabling a feature, Okta
        first tries to enable any disabled features that this feature may have
        as dependencies. If you don't pass the `mode=force` parameter and the
        feature has dependencies that need to be enabled before the feature is
        enabled, a 400 error is returned.


        When you use the `mode=force` parameter while disabling a feature, Okta
        first tries to disable any enabled features that this feature may have
        as dependents. If you don't pass the `mode=force` parameter and the
        feature has dependents that need to be disabled before the feature is
        disabled, a 400 error is returned.


        The following chart shows the different state transitions for a feature.


        ![State transitions of a
        feature](../../../../../images/features/update-ssfeat-flowchart.png
        '#width=500px;')
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: mode
          in: query
          schema:
            type: string
          description: >-
            Indicates if you want to force enable or disable a feature.
            Supported value is `force`.
          example: mollit occaecat cupidatat
        - name: featureId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the feature
          example: R5HjqNn1pEqWGy48E9jg
        - name: lifecycle
          in: path
          schema:
            type: string
          required: true
          description: (Required) Whether to `ENABLE` or `DISABLE` the feature
          example: ENABLE
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                description: Example feature description
                id: ftrZooGoT8b41iWRiQs7
                name: Example feature name
                stage:
                  state: OPEN
                  value: BETA
                status: DISABLED
                type: self-service
                _links:
                  self:
                    hints:
                      allow:
                        - POST
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7
                  dependents:
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents
                  dependencies:
                    href: >-
                      https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups:
    get:
      tags:
        - Groups
      summary: List all Groups
      description: >-
        Lists all groups with pagination support. A subset of groups can be
        returned that match a supported filter expression or query.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          description: Searches the name property of groups for matching value
          example: mollit occaecat cupidatat
        - name: filter
          in: query
          schema:
            type: string
          description: Filter expression for groups
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of groups
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of group results in a page
          example: '10000'
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            If specified, it causes additional metadata to be included in the
            response.
          example: mollit occaecat cupidatat
        - name: search
          in: query
          schema:
            type: string
          description: >-
            Searches for groups with a supported filtering expression for all
            attributes except for _embedded, _links, and objectClass
          example: mollit occaecat cupidatat
        - name: sortBy
          in: query
          schema:
            type: string
          description: >-
            Specifies field to sort by and can be any single property (for
            search queries only).
          example: lastUpdated
        - name: sortOrder
          in: query
          schema:
            type: string
          description: >-
            Specifies sort order `asc` or `desc` (for search queries only). This
            parameter is ignored if `sortBy` is not present.

            Groups with the same value for the `sortBy` parameter are ordered by
            `id`.
          example: asc
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1995-08-20T21:44:43.031Z'
                  id: enim ipsum Ut voluptate
                  lastMembershipUpdated: '2007-08-20T16:50:51.194Z'
                  lastUpdated: '1965-01-05T02:16:15.930Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: OKTA_GROUP
                  _embedded:
                    commodo_53:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2012-08-12T02:57:35.257Z'
                  id: non voluptate
                  lastMembershipUpdated: '1984-07-17T11:29:04.203Z'
                  lastUpdated: '1954-12-04T04:48:25.373Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ea_0: -16626924
                    ut_ba: -66191779.46507646
                  type: OKTA_GROUP
                  _embedded:
                    enim_52:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deserunt_a:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Groups
      summary: Create a Group
      description: Creates a new group with `OKTA_GROUP` type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                profile:
                  description: sunt laborum dolor elit
                  name: sed esse tempor
                  nisi_ad: false
                type: OKTA_GROUP
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-10-30T11:30:21.562Z'
                id: ut in in
                lastMembershipUpdated: '2016-03-14T20:11:12.079Z'
                lastUpdated: '1997-11-15T07:07:25.270Z'
                objectClass:
                  - reprehenderit Lorem
                  - officia aliquip
                profile:
                  description: voluptate consec
                  name: qui laborum
                  quis4: voluptate
                  ex_2eb: false
                type: APP_GROUP
                _embedded:
                  tempor_d: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  apps:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  source:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/rules:
    get:
      tags:
        - Groups
      summary: List all Group Rules
      description: Lists all group rules
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of rule results in a page
          example: '50'
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of rules
          example: mollit occaecat cupidatat
        - name: search
          in: query
          schema:
            type: string
          description: Specifies the keyword to search fules for
          example: mollit occaecat cupidatat
        - name: expand
          in: query
          schema:
            type: string
          description: If specified as `groupIdToGroupNameMap`, then show group names
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - actions:
                    assignUserToGroups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    expression:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    people:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1947-10-22T14:16:04.685Z'
                  id: ut dolor laboris sed
                  lastUpdated: '1973-08-11T04:08:31.363Z'
                  name: consectetur cillum incididunt Ut
                  status: ACTIVE
                  type: reprehenderit in amet fugia
                - actions:
                    assignUserToGroups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    expression:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    people:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1989-05-07T18:20:00.790Z'
                  id: velit
                  lastUpdated: '1962-04-04T13:02:07.375Z'
                  name: nisi
                  status: INVALID
                  type: Lorem velit consectetur ea qui
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Groups
      summary: Create a Group Rule
      description: >-
        Creates a group rule to dynamically add users to the specified group if
        they match the condition
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                actions:
                  assignUserToGroups:
                    groupIds:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  expression:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                name: nisi ipsum eiusmod
                status: INACTIVE
                type: do ut laboris aliqua
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                actions:
                  assignUserToGroups:
                    groupIds:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  expression:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                created: '1946-06-03T06:02:58.857Z'
                id: fugiat officia aliqua
                lastUpdated: '2003-03-27T07:35:16.100Z'
                name: eu lab
                status: INACTIVE
                type: culpa exercitation sed
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/rules/{groupRuleId}:
    get:
      tags:
        - Groups
      summary: Retrieve a Group Rule
      description: Retrieves a specific group rule by `groupRuleId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: groupRuleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group rule
          example: 0pr3f7zMZZHPgUoWO0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                actions:
                  assignUserToGroups:
                    groupIds:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  expression:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                created: '1946-06-03T06:02:58.857Z'
                id: fugiat officia aliqua
                lastUpdated: '2003-03-27T07:35:16.100Z'
                name: eu lab
                status: INACTIVE
                type: culpa exercitation sed
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Groups
      summary: Replace a Group Rule
      description: Replaces a group rule. Only `INACTIVE` rules can be updated.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                actions:
                  assignUserToGroups:
                    groupIds:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  expression:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                name: nisi ipsum eiusmod
                status: INACTIVE
                type: do ut laboris aliqua
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupRuleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group rule
          example: 0pr3f7zMZZHPgUoWO0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                actions:
                  assignUserToGroups:
                    groupIds:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                conditions:
                  expression:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  people:
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                created: '1946-06-03T06:02:58.857Z'
                id: fugiat officia aliqua
                lastUpdated: '2003-03-27T07:35:16.100Z'
                name: eu lab
                status: INACTIVE
                type: culpa exercitation sed
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Groups
      summary: Delete a group Rule
      description: Deletes a specific group rule by `groupRuleId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: removeUsers
          in: query
          schema:
            type: boolean
          description: >-
            Indicates whether to keep or remove users from groups assigned by
            this rule.
          example: 'true'
        - name: groupRuleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group rule
          example: 0pr3f7zMZZHPgUoWO0g4
      responses:
        '202':
          description: Accepted
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/rules/{groupRuleId}/lifecycle/activate:
    post:
      tags:
        - Groups
      summary: Activate a Group Rule
      description: Activates a specific group rule by `groupRuleId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupRuleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group rule
          example: 0pr3f7zMZZHPgUoWO0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate:
    post:
      tags:
        - Groups
      summary: Deactivate a Group Rule
      description: Deactivates a specific group rule by `groupRuleId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupRuleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group rule
          example: 0pr3f7zMZZHPgUoWO0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}:
    get:
      tags:
        - Groups
      summary: Retrieve a Group
      description: Retrieves a group by `groupId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-10-30T11:30:21.562Z'
                id: ut in in
                lastMembershipUpdated: '2016-03-14T20:11:12.079Z'
                lastUpdated: '1997-11-15T07:07:25.270Z'
                objectClass:
                  - reprehenderit Lorem
                  - officia aliquip
                profile:
                  description: voluptate consec
                  name: qui laborum
                  quis4: voluptate
                  ex_2eb: false
                type: APP_GROUP
                _embedded:
                  tempor_d: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  apps:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  source:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Groups
      summary: Replace a Group
      description: Replaces the profile for a group with `OKTA_GROUP` type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                profile:
                  description: sunt laborum dolor elit
                  name: sed esse tempor
                  nisi_ad: false
                type: OKTA_GROUP
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2005-10-30T11:30:21.562Z'
                id: ut in in
                lastMembershipUpdated: '2016-03-14T20:11:12.079Z'
                lastUpdated: '1997-11-15T07:07:25.270Z'
                objectClass:
                  - reprehenderit Lorem
                  - officia aliquip
                profile:
                  description: voluptate consec
                  name: qui laborum
                  quis4: voluptate
                  ex_2eb: false
                type: APP_GROUP
                _embedded:
                  tempor_d: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  apps:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  logo:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  source:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  users:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Groups
      summary: Delete a Group
      description: Deletes a group with `OKTA_GROUP` type
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/apps:
    get:
      tags:
        - Groups
      summary: List all Assigned Applications
      description: Lists all applications that are assigned to a group
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of apps
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of app results for a page
          example: '20'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1951-12-07T03:04:53.719Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: et amet Ut sunt consequat
                  label: consectetur eu dolor
                  lastUpdated: '1976-01-05T02:25:24.470Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    autea:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    et3:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: SAML_2_0
                  status: DELETED
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    ipsum_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    cillum_69:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolor3:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1980-09-12T22:59:05.849Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: occaecat sunt commod
                  label: dolor
                  lastUpdated: '1956-01-27T04:10:23.472Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    ad1d5:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    adipisicing_cc6:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: WS_FEDERATION
                  status: INACTIVE
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    aliquip7a0:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/owners:
    get:
      tags:
        - Groups
      summary: List all Group Owners
      description: Lists all owners for a specific group
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: filter
          in: query
          schema:
            type: string
          description: >-
            SCIM Filter expression for group owners. Allows to filter owners by
            type.
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of owners
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of owner results in a page
          example: '1000'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 00g1gae1k0znUcLuU0h8
                  type: GROUP
                  resolved: true
                  originId: 'null'
                  originType: OKTA_DIRECTORY
                  displayName: Product & Engineering
                  lastUpdated: '2023-03-29 18:18:37.0'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Groups
      summary: Assign a Group Owner
      description: Assigns a group owner
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: 00u1cmc03xjzePoWD0h8
                type: USER
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 00u1cmc03xjzePoWD0h8
                type: USER
                resolved: true
                originId: null
                originType: OKTA_DIRECTORY
                displayName: Oliver Putnam
                lastUpdated: Wed Mar 29 18:34:31 UTC 2023
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/owners/{ownerId}:
    delete:
      tags:
        - Groups
      summary: Delete a Group Owner
      description: Deletes a group owner from a specific group
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: ownerId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group owner
          example: 00u1emaK22TWRYd3TtG
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/users:
    get:
      tags:
        - Groups
      summary: List all Member Users
      description: Lists all users that are a member of a group
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of users
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of user results in a page
          example: '1000'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - activated: '1944-03-08T15:14:28.981Z'
                  created: '2001-02-08T13:01:50.948Z'
                  credentials:
                    password:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    provider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recovery_question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: labore
                  lastLogin: '1999-03-11T06:19:50.494Z'
                  lastUpdated: '1982-10-27T20:19:38.586Z'
                  passwordChanged: '1961-10-28T12:38:46.199Z'
                  profile:
                    city:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    costCenter:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    countryCode:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    department:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    displayName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    division:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    email:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    employeeNumber:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    firstName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    honorificPrefix:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    honorificSuffix:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    locale:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    login:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    manager:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    managerId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    middleName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    mobilePhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    nickName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    organization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    postalAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    preferredLanguage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    primaryPhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    profileUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    secondEmail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    state:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    streetAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    timezone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    zipCode:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: PROVISIONED
                  statusChanged: '1973-01-02T06:54:50.237Z'
                  transitioningToStatus: ACTIVE
                  type:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    enim_90:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - activated: '2012-07-29T23:50:32.353Z'
                  created: '1976-06-05T17:21:59.024Z'
                  credentials:
                    password:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    provider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    recovery_question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: consequat elit reprehenderit
                  lastLogin: '1946-07-28T12:49:57.239Z'
                  lastUpdated: '1948-10-22T02:04:09.828Z'
                  passwordChanged: '1954-08-04T03:17:27.777Z'
                  profile:
                    city:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    costCenter:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    countryCode:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    department:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    displayName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    division:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    email:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    employeeNumber:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    firstName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    honorificPrefix:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    honorificSuffix:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    locale:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    login:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    manager:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    managerId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    middleName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    mobilePhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    nickName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    organization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    postalAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    preferredLanguage:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    primaryPhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    profileUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    secondEmail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    state:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    streetAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    timezone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    zipCode:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: PROVISIONED
                  statusChanged: '1984-01-11T13:55:40.224Z'
                  transitioningToStatus: ACTIVE
                  type:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    laborum_b__:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sed_e:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    minim_70:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/users/{userId}:
    put:
      tags:
        - Groups
      summary: Assign a User
      description: Assigns a user to a group with 'OKTA_GROUP' type
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Groups
      summary: Unassign a User
      description: Unassigns a user from a group with 'OKTA_GROUP' type
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/hook-keys:
    get:
      tags:
        - Hook Keys
      summary: List all keys
      description: Lists all keys
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: HKY1i2htmXF5UNQhL0g4
                  keyId: bb5bed7d-6e4d-488f-9c86-59b93a2bb3fb
                  name: My new key
                  created: '2022-08-22T16:34:33.000Z'
                  lastUpdated: '2022-08-22T16:34:33.000Z'
                  isUsed: 'true'
                - id: HKY1p7jWLndGQV9M60g4
                  keyId: 7fbc27fd-e3df-4522-86bf-1930110256ad
                  name: Test key
                  created: '2022-08-31T18:09:58.000Z'
                  lastUpdated: '2022-08-31T18:09:58.000Z'
                  isUsed: 'false'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Hook Keys
      summary: Create a key
      description: >
        Creates a key for use with other parts of the application, such as
        inline hooks


        Use the key name to access this key for inline hook operations.


        The total number of keys that you can create in an Okta org is limited
        to 50.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: ipsum Lorem ut ex labore
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: HKY1p7jWLndGQV9M60g4
                keyId: 7fbc27fd-e3df-4522-86bf-1930110256ad
                name: My new key
                created: '2022-08-31T18:09:58.000Z'
                lastUpdated: '2022-08-31T18:09:58.000Z'
                isUsed: 'false'
                _embedded:
                  kty: RSA
                  alg: RSA
                  kid: 7fbc27fd-e3df-4522-86bf-1930110256ad
                  use: 'null'
                  e: AQAB
                  'n': >-
                    2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/hook-keys/public/{publicKeyId}:
    get:
      tags:
        - Hook Keys
      summary: Retrieve a public key
      description: Retrieves a public key by `keyId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: publicKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Public Key
          example: FcH2P9Eg7wr0o8N2FuV0
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                _embedded:
                  kty: RSA
                  alg: RSA
                  kid: 7fbc27fd-e3df-4522-86bf-1930110256ad
                  use: null
                  e: AQAB
                  'n': >-
                    2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/hook-keys/{hookKeyId}:
    get:
      tags:
        - Hook Keys
      summary: Retrieve a key
      description: Retrieves a key by `hookKeyId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: hookKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Hook Key
          example: XreKU5laGwBkjOTehusG
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2002-08-15T02:04:58.392Z'
                id: amet exercitation mollit
                isUsed: aute aliquip exercitation ullamco
                keyId: proident nulla
                lastUpdated: '1981-07-24T00:19:33.392Z'
                name: aute cillum
                _embedded:
                  alg: quis
                  created: '1998-06-22T22:41:08.794Z'
                  e: id aute et ex esse
                  expiresAt: '1961-03-27T05:42:38.874Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: esse
                  kty: qui aute in
                  lastUpdated: '1982-05-20T14:09:17.827Z'
                  'n': u
                  status: dolor dolore aliqua sit
                  use: ex
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: et reprehenderit occaecat
                  x5t#S256: ex ipsum Excepteur
                  x5u: nisi sint anim aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Hook Keys
      summary: Replace a key
      description: >
        Replaces a key by `hookKeyId`


        This request replaces existing properties after passing validation.


        Note: The only parameter that you can update is the name of the key,
        which must be unique at all times.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: ipsum Lorem ut ex labore
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: hookKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Hook Key
          example: XreKU5laGwBkjOTehusG
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1951-09-08T00:45:35.447Z'
                id: in elit
                isUsed: in Duis consequat dolore
                keyId: et ex dolor in
                lastUpdated: '1966-07-15T11:52:10.508Z'
                name: non ad in
                _embedded:
                  alg: Excepteur
                  created: '2006-03-14T00:48:35.908Z'
                  e: in eiusmod aliquip
                  expiresAt: '1970-04-12T21:35:09.837Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: u
                  kty: incididunt Lorem adipisicing cupidatat reprehenderit
                  lastUpdated: '1959-02-12T06:17:47.140Z'
                  'n': sit aute nostrud
                  status: incididunt irure mollit aute
                  use: Exce
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: consequat labore
                  x5t#S256: laborum occaecat irure
                  x5u: labore nulla tempor sunt sed
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Hook Keys
      summary: Delete a key
      description: >
        Deletes a key by `hookKeyId`. After being deleted, the key is
        unrecoverable.


        As a safety precaution, only keys that aren't being used are eligible
        for deletion.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: hookKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Hook Key
          example: XreKU5laGwBkjOTehusG
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps:
    get:
      tags:
        - Identity Providers
      summary: List all Identity Providers
      description: >-
        Lists all identity provider integrations with pagination. A subset of
        IdPs can be returned that match a supported filter expression or query.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          description: Searches the name property of IdPs for matching value
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of IdPs
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of IdP results in a page
          example: '20'
        - name: type
          in: query
          schema:
            type: string
          description: Filters IdPs by type
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1973-05-09T13:38:42.636Z'
                  id: incididunt occaecat proident
                  issuerMode: CUSTOM_URL
                  lastUpdated: '1989-12-05T21:32:46.810Z'
                  name: enim fugiat qui ipsum
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  properties:
                    additionalAmr:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  protocol:
                    algorithms:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentials:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    endpoints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    relayState:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    settings:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  type: IWA
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2020-06-12T14:31:19.369Z'
                  id: est tempor culpa labore sint
                  issuerMode: DYNAMIC
                  lastUpdated: '1996-07-24T07:46:25.934Z'
                  name: commodo
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  properties:
                    additionalAmr:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  protocol:
                    algorithms:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentials:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    endpoints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    relayState:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    settings:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  type: LINKEDIN
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Identity Providers
      summary: Create an Identity Provider
      description: Creates a new identity provider integration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                issuerMode: DYNAMIC
                name: et occaec
                policy:
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: SAML2
                status: INACTIVE
                type: OIDC
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2020-04-23T23:20:21.293Z'
                id: non do
                issuerMode: ORG_URL
                lastUpdated: '1980-11-19T02:25:47.027Z'
                name: aliqua minim
                policy:
                  created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: ACTIVE
                type: OKTA
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/credentials/keys:
    get:
      tags:
        - Identity Providers
      summary: List all Credential Keys
      description: Lists all IdP key credentials
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of keys
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of key results in a page
          example: '20'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - alg: sed nostrud qui ad
                  created: '1990-08-03T06:59:34.202Z'
                  e: non cu
                  expiresAt: '2010-12-08T05:44:10.019Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: non dolore sed eu
                  kty: amet sit aliqua
                  lastUpdated: '1965-12-28T14:17:29.686Z'
                  'n': laborum deserunt
                  status: Ut Lorem amet
                  use: velit non
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: ex commodo
                  x5t#S256: culpa in
                  x5u: venia
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - alg: ullamco ipsum incididunt
                  created: '2012-03-24T02:50:39.296Z'
                  e: Lorem aute ipsum occaecat dolor
                  expiresAt: '2002-04-17T23:03:03.843Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: mollit dolore ut
                  kty: nisi aute fugiat
                  lastUpdated: '1970-06-03T20:15:30.601Z'
                  'n': ex consectetur
                  status: voluptate incididunt ea
                  use: sit laborum ullamco
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: eiusmod aute ut Duis
                  x5t#S256: aute proident magna ex
                  x5u: et proident
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Identity Providers
      summary: Create an X.509 Certificate Public Key
      description: Creates a new X.509 certificate credential to the IdP key store.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                alg: elit incididunt in lab
                key_ops:
                  - sed voluptate nostrud in
                  - do labore
                'n': cillum quis ex
                status: deseru
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/credentials/keys/{idpKeyId}:
    get:
      tags:
        - Identity Providers
      summary: Retrieve an Credential Key
      description: Retrieves a specific IdP Key Credential by `kid`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP Key
          example: KmMo85SSsU7TZzOShcGb
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Identity Providers
      summary: Delete a Signing Credential Key
      description: >-
        Deletes a specific IdP Key Credential by `kid` if it is not currently
        being used by an Active or Inactive IdP
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP Key
          example: KmMo85SSsU7TZzOShcGb
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}:
    get:
      tags:
        - Identity Providers
      summary: Retrieve an Identity Provider
      description: Retrieves an identity provider integration by `idpId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2020-04-23T23:20:21.293Z'
                id: non do
                issuerMode: ORG_URL
                lastUpdated: '1980-11-19T02:25:47.027Z'
                name: aliqua minim
                policy:
                  created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: ACTIVE
                type: OKTA
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Identity Providers
      summary: Replace an Identity Provider
      description: Replaces an identity provider integration by `idpId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                issuerMode: ORG_URL
                name: et do irure
                policy:
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: INACTIVE
                type: AgentlessDSSO
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2020-04-23T23:20:21.293Z'
                id: non do
                issuerMode: ORG_URL
                lastUpdated: '1980-11-19T02:25:47.027Z'
                name: aliqua minim
                policy:
                  created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: ACTIVE
                type: OKTA
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Identity Providers
      summary: Delete an Identity Provider
      description: Deletes an identity provider integration by `idpId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/csrs:
    get:
      tags:
        - Identity Providers
      summary: List all Certificate Signing Requests
      description: Lists all Certificate Signing Requests for an IdP
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2012-07-21T16:40:33.566Z'
                  csr: laborum ut aliquip
                  id: reprehenderit id incididunt dolore commodo
                  kty: labore commodo labor
                - created: '1955-08-01T22:28:28.383Z'
                  csr: sit veniam
                  id: id sed non incididunt
                  kty: deserunt mollit Duis enim culpa
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Identity Providers
      summary: Generate a Certificate Signing Request
      description: >-
        Generates a new key pair and returns a Certificate Signing Request for
        it
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                subject:
                  commonName: non incididunt
                  countryName: aute do Duis
                  localityName: ut
                  organizationalUnitName: nostrud voluptate eiusmod
                  organizationName: nulla exercitation c
                  stateOrProvinceName: adipisicing eu officia
                subjectAltNames:
                  dnsNames:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1965-02-16T08:36:23.841Z'
                csr: veniam in nisi magna ipsum
                id: ut ex adipisicing
                kty: ullamco voluptate
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}:
    get:
      tags:
        - Identity Providers
      summary: Retrieve a Certificate Signing Request
      description: Retrieves a specific Certificate Signing Request model by id
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: idpCsrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the IdP CSR
          example: 1uEhyE65oV3H6KM9gYcN
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1965-02-16T08:36:23.841Z'
                csr: veniam in nisi magna ipsum
                id: ut ex adipisicing
                kty: ullamco voluptate
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Identity Providers
      summary: Revoke a Certificate Signing Request
      description: >-
        Revokes a certificate signing request and deletes the key pair from the
        IdP
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: idpCsrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the IdP CSR
          example: 1uEhyE65oV3H6KM9gYcN
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish:
    post:
      tags:
        - Identity Providers
      summary: Publish a Certificate Signing Request
      description: >-
        Publishes a certificate signing request with a signed X.509 certificate
        and adds it into the signing key credentials for the IdP
      requestBody:
        content:
          text/plain: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-x509-ca-cert
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: idpCsrId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the IdP CSR
          example: 1uEhyE65oV3H6KM9gYcN
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/keys:
    get:
      tags:
        - Identity Providers
      summary: List all Signing Credential Keys
      description: Lists all signing key credentials for an IdP
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - alg: veniam anim proident in
                  created: '1987-05-28T09:19:57.006Z'
                  e: sunt Excepteur commodo et
                  expiresAt: '1966-09-22T19:48:59.232Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: consectetur ut culpa
                  kty: elit pariatur ipsum
                  lastUpdated: '2012-11-14T11:23:59.664Z'
                  'n': Lorem
                  status: eu amet ut ut
                  use: sunt esse minim ad
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: in Ut
                  x5t#S256: irure exercitation
                  x5u: sunt dolore fugiat cupidatat
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - alg: culpa elit aliquip
                  created: '2009-07-25T19:02:30.973Z'
                  e: aute laboris mollit
                  expiresAt: '1992-08-06T04:23:52.783Z'
                  key_ops:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  kid: dolor proident
                  kty: enim exercitation dolore commodo
                  lastUpdated: '2003-02-11T03:15:07.846Z'
                  'n': dolore ut
                  status: labore eu
                  use: ullamco magna minim ea
                  x5c:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  x5t: nulla ullam
                  x5t#S256: enim dolore est
                  x5u: id in dolor ut aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/keys/generate:
    post:
      tags:
        - Identity Providers
      summary: Generate a new Signing Credential Key
      description: >-
        Generates a new X.509 certificate for an IdP signing key credential to
        be used for signing assertions sent to the IdP
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: validityYears
          in: query
          schema:
            type: integer
          description: (Required) expiry of the IdP Key Credential
          example: '79905859'
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/keys/{idpKeyId}:
    get:
      tags:
        - Identity Providers
      summary: Retrieve a Signing Credential Key
      description: Retrieves a specific IdP Key Credential by `kid`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: idpKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP Key
          example: KmMo85SSsU7TZzOShcGb
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/credentials/keys/{idpKeyId}/clone:
    post:
      tags:
        - Identity Providers
      summary: Clone a Signing Credential Key
      description: >-
        Clones a X.509 certificate for an IdP signing key credential from a
        source IdP to target IdP
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: targetIdpId
          in: query
          schema:
            type: string
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: idpKeyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP Key
          example: KmMo85SSsU7TZzOShcGb
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                alg: quis sint do amet
                created: '1971-05-26T00:12:50.984Z'
                e: voluptate minim eu
                expiresAt: '1962-10-27T08:44:40.086Z'
                key_ops:
                  - eiusmod ipsum
                  - elit Duis
                kid: eiusmod
                kty: ea enim ad ani
                lastUpdated: '1964-01-24T06:18:32.885Z'
                'n': deserunt voluptate dolor aute exercitation
                status: dolor Lorem non cil
                use: laboris ut consequat
                x5c:
                  - esse in elit
                  - aute aliquip Excepteur consectetur
                x5t: sint
                x5t#S256: ad amet
                x5u: eiusmod
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/lifecycle/activate:
    post:
      tags:
        - Identity Providers
      summary: Activate an Identity Provider
      description: Activates an inactive IdP
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2020-04-23T23:20:21.293Z'
                id: non do
                issuerMode: ORG_URL
                lastUpdated: '1980-11-19T02:25:47.027Z'
                name: aliqua minim
                policy:
                  created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: ACTIVE
                type: OKTA
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/lifecycle/deactivate:
    post:
      tags:
        - Identity Providers
      summary: Deactivate an Identity Provider
      description: Deactivates an active IdP
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2020-04-23T23:20:21.293Z'
                id: non do
                issuerMode: ORG_URL
                lastUpdated: '1980-11-19T02:25:47.027Z'
                name: aliqua minim
                policy:
                  created:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  description:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastUpdated:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  name:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  priority:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  status:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  system:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  accountLink:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  conditions:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mapAMRClaims:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  maxClockSkew:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provisioning:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  subject:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                properties:
                  additionalAmr:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                protocol:
                  algorithms:
                    request:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    response:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  credentials:
                    client:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    signing:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    trust:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  endpoints:
                    acs:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authorization:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    jwks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    slo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sso:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    token:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userInfo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  issuer:
                    binding:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    destination:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    url:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  relayState:
                    format:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  settings:
                    nameFormat:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: MTLS
                status: ACTIVE
                type: OKTA
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/users:
    get:
      tags:
        - Identity Providers
      summary: List all Users
      description: Lists all users linked to the identity provider
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: culpa ullamco
                  externalId: non esse
                  id: dolor eiusmod
                  lastUpdated: do
                  profile:
                    officia_4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    sit_48:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    proident6e:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    in46:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    reprehenderit_f:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: do magna ex anim
                  externalId: est veniam in labore
                  id: ipsum adipisicing ut
                  lastUpdated: voluptate
                  profile:
                    velit_38:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    cillum_19f:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ut_15:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    aute_8:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolore7:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/users/{userId}:
    get:
      tags:
        - Identity Providers
      summary: Retrieve a User
      description: Retrieves a linked IdP user by ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: sed dolor tempor
                externalId: ut cillum sit do cupidatat
                id: nostrud nulla
                lastUpdated: labore incididunt sunt do
                profile:
                  consequatb: {}
                  Duis_3_: {}
                  reprehenderit_2: {}
                _embedded:
                  elit1: {}
                  pariaturb: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Identity Providers
      summary: Link a User to a Social IdP
      description: >-
        Links an Okta user to an existing Social Identity Provider. This does
        not support the SAML2 Identity Provider Type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                externalId: nisi
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: sed dolor tempor
                externalId: ut cillum sit do cupidatat
                id: nostrud nulla
                lastUpdated: labore incididunt sunt do
                profile:
                  consequatb: {}
                  Duis_3_: {}
                  reprehenderit_2: {}
                _embedded:
                  elit1: {}
                  pariaturb: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Identity Providers
      summary: Unlink a User from IdP
      description: Unlinks the link between the Okta user and the IdP user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/idps/{idpId}/users/{userId}/credentials/tokens:
    get:
      tags:
        - Identity Providers
      summary: List all Tokens from a OIDC Identity Provider
      description: >-
        Lists the tokens minted by the Social Authentication Provider when the
        user authenticates with Okta via Social Auth
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: idpId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of IdP
          example: SVHoAOh0l8cPQkVX1LRl
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - expiresAt: '1970-07-30T20:23:25.483Z'
                  id: ipsum non esse dolore
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  token: fugiat sint in
                  tokenAuthScheme: aliquip do
                  tokenType: in incididunt qui deserunt
                - expiresAt: '1962-12-04T19:07:44.620Z'
                  id: laboris occaecat anim Lorem
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  token: commodo nostrud
                  tokenAuthScheme: velit est officia in id
                  tokenType: in proident irure eu nisi
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/identity-sources/{identitySourceId}/sessions:
    get:
      tags:
        - Identity Sources
      summary: List all Identity Source Sessions
      description: >-
        Lists all identity source sessions for the given identity source
        instance
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: uij4ri8ZLk0ywyqxB0g1
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: CREATED
                  importType: INCREMENTAL
                  created: '2022-04-04T15:56:05.000Z'
                  lastUpdated: '2022-05-05T16:15:44.000Z'
                - id: uij4ri8ZLk0ywyqxB0g2
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: TRIGGERED
                  importType: INCREMENTAL
                  created: '2022-04-04T16:56:05.000Z'
                  lastUpdated: '2022-05-05T17:15:44.000Z'
                - id: uij4ri8ZLk0ywyqxB0g3
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: IN_PROGRESS
                  importType: INCREMENTAL
                  created: '2022-04-04T17:56:05.000Z'
                  lastUpdated: '2022-05-05T18:15:44.000Z'
                - id: uij4ri8ZLk0ywyqxB0g4
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: EXPIRED
                  importType: INCREMENTAL
                  created: '2022-04-04T18:56:05.000Z'
                  lastUpdated: '2022-05-05T19:15:44.000Z'
                - id: uij4ri8ZLk0ywyqxB0g5
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: CLOSED
                  importType: INCREMENTAL
                  created: '2022-04-04T19:56:05.000Z'
                  lastUpdated: '2022-05-05T20:15:44.000Z'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Identity Sources
      summary: Create an Identity Source Session
      description: >-
        Creates an identity source session for the given identity source
        instance
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: uij4ri8ZLk0ywyqxB0g1
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: CREATED
                  importType: INCREMENTAL
                  created: '2022-04-04T15:56:05.000Z'
                  lastUpdated: '2022-05-05T16:15:44.000Z'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}:
    get:
      tags:
        - Identity Sources
      summary: Retrieve an Identity Source Session
      description: >-
        Retrieves an identity source session for a given identity source id and
        session id
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: uij4ri8ZLk0ywyqxB0g1
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: CREATED
                  importType: INCREMENTAL
                  created: '2022-04-04T15:56:05.000Z'
                  lastUpdated: '2022-05-05T16:15:44.000Z'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Identity Sources
      summary: Delete an Identity Source Session
      description: >-
        Deletes an identity source session for a given `identitySourceId` and
        `sessionId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete:
    post:
      tags:
        - Identity Sources
      summary: Upload the data to be deleted in Okta
      description: >-
        Uploads entities that need to be deleted in Okta from the identity
        source for the given session
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                entityType: USERS
                profiles:
                  - externalId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - externalId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '202':
          description: Accepted
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert:
    post:
      tags:
        - Identity Sources
      summary: Upload the data to be upserted in Okta
      description: >-
        Uploads entities that need to be upserted in Okta from the identity
        source for the given session
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                entityType: USERS
                profiles:
                  - email:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    firstName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    homeAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    mobilePhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    secondEmail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - email:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    firstName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    homeAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    lastName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    mobilePhone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    secondEmail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    culpa_3d:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    consectetur_53:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    aliqua1:
                      value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '202':
          description: Accepted
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import:
    post:
      tags:
        - Identity Sources
      summary: Start the import from the Identity Source
      description: >-
        Starts the import from the identity source described by the uploaded
        bulk operations
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: identitySourceId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: uij4ri8ZLk0ywyqxB0g4
                  identitySourceId: 0oa3l6l6WK6h0R0QW0g4
                  status: TRIGGERED
                  importType: INCREMENTAL
                  created: '2022-04-04T15:56:05.000Z'
                  lastUpdated: '2022-05-05T18:15:44.000Z'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/inlineHooks:
    get:
      tags:
        - Inline Hooks
      summary: List all Inline Hooks
      description: Lists all inline hooks
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: type
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - channel:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1983-08-02T22:20:35.481Z'
                  id: quis
                  lastUpdated: '1970-08-03T11:03:20.370Z'
                  name: 'null'
                  status: ACTIVE
                  type: com.okta.user.credential.password.import
                  version: quis officia deserunt amet culpa
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - channel:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    version:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1973-12-28T16:39:35.152Z'
                  id: ullamco
                  lastUpdated: '1994-11-12T12:26:09.645Z'
                  name: dolor sed consequat
                  status: INACTIVE
                  type: com.okta.saml.tokens.transform
                  version: ea ad sint proident
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Inline Hooks
      summary: Create an Inline Hook
      description: Creates an inline hook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                channel:
                  type: HTTP
                  version: adipisicing Lorem aliquip dolore officia
                name: id
                status: ACTIVE
                type: com.okta.oauth2.tokens.transform
                version: ex incididunt deserunt
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channel:
                  type: OAUTH
                  version: nostrud dolore commodo dolor
                created: '2014-05-28T05:11:31.141Z'
                id: laborum occaecat dolore anim dolore
                lastUpdated: '1948-11-16T19:09:46.335Z'
                name: dolor in deserunt mollit
                status: INACTIVE
                type: com.okta.import.transform
                version: ullamco sint
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/inlineHooks/{inlineHookId}:
    get:
      tags:
        - Inline Hooks
      summary: Retrieve an Inline Hook
      description: Retrieves an inline hook by `inlineHookId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channel:
                  type: OAUTH
                  version: nostrud dolore commodo dolor
                created: '2014-05-28T05:11:31.141Z'
                id: laborum occaecat dolore anim dolore
                lastUpdated: '1948-11-16T19:09:46.335Z'
                name: dolor in deserunt mollit
                status: INACTIVE
                type: com.okta.import.transform
                version: ullamco sint
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Inline Hooks
      summary: Replace an Inline Hook
      description: Replaces an inline hook by `inlineHookId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                channel:
                  type: HTTP
                  version: adipisicing Lorem aliquip dolore officia
                name: id
                status: ACTIVE
                type: com.okta.oauth2.tokens.transform
                version: ex incididunt deserunt
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channel:
                  type: OAUTH
                  version: nostrud dolore commodo dolor
                created: '2014-05-28T05:11:31.141Z'
                id: laborum occaecat dolore anim dolore
                lastUpdated: '1948-11-16T19:09:46.335Z'
                name: dolor in deserunt mollit
                status: INACTIVE
                type: com.okta.import.transform
                version: ullamco sint
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Inline Hooks
      summary: Delete an Inline Hook
      description: >-
        Deletes an inline hook by `inlineHookId`. Once deleted, the Inline Hook
        is unrecoverable. As a safety precaution, only Inline Hooks with a
        status of INACTIVE are eligible for deletion.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/inlineHooks/{inlineHookId}/execute:
    post:
      tags:
        - Inline Hooks
      summary: Execute an Inline Hook
      description: >-
        Executes the inline hook by `inlineHookId` using the request body as the
        input. This will send the provided data through the Channel and return a
        response if it matches the correct data contract. This execution
        endpoint should only be used for testing purposes.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                commands:
                  - type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate:
    post:
      tags:
        - Inline Hooks
      summary: Activate an Inline Hook
      description: Activates the inline hook by `inlineHookId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channel:
                  type: OAUTH
                  version: nostrud dolore commodo dolor
                created: '2014-05-28T05:11:31.141Z'
                id: laborum occaecat dolore anim dolore
                lastUpdated: '1948-11-16T19:09:46.335Z'
                name: dolor in deserunt mollit
                status: INACTIVE
                type: com.okta.import.transform
                version: ullamco sint
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate:
    post:
      tags:
        - Inline Hooks
      summary: Deactivate an Inline Hook
      description: Deactivates the inline hook by `inlineHookId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: inlineHookId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Inline Hook
          example: Y7Rzrd4g4xj6WdKzrBHH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channel:
                  type: OAUTH
                  version: nostrud dolore commodo dolor
                created: '2014-05-28T05:11:31.141Z'
                id: laborum occaecat dolore anim dolore
                lastUpdated: '1948-11-16T19:09:46.335Z'
                name: dolor in deserunt mollit
                status: INACTIVE
                type: com.okta.import.transform
                version: ullamco sint
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/user/linkedObjects:
    get:
      tags:
        - Linked Objects
      summary: List all Linked Object Definitions
      description: Lists all linked object definitions
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - associated:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  primary:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - associated:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  primary:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    title:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Linked Objects
      summary: Create a Linked Object Definition
      description: Creates a linked object definition
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                associated:
                  description: adipisicing
                  name: Excepteur
                  title: laborum in consequat sunt
                  type: USER
                primary:
                  description: laboris consequat dolore
                  name: minim
                  title: do
                  type: USER
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                associated:
                  description: adipisicing et consectetur
                  name: incididunt dolor
                  title: in amet commodo ut
                  type: USER
                primary:
                  description: ''
                  name: esse in fugiat eu ullamco
                  title: esse sed ut sunt
                  type: USER
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}:
    get:
      tags:
        - Linked Objects
      summary: Retrieve a Linked Object Definition
      description: Retrieves a linked object definition
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: linkedObjectName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                associated:
                  description: adipisicing et consectetur
                  name: incididunt dolor
                  title: in amet commodo ut
                  type: USER
                primary:
                  description: ''
                  name: esse in fugiat eu ullamco
                  title: esse sed ut sunt
                  type: USER
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Linked Objects
      summary: Delete a Linked Object Definition
      description: Deletes a linked object definition
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: linkedObjectName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/logStreams:
    get:
      tags:
        - Log Streaming
      summary: List all Log Streams
      description: >-
        Lists all Log Stream objects in your org. You can request a paginated
        list or a subset of Log Streams that match a supported filter
        expression.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: filter
          in: query
          schema:
            type: string
          description: >-
            An expression that [filters](/#filter) the returned objects. You can
            only use the `eq` operator on either the `status` or `type`
            properties in the filter expression.
          example: type eq "aws_eventbridge"
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 0oa1orqUGCIoCGNxf0g4
                  type: aws_eventbridge
                  name: Example AWS EventBridge
                  lastUpdated: '2023-03-24T21:02:43.000Z'
                  created: '2023-03-24T21:02:43.000Z'
                  status: ACTIVE
                  settings:
                    accountId: '123456789012'
                    eventSourceName: your-event-source-name
                    region: us-east-2
                  _links:
                    self:
                      href: >-
                        http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4
                      method: GET
                    deactivate:
                      href: >-
                        http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate
                      method: POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Log Streaming
      summary: Create a Log Stream
      description: Creates a new Log Stream object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: aws_eventbridge
                name: Example AWS EventBridge
                settings:
                  eventSourceName: your-event-source-name
                  accountId: '123456789012'
                  region: us-east-2
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa1orqUGCIoCGNxf0g4
                type: aws_eventbridge
                name: Example AWS EventBridge
                lastUpdated: '2023-03-24T21:02:43.000Z'
                created: '2023-03-24T21:02:43.000Z'
                status: ACTIVE
                settings:
                  accountId: '123456789012'
                  eventSourceName: your-event-source-name
                  region: us-east-2
                _links:
                  self:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4
                    method: GET
                  deactivate:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate
                    method: POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/logStreams/{logStreamId}:
    get:
      tags:
        - Log Streaming
      summary: Retrieve a Log Stream
      description: Retrieves a Log Stream object by ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Unique identifier for the Log Stream
          example: 0oa1orzg0CHSgPcjZ0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa1orqUGCIoCGNxf0g4
                type: aws_eventbridge
                name: Example AWS EventBridge
                lastUpdated: '2023-03-24T21:02:43.000Z'
                created: '2023-03-24T21:02:43.000Z'
                status: ACTIVE
                settings:
                  accountId: '123456789012'
                  eventSourceName: your-event-source-name
                  region: us-east-2
                _links:
                  self:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4
                    method: GET
                  deactivate:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate
                    method: POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Log Streaming
      summary: Replace a Log Stream
      description: >-
        Replaces the Log Stream object properties for a given ID.


        This operation is typically used to update the configuration of a Log
        Stream.

        Depending on the type of Log Stream you want to update, certain
        properties can't be modified after the Log Stream is initially created.

        Use the [Retrieve the Log Stream Schema for the schema
        type](/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/getLogStreamSchema)
        request to determine which properties you can update for the specific
        Log Stream type.

        Log Stream properties with the `"writeOnce" : true` attribute can't be
        updated after creation.

        You must still specify these `writeOnce` properties in the request body
        with the original values in the PUT request.


        > **Note:** You don't have to specify properties that have both the
        `"writeOnce": true` and the `"writeOnly": true` attributes in the PUT
        request body. These property values are ignored even if you add them in
        the PUT request body.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: aws_eventbridge
                name: Updated AWS EventBridge
                settings:
                  eventSourceName: your-event-source-name
                  accountId: '123456789012'
                  region: us-east-2
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Unique identifier for the Log Stream
          example: 0oa1orzg0CHSgPcjZ0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa1orqUGCIoCGNxf0g4
                type: aws_eventbridge
                name: Updated AWS EventBridge
                lastUpdated: '2023-03-24T21:12:43.000Z'
                created: '2023-03-24T21:02:43.000Z'
                status: ACTIVE
                settings:
                  accountId: '123456789012'
                  eventSourceName: your-event-source-name
                  region: us-east-2
                _links:
                  self:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4
                    method: GET
                  deactivate:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate
                    method: POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Log Streaming
      summary: Delete a Log Stream
      description: Deletes a Log Stream object from your org by ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Unique identifier for the Log Stream
          example: 0oa1orzg0CHSgPcjZ0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/logStreams/{logStreamId}/lifecycle/activate:
    post:
      tags:
        - Log Streaming
      summary: Activate a Log Stream
      description: Activates a log stream by `logStreamId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Unique identifier for the Log Stream
          example: 0oa1orzg0CHSgPcjZ0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa1orqUGCIoCGNxf0g4
                type: aws_eventbridge
                name: Example AWS EventBridge
                lastUpdated: '2023-03-24T21:22:43.000Z'
                created: '2023-03-24T21:02:43.000Z'
                status: ACTIVE
                settings:
                  accountId: '123456789012'
                  eventSourceName: your-event-source-name
                  region: us-east-2
                _links:
                  self:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4
                    method: GET
                  deactivate:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate
                    method: POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/logStreams/{logStreamId}/lifecycle/deactivate:
    post:
      tags:
        - Log Streaming
      summary: Deactivate a Log Stream
      description: Deactivates a log stream by `logStreamId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Unique identifier for the Log Stream
          example: 0oa1orzg0CHSgPcjZ0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 0oa7agphh5FT7H521d7
                type: splunk_cloud_logstreaming
                name: Splunk Cloud Example
                lastUpdated: '2023-03-24T21:23:00.000Z'
                created: '2023-03-24T21:15:13.000Z'
                status: INACTIVE
                settings:
                  edition: aws
                  host: okexample.splunkcloud.com
                _links:
                  self:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7
                    method: GET
                  activate:
                    href: >-
                      http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7/lifecycle/activate
                    method: POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/zones:
    get:
      tags:
        - Network Zones
      summary: List all Network Zones
      description: >-
        Lists all network zones with pagination. A subset of zones can be
        returned that match a supported filter expression or query.


        This operation requires URL encoding. For example, `filter=(id eq
        "nzoul0wf9jyb8xwZm0g3" or id eq "nzoul1MxmGN18NDQT0g3")` is encoded as
        `filter=%28id+eq+%22nzoul0wf9jyb8xwZm0g3%22+or+id+eq+%22nzoul1MxmGN18NDQT0g3%22%29`.


        Okta supports filtering on the `id` and `usage` properties. See
        [Filtering](https://developer.okta.com/docs/reference/core-okta-api/#filter)
        for more information on the expressions that are used in filtering.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: Specifies the pagination cursor for the next page of network zones
          example: 200u7yq5goxNFTiMjW1d7
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of results for a page
          example: '5'
        - name: filter
          in: query
          schema:
            type: string
          description: Filters zones by usage or ID expression
          example: filter=%28id+eq+%22nzowc1U5Jh5xuAK0o0g3%22%29
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - type: IP
                  id: nzowc1U5Jh5xuAK0o0g3
                  name: LegacyIpZone
                  status: ACTIVE
                  usage: POLICY
                  created: '2019-05-17T18:44:31.000Z'
                  lastUpdated: '2019-05-21T13:50:49.000Z'
                  system: true
                  gateways:
                    - type: CIDR
                      value: 1.2.3.4/24
                  proxies:
                    - type: RANGE
                      value: 3.3.4.5-3.3.4.15
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
                    deactivate:
                      href: >-
                        https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate
                      hints:
                        allow:
                          - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Network Zones
      summary: Create a Network Zone
      description: >-
        Creates a new network zone.

        * At least one of either the `gateways` attribute or `proxies` attribute
        must be defined when creating a Network Zone.

        * At least one of the following attributes must be defined: `proxyType`,
        `locations`, or `asns`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: IP
                name: newNetworkZone
                gateways:
                  - type: CIDR
                    value: 1.2.3.4/24
                  - type: CIDR
                    value: 2.3.4.5/24
                proxies:
                  - type: CIDR
                    value: 2.2.3.4/24
                  - type: CIDR
                    value: 3.3.4.5/24
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: IP
                id: nzowc1U5Jh5xuAK0o0g3
                name: newNetworkZone
                status: ACTIVE
                usage: POLICY
                created: '2019-05-17T18:44:31.000Z'
                lastUpdated: '2019-05-21T13:50:49.000Z'
                system: false
                gateways:
                  - type: CIDR
                    value: 1.2.3.4/24'
                  - type: CIDR
                    value: 2.3.4.5/24
                proxies:
                  - type: CIDR
                    value: 2.2.3.4/24
                  - type: CIDR
                    value: 3.3.4.5/24
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/zones/{zoneId}:
    get:
      tags:
        - Network Zones
      summary: Retrieve a Network Zone
      description: Retrieves a network zone by `zoneId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: zoneId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Network Zone
          example: nzowc1U5Jh5xuAK0o0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: IP
                id: nzowc1U5Jh5xuAK0o0g3
                name: LegacyIpZone
                status: ACTIVE
                usage: POLICY
                created: '2019-05-17T18:44:31.000Z'
                lastUpdated: '2019-05-21T13:50:49.000Z'
                system: true
                gateways:
                  - type: CIDR
                    value: 1.2.3.4/24
                proxies:
                  - type: RANGE
                    value: 3.3.4.5-3.3.4.15
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Network Zones
      summary: Replace a Network Zone
      description: >-
        Replaces a network zone by `zoneId`. The replaced network zone type must
        be the same as the existing type.

        You may replace the usage (`POLICY`, `BLOCKLIST`) of a network zone by
        updating the `usage` attribute.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: IP
                id: nzovw2rFz2YoqmvwZ0g9
                name: UpdatedNetZone
                status: ACTIVE
                usage: POLICY
                gateways:
                  - type: CIDR
                    value: 10.2.3.4/24
                  - type: CIDR
                    value: 12.2.3.4/24
                  - type: RANGE
                    value: 13.4.5.6-13.4.5.8
                  - type: CIDR
                    value: 14.2.3.4/24
                proxies:
                  - type: CIDR
                    value: 12.2.3.4/24
                  - type: CIDR
                    value: 13.3.4.5/24
                  - type: RANGE
                    value: 14.4.5.6-14.4.5.8
                  - type: RANGE
                    value: 15.5.6.7/24-15.5.6.9
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: zoneId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Network Zone
          example: nzowc1U5Jh5xuAK0o0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: IP
                id: nzovw2rFz2YoqmvwZ0g3
                name: UpdatedNetZone
                status: ACTIVE
                usage: POLICY
                created: '2019-01-24T19:53:28.000Z'
                lastUpdated: '2019-02-24T19:53:28.000Z'
                system: false
                gateways:
                  - type: CIDR
                    value: 10.2.3.4/24
                  - type: CIDR
                    value: 12.2.3.4/24
                  - type: RANGE
                    value: 13.4.5.6-13.4.5.8
                  - type: CIDR
                    value: 14.2.3.4/24
                proxies:
                  - type: CIDR
                    value: 12.2.3.4/24
                  - type: CIDR
                    value: 13.3.4.5/24
                  - type: RANGE
                    value: 14.4.5.6-14.4.5.8
                  - type: RANGE
                    value: 15.5.6.7/24-15.5.6.9
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Network Zones
      summary: Delete a Network Zone
      description: Deletes network zone by `zoneId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: zoneId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Network Zone
          example: nzowc1U5Jh5xuAK0o0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/zones/{zoneId}/lifecycle/activate:
    post:
      tags:
        - Network Zones
      summary: Activate a Network Zone
      description: Activates a network zone by `zoneId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: zoneId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Network Zone
          example: nzowc1U5Jh5xuAK0o0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: IP
                id: nzowc1U5Jh5xuAK0o0g3
                name: LegacyIpZone
                status: ACTIVE
                usage: POLICY
                created: '2019-05-17T18:44:31.000Z'
                lastUpdated: '2019-05-21T13:50:49.000Z'
                system: true
                gateways:
                  - type: CIDR
                    value: 1.2.3.4/24
                proxies:
                  - type: RANGE
                    value: 3.3.4.5-3.3.4.15
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/zones/{zoneId}/lifecycle/deactivate:
    post:
      tags:
        - Network Zones
      summary: Deactivate a Network Zone
      description: Deactivates a network zone by `zoneId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: zoneId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Network Zone
          example: nzowc1U5Jh5xuAK0o0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                type: IP
                id: nzowc1U5Jh5xuAK0o0g3
                name: LegacyIpZone
                status: INACTIVE
                usage: POLICY
                created: '2019-05-17T18:44:31.000Z'
                lastUpdated: '2019-05-21T13:50:49.000Z'
                system: true
                gateways:
                  - type: CIDR
                    value: 1.2.3.4/24
                proxies:
                  - type: RANGE
                    value: 3.3.4.5-3.3.4.15
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /.well-known/okta-organization:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Well-Known Org Metadata
      description: >-
        Retrieves the well-known org metadata, which includes the id, configured
        custom domains, authentication pipeline, and various other org settings
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 00o47wwoytgsDqEtz0g7
                _links:
                  organization:
                    href: https://{{yourSubdomain}}.okta.com
                  alternate:
                    href: https://{{yourCustomDomain}}
                pipeline: idx
                settings:
                  analyticsCollectionEnabled: false
                  bugReportingEnabled: true
                  omEnabled: false
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Org Settings
      description: Retrieves the org settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                address1: eu cillum commodo consectetur
                address2: quis ullamco dolor in nisi
                city: laboris
                companyName: nisi
                country: mollit aliqua
                created: '1993-06-24T02:01:46.227Z'
                endUserSupportHelpURL: in amet
                expiresAt: '1976-02-14T22:19:00.355Z'
                id: tempor ex occaecat
                lastUpdated: '1977-04-11T14:27:03.102Z'
                phoneNumber: ullamco esse id exercitation veniam
                postalCode: elit nostrud non
                state: reprehenderit i
                status: ea cupidatat Duis id
                subdomain: exercitation sint dolore adipisicing fugiat
                supportPhoneNumber: aute officia
                website: sed aute
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Org Settings
      summary: Update the Org Settings
      description: Partially updates the org settings depending on provided fields
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                address1: deserunt enim esse aute sit
                address2: laboris dolore aute deserunt
                city: laborum cillum anim qui
                companyName: s
                country: Excepteur nisi
                endUserSupportHelpURL: commodo ipsum ea
                phoneNumber: labore qui ut Duis
                postalCode: Duis qui ullamco
                state: occaecat ullamco officia
                supportPhoneNumber: in irure
                website: consectetur nostrud in ex
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                address1: eu cillum commodo consectetur
                address2: quis ullamco dolor in nisi
                city: laboris
                companyName: nisi
                country: mollit aliqua
                created: '1993-06-24T02:01:46.227Z'
                endUserSupportHelpURL: in amet
                expiresAt: '1976-02-14T22:19:00.355Z'
                id: tempor ex occaecat
                lastUpdated: '1977-04-11T14:27:03.102Z'
                phoneNumber: ullamco esse id exercitation veniam
                postalCode: elit nostrud non
                state: reprehenderit i
                status: ea cupidatat Duis id
                subdomain: exercitation sint dolore adipisicing fugiat
                supportPhoneNumber: aute officia
                website: sed aute
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Org Settings
      summary: Replace the Org Settings
      description: Replaces the settings of your organization
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                address1: deserunt enim esse aute sit
                address2: laboris dolore aute deserunt
                city: laborum cillum anim qui
                companyName: s
                country: Excepteur nisi
                endUserSupportHelpURL: commodo ipsum ea
                phoneNumber: labore qui ut Duis
                postalCode: Duis qui ullamco
                state: occaecat ullamco officia
                supportPhoneNumber: in irure
                website: consectetur nostrud in ex
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                address1: eu cillum commodo consectetur
                address2: quis ullamco dolor in nisi
                city: laboris
                companyName: nisi
                country: mollit aliqua
                created: '1993-06-24T02:01:46.227Z'
                endUserSupportHelpURL: in amet
                expiresAt: '1976-02-14T22:19:00.355Z'
                id: tempor ex occaecat
                lastUpdated: '1977-04-11T14:27:03.102Z'
                phoneNumber: ullamco esse id exercitation veniam
                postalCode: elit nostrud non
                state: reprehenderit i
                status: ea cupidatat Duis id
                subdomain: exercitation sint dolore adipisicing fugiat
                supportPhoneNumber: aute officia
                website: sed aute
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/contacts:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Org Contact Types
      description: Retrieves Contact Types of your organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - contactType: TECHNICAL
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - contactType: TECHNICAL
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/contacts/{contactType}:
    get:
      tags:
        - Org Settings
      summary: Retrieve the User of the Contact Type
      description: Retrieves the URL of the User associated with the specified Contact Type
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contactType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                userId: ut id
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Org Settings
      summary: Replace the User of the Contact Type
      description: Replaces the User associated with the specified Contact Type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                userId: 'id irure '
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contactType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                userId: ut id
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/email/bounces/remove-list:
    post:
      tags:
        - Org Settings
      summary: Remove Emails from Email Provider Bounce List
      description: >-
        Removes a list of email addresses to be removed from the set of email
        addresses that are bounced
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                emailAddresses:
                  - name@company.com
                  - unknown.email@okta.com
                  - name@okta@com
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errors:
                  - emailAddress: unknown.email@okta.com
                    reason: >-
                      This email address does not belong to any user in your
                      organization.
                  - emailAddress: name@okta@com
                    reason: >-
                      Invalid email address. The provided email address failed
                      validation against RFC 3696.
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/logo:
    post:
      tags:
        - Org Settings
      summary: Upload the Org Logo
      description: >-
        Uploads and replaces the logo for your organization. The file must be in
        PNG, JPG, or GIF format and less than 100kB in size. For best results
        use landscape orientation, a transparent background, and a minimum size
        of 300px by 50px to prevent upscaling.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: '(Required) '
                  format: binary
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/orgSettings/thirdPartyAdminSetting:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Org Third-Party Admin setting
      description: Retrieves the Third-Party Admin setting
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                thirdPartyAdmin: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Org Settings
      summary: Update the Org Third-Party Admin setting
      description: Updates the Third-Party Admin setting
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                thirdPartyAdmin: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/preferences:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Org Preferences
      description: Retrieves preferences of your organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                showEndUserFooter: false
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/preferences/hideEndUserFooter:
    post:
      tags:
        - Org Settings
      summary: Update the Preference to Hide the Okta Dashboard Footer
      description: >-
        Updates the preference hide the Okta UI footer for all end users of your
        organization
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                showEndUserFooter: false
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/preferences/showEndUserFooter:
    post:
      tags:
        - Org Settings
      summary: Update the Preference to Show the Okta Dashboard Footer
      description: >-
        Updates the preference to show the Okta UI footer for all end users of
        your organization
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                showEndUserFooter: false
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaCommunication:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Okta Communication Settings
      description: Retrieves Okta Communication Settings of your organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                optOutEmailUsers: true
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaCommunication/optIn:
    post:
      tags:
        - Org Settings
      summary: Opt in all Users to Okta Communication emails
      description: Opts in all users of this org to Okta Communication emails
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                optOutEmailUsers: true
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaCommunication/optOut:
    post:
      tags:
        - Org Settings
      summary: Opt out all Users from Okta Communication emails
      description: Opts out all users of this org from Okta Communication emails
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                optOutEmailUsers: true
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaSupport:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Okta Support Settings
      description: Retrieves Okta Support Settings of your organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiration: '1978-10-08T18:05:00.079Z'
                support: DISABLED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaSupport/extend:
    post:
      tags:
        - Org Settings
      summary: Extend Okta Support Access
      description: >-
        Extends the length of time that Okta Support can access your org by 24
        hours. This means that 24 hours are added to the remaining access time.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiration: '1978-10-08T18:05:00.079Z'
                support: DISABLED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaSupport/grant:
    post:
      tags:
        - Org Settings
      summary: Grant Okta Support Access to your Org
      description: >-
        Grants Okta Support temporary access your org as an administrator for
        eight hours
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiration: '1978-10-08T18:05:00.079Z'
                support: DISABLED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/privacy/oktaSupport/revoke:
    post:
      tags:
        - Org Settings
      summary: Revoke Okta Support Access
      description: Revokes Okta Support access to your organization
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiration: '1978-10-08T18:05:00.079Z'
                support: DISABLED
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/org/settings/clientPrivilegesSetting:
    get:
      tags:
        - Org Settings
      summary: Retrieve the Org settings to assign the Super Admin role
      description: >-
        Retrieves the Org settings to assign the [Super Admin
        role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by
        default to a public client app
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                clientPrivilegesSetting: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Org Settings
      summary: Assign the Super Admin role to a public client app
      description: >-
        Assigns the [Super Admin
        role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by
        default to a public client app
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                clientPrivilegesSetting: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                clientPrivilegesSetting: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies:
    get:
      tags:
        - Policies
      summary: List all Policies
      description: Lists all policies with the specified type
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: type
          in: query
          schema:
            type: string
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: status
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: expand
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2008-06-22T03:27:29.346Z'
                  description: elit Ut quis
                  id: reprehenderit et
                  lastUpdated: '2015-04-05T09:49:04.805Z'
                  name: fugiat proident
                  priority: 72006578
                  status: ACTIVE
                  system: true
                  type: ACCESS_POLICY
                  _embedded:
                    enim_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2015-09-11T00:32:09.862Z'
                  description: elit ea occaecat
                  id: ut
                  lastUpdated: '1957-10-08T00:23:26.563Z'
                  name: laboris mollit ut dolore ad
                  priority: -56379780
                  status: INACTIVE
                  system: false
                  type: ACCESS_POLICY
                  _embedded:
                    in25c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolored:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Policies
      summary: Create a Policy
      description: Creates a policy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: aute minim
                name: cillum
                priority: 64213370
                status: INACTIVE
                system: false
                type: OKTA_SIGN_ON
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: activate
          in: query
          schema:
            type: boolean
          example: 'true'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1948-09-14T19:48:41.514Z'
                description: anim sit
                id: Ut in ut
                lastUpdated: '2022-07-06T11:53:11.812Z'
                name: eu Lorem
                priority: -20188617
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  qui_9: {}
                  minimec: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/simulate:
    post:
      tags:
        - Policies
      summary: Create a Policy Simulation
      description: >-
        Creates a policy or policy rule simulation. The access simulation
        evaluates policy and policy rules based on the existing policy rule
        configuration.

        The evaluation result simulates what the real-world authentication flow
        is and what policy rules have been applied or matched to the
        authentication flow.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                policyType:
                  - OKTA_SIGN_ON
                  - MFA_ENROLL
                appInstance: 0oa4eroj3nYCIJIW70g7
                policyContext:
                  groups:
                    ids:
                      - 00g4eralvekR5RLuS0g7
                      - 00g4eralvekR5RLuS0g8
                risk:
                  level: LOW
                zones:
                  ids:
                    - nzo4eralxcRnbIHYJ0g7
                device:
                  platform: IOS
                  registered: true
                  managed: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            Use `expand=EVALUATED` to include a list of evaluated but not
            matched policies and policy rules. Use `expand=RULE` to include
            details about why a rule condition was (not) matched.
          example: expand=EVALUATED&expand=RULE
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                evaluation:
                  - status: null
                    policyType: OkTA_SIGN_ON
                    result:
                      policies:
                        - id: 00p4eromwukk6qUku0g7
                        - name: test policy
                        - status: MATCH
                        - conditions: []
                        - rules:
                            - id: 0pr4erof85nGcyC7Y0g7
                            - name: test rule
                            - status: MATCH
                            - conditions:
                                - type: people.groups.include
                                - status: MATCH
                    undefined:
                      policies: null
                    evaluated:
                      policies: null
                  - status: null
                    policyType: ACCESS_POLICY
                    result:
                      policies:
                        - id: rst4eram06ZKZewEe0g7
                        - name: Any two factors
                        - status: MATCH
                        - conditions: []
                        - rules:
                            - id: rul4eram07VsWgybo0g7
                            - name: Catch-all rule
                            - status: MATCH
                            - conditions: []
                    undefined:
                      policies: null
                    evaluated:
                      policies: null
                  - status: null
                    policyType: PROFILE_ENROLLMENT
                    result:
                      policies:
                        - id: rst4eram08ZSjPTOl0g7
                        - name: Default Policy
                        - status: MATCH
                        - conditions: []
                        - rules:
                            - id: rul4eram094PrQ2BX0g7
                            - name: Catch-all rule
                            - status: MATCH
                            - conditions: []
                    undefined:
                      policies: null
                    evaluated:
                      policies: null
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}:
    get:
      tags:
        - Policies
      summary: Retrieve a Policy
      description: Retrieves a policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1948-09-14T19:48:41.514Z'
                description: anim sit
                id: Ut in ut
                lastUpdated: '2022-07-06T11:53:11.812Z'
                name: eu Lorem
                priority: -20188617
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  qui_9: {}
                  minimec: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Policies
      summary: Replace a Policy
      description: Replaces the properties of a Policy identified by `policyId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: aute minim
                name: cillum
                priority: 64213370
                status: INACTIVE
                system: false
                type: OKTA_SIGN_ON
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1948-09-14T19:48:41.514Z'
                description: anim sit
                id: Ut in ut
                lastUpdated: '2022-07-06T11:53:11.812Z'
                name: eu Lorem
                priority: -20188617
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  qui_9: {}
                  minimec: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Policies
      summary: Delete a Policy
      description: Deletes a policy
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/app:
    get:
      tags:
        - Policies
      summary: List all Applications mapped to a Policy
      description: >-
        Lists all applications mapped to a policy identified by `policyId`


        > **Note:** Use [List all resources mapped to a
        Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyMappings)
        to list all applications mapped to a policy.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '1982-02-17T17:02:39.932Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: proident in ea
                  label: in anim dolore
                  lastUpdated: '2017-08-16T11:33:51.678Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    proident509:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    anim12:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolored_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    irure9:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: AUTO_LOGIN
                  status: INACTIVE
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    reprehenderit9:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    mollit4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - accessibility:
                    errorRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    loginRedirectUrl:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    selfService:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  created: '2000-06-11T20:16:55.428Z'
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: eu sed proident culpa
                  label: ipsum ullamco
                  lastUpdated: '1971-02-13T09:00:02.132Z'
                  licensing:
                    seatCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    ut16:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  signOnMode: BROWSER_PLUGIN
                  status: DELETED
                  visibility:
                    appLinks:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoLaunch:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    autoSubmitToolbar:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hide:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _embedded:
                    consectetur_8:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    laborum4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    accessPolicy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    activate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deactivate:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    groups:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    logo:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    metadata:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    users:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/clone:
    post:
      tags:
        - Policies
      summary: Clone an existing Policy
      description: Clones an existing policy
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1948-09-14T19:48:41.514Z'
                description: anim sit
                id: Ut in ut
                lastUpdated: '2022-07-06T11:53:11.812Z'
                name: eu Lorem
                priority: -20188617
                status: INACTIVE
                system: true
                type: ACCESS_POLICY
                _embedded:
                  qui_9: {}
                  minimec: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/lifecycle/activate:
    post:
      tags:
        - Policies
      summary: Activate a Policy
      description: Activates a policy
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/lifecycle/deactivate:
    post:
      tags:
        - Policies
      summary: Deactivate a Policy
      description: Deactivates a policy
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/mappings:
    get:
      tags:
        - Policies
      summary: List all resources mapped to a Policy
      description: Lists all resources mapped to a Policy identified by `policyId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: est ame
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - id: qui officia anim laboris enim
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Policies
      summary: Map a resource to a Policy
      description: Maps a resource to a Policy identified by `policyId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                resourceId: cillum aliqua aliquip exercitation
                resourceType: APP
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  application:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticator:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/mappings/{mappingId}:
    get:
      tags:
        - Policies
      summary: Retrieve a policy resource Mapping
      description: >-
        Retrieves a resource Mapping for a Policy identified by `policyId` and
        `mappingId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: mappingId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the policy resource Mapping
          example: maplr2rLjZ6NsGn1P0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: et
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  application:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticator:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Policies
      summary: Delete a policy resource Mapping
      description: >-
        Deletes the resource Mapping for a Policy identified by  `policyId` and
        `mappingId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: mappingId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the policy resource Mapping
          example: maplr2rLjZ6NsGn1P0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/rules:
    get:
      tags:
        - Policies
      summary: List all Policy Rules
      description: Lists all policy rules
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2004-02-01T11:34:48.596Z'
                  id: est cupidatat
                  lastUpdated: '1998-10-02T07:56:53.659Z'
                  name: dolor sit
                  priority: 21777018
                  status: INACTIVE
                  system: false
                  type: PASSWORD
                - created: '1964-10-28T13:50:46.946Z'
                  id: fugiat eiusmod do occaecat
                  lastUpdated: '2018-10-20T14:12:40.617Z'
                  name: sunt veniam incididunt reprehenderit
                  priority: 16798657
                  status: INACTIVE
                  system: false
                  type: MFA_ENROLL
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Policies
      summary: Create a Policy Rule
      description: Creates a policy rule
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: SSPR Rule
                priority: 1
                status: ACTIVE
                conditions:
                  people:
                    users:
                      exclude: []
                  network:
                    connection: ANYWHERE
                actions:
                  passwordChange:
                    access: ALLOW
                  selfServicePasswordReset:
                    access: ALLOW
                    requirement:
                      primary:
                        methods:
                          - push
                          - sms
                      stepUp:
                        required: true
                        methods:
                          - security_question
                  selfServiceUnlock:
                    access: ALLOW
                system: false
                type: PASSWORD
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ruleId
                _links:
                  self:
                    href: >-
                      https://sampleorg.okta.com/api/v1/policies/{policyId}/rules/{ruleId}
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://sampleorg.okta.com/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                name: SSPR Rule
                priority: 1
                status: ACTIVE
                conditions:
                  people:
                    users:
                      exclude: []
                  network:
                    connection: ANYWHERE
                actions:
                  passwordChange:
                    access: ALLOW
                  selfServicePasswordReset:
                    access: ALLOW
                    requirement:
                      primary:
                        methods:
                          - push
                          - sms
                      stepUp:
                        required: true
                        methods:
                          - security_question
                  selfServiceUnlock:
                    access: ALLOW
                system: false
                type: PASSWORD
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/rules/{ruleId}:
    get:
      tags:
        - Policies
      summary: Retrieve a Policy Rule
      description: Retrieves a policy rule
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ruleId
                name: SSPR Rule
                priority: 1
                status: ACTIVE
                conditions:
                  people:
                    users:
                      exclude: []
                  network:
                    connection: ANYWHERE
                actions:
                  passwordChange:
                    access: ALLOW
                  selfServicePasswordReset:
                    access: ALLOW
                    requirement:
                      primary:
                        methods:
                          - push
                          - sms
                      stepUp:
                        required: true
                        methods:
                          - security_question
                  selfServiceUnlock:
                    access: ALLOW
                system: false
                type: PASSWORD
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Policies
      summary: Replace a Policy Rule
      description: >-
        Replaces the properties for a Policy Rule identified by `policyId` and
        `ruleId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: ruleId
                name: SSPR Rule
                priority: 1
                status: ACTIVE
                conditions:
                  people:
                    users:
                      exclude: []
                  network:
                    connection: ANYWHERE
                actions:
                  passwordChange:
                    access: ALLOW
                  selfServicePasswordReset:
                    access: ALLOW
                    requirement:
                      primary:
                        methods:
                          - push
                          - sms
                      stepUp:
                        required: true
                        methods:
                          - security_question
                  selfServiceUnlock:
                    access: ALLOW
                system: false
                type: PASSWORD
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ruleId
                _links:
                  self:
                    href: >-
                      https://sampleorg.okta.com/api/v1/policies/{policyId}/rules/{ruleId}
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
                  deactivate:
                    href: >-
                      https://sampleorg.okta.com/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate
                    hints:
                      allow:
                        - POST
                name: SSPR Rule
                priority: 1
                status: ACTIVE
                conditions:
                  people:
                    users:
                      exclude: []
                  network:
                    connection: ANYWHERE
                actions:
                  passwordChange:
                    access: ALLOW
                  selfServicePasswordReset:
                    access: ALLOW
                    requirement:
                      primary:
                        methods:
                          - push
                          - sms
                      stepUp:
                        required: true
                        methods:
                          - security_question
                  selfServiceUnlock:
                    access: ALLOW
                system: false
                type: PASSWORD
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Policies
      summary: Delete a Policy Rule
      description: Deletes a Policy Rule identified by `policyId` and `ruleId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate:
    post:
      tags:
        - Policies
      summary: Activate a Policy Rule
      description: Activates a Policy Rule identified by `policyId` and `ruleId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate:
    post:
      tags:
        - Policies
      summary: Deactivate a Policy Rule
      description: Deactivates a Policy Rule identified by `policyId` and `ruleId`
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: policyId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy
          example: 00plrilJ7jZ66Gn0X0g3
        - name: ruleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Policy Rule
          example: ruld3hJ7jZh4fn0st0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/principal-rate-limits:
    get:
      tags:
        - Principal Rate Limits
      summary: List all Principal Rate Limits
      description: >-
        Lists all Principal Rate Limit entities considering the provided
        parameters
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: filter
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - principalId: dolor minim dolor cupidatat
                  principalType: SSWS_TOKEN
                  createdBy: Excep
                  createdDate: '2012-04-20T01:41:54.951Z'
                  defaultConcurrencyPercentage: 84106658
                  defaultPercentage: 18798283
                  id: Lorem sint
                  lastUpdate: '1974-06-10T12:28:02.635Z'
                  lastUpdatedBy: velit labore
                  orgId: incidi
                - principalId: Duis dolore Lorem
                  principalType: SSWS_TOKEN
                  createdBy: sed minim
                  createdDate: '2004-06-17T13:33:31.620Z'
                  defaultConcurrencyPercentage: 62962839
                  defaultPercentage: 49232492
                  id: incididunt
                  lastUpdate: '1980-08-23T13:26:36.691Z'
                  lastUpdatedBy: quis Excep
                  orgId: non nostrud
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Principal Rate Limits
      summary: Create a Principal Rate Limit
      description: >-
        Creates a new Principal Rate Limit entity. In the current release, we
        only allow one Principal Rate Limit entity per org and principal.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                principalId: token1234
                principalType: SSWS_TOKEN
                defaultPercentage: 50
                defaultConcurrencyPercentage: 75
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                orgId: org1234
                principalId: token1234
                principalType: SSWS_TOKEN
                defaultPercentage: 50
                defaultConcurrencyPercentage: 75
                createdDate: '2022-05-19T20:05:32.720Z'
                createdBy: user1234
                lastUpdate: '2022-05-20T21:13:07.410Z'
                lastUpdatedBy: user4321
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/principal-rate-limits/{principalRateLimitId}:
    get:
      tags:
        - Principal Rate Limits
      summary: Retrieve a Principal Rate Limit
      description: Retrieves a Principal Rate Limit entity by `principalRateLimitId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: principalRateLimitId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Principal Rate Limit
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                orgId: org1234
                principalId: token1234
                principalType: SSWS_TOKEN
                defaultPercentage: 50
                defaultConcurrencyPercentage: 75
                createdDate: '2022-05-19T20:05:32.720Z'
                createdBy: user1234
                lastUpdate: '2022-05-20T21:13:07.410Z'
                lastUpdatedBy: user4321
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Principal Rate Limits
      summary: Replace a Principal Rate Limit
      description: Replaces a principal rate limit entity by `principalRateLimitId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                principalId: token1234
                principalType: SSWS_TOKEN
                defaultPercentage: 50
                defaultConcurrencyPercentage: 75
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: principalRateLimitId
          in: path
          schema:
            type: string
          required: true
          description: (Required) id of the Principal Rate Limit
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: abcd1234
                orgId: org1234
                principalId: token1234
                principalType: SSWS_TOKEN
                defaultPercentage: 50
                defaultConcurrencyPercentage: 75
                createdDate: '2022-05-19T20:05:32.720Z'
                createdBy: user1234
                lastUpdate: '2022-05-20T21:13:07.410Z'
                lastUpdatedBy: user4321
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/mappings:
    get:
      tags:
        - Profile Mappings
      summary: List all Profile Mappings
      description: >-
        Lists all profile mappings in your organization with
        [pagination](https://developer.okta.com/docs/api/#pagination). You can
        return a subset of profile mappings that match a supported `sourceId`
        and/or `targetId`.

        The results are [paginated](/#pagination) according to the limit
        parameter. If there are multiple pages of results, the Link header
        contains a `next` link that should be treated as an opaque value (follow
        it, don't parse it).


        The response is a collection of profile mappings that include a subset
        of the profile mapping object's parameters. The profile mapping object
        describes

        the properties mapping between an Okta User and an App User Profile
        using [JSON Schema Draft
        4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            Mapping `id` that specifies the pagination cursor for the next page
            of mappings
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of results per page (maximum 200)
          example: '20'
        - name: sourceId
          in: query
          schema:
            type: string
          description: >-
            The UserType or App Instance `id` that acts as the source of
            expressions in a mapping. If this parameter is included, all
            returned mappings have this as their `source.id`.
          example: mollit occaecat cupidatat
        - name: targetId
          in: query
          schema:
            type: string
          description: >-
            The UserType or App Instance `id` that acts as the target of
            expressions in a mapping. If this parameter is included, all
            returned mappings have this as their `target.id`.
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: prm1k47ghydIQOTBW0g4
                  source:
                    id: otysbePhQ3yqt4cVv0g3
                    name: user
                    type: user
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3
                      schema:
                        href: >-
                          https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3
                  target:
                    id: 0oa1qmn4LZQQEH0wZ0g4
                    name: okta_org2org
                    type: appuser
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4
                      schema:
                        href: >-
                          https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/mappings/{mappingId}:
    get:
      tags:
        - Profile Mappings
      summary: Retrieve a Profile Mapping
      description: Retrieves a single Profile Mapping referenced by its ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: mappingId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Mapping
          example: cB6u7X8mptebWkffatKA
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: prm1k47ghydIQOTBW0g4
                source:
                  id: otysbePhQ3yqt4cVv0g3
                  name: user
                  type: user
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3
                target:
                  id: 0oa1qmn4LZQQEH0wZ0g4
                  name: okta_org2org
                  type: appuser
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default
                properties:
                  firstName:
                    expression: user.firstName
                    pushStatus: PUSH
                  lastName:
                    expression: user.lastName
                    pushStatus: PUSH
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Profile Mappings
      summary: Update a Profile Mapping
      description: >-
        Updates an existing profile mapping by adding, updating, or removing one
        or many property mappings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                properties:
                  additionalProperties:
                    fullName:
                      expression: user.firstName + user.lastName
                      pushStatus: PUSH
                    nickName:
                      expression: user.nickName
                      pushStatus: PUSH
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: mappingId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Mapping
          example: cB6u7X8mptebWkffatKA
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: prm1k47ghydIQOTBW0g4
                source:
                  id: otysbePhQ3yqt4cVv0g3
                  name: user
                  type: user
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3
                target:
                  id: 0oa1qmn4LZQQEH0wZ0g4
                  name: okta_org2org
                  type: appuser
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default
                properties:
                  fullName:
                    expression: user.firstName + user.lastName
                    pushStatus: PUSH
                  nickName:
                    expression: user.nickName
                    pushStatus: PUSH
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/push-providers:
    get:
      tags:
        - Push Providers
      summary: List all Push Providers
      description: Lists all push providers
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: type
          in: query
          schema:
            type: string
          description: Filters push providers by `providerType`
          example: APNS
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: d
                  lastUpdatedDate: in ut veniam
                  name: reprehenderit enim ut
                  providerType: APNS
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - id: dolore aliqua
                  lastUpdatedDate: incididunt veniam occaecat tempor
                  name: nisi pariatur culpa et consequat
                  providerType: APNS
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Push Providers
      summary: Create a Push Provider
      description: Creates a new push provider
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: APNs Example
                providerType: APNS
                configuration:
                  keyId: KEY_ID
                  teamId: TEAM_ID
                  tokenSigningKey: >-
                    -----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE
                    KEY-----\n
                  fileName: fileName.p8
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ppctekcmngGaqeiBxB0g4
                name: APNs Example
                providerType: APNS
                lastUpdatedDate: '2022-01-01T00:00:00.000Z'
                configuration:
                  keyId: KEY_ID
                  teamId: TEAM_ID
                  fileName: fileName.p8
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/push-providers/ppctekcmngGaqeiBxB0g4
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/push-providers/{pushProviderId}:
    get:
      tags:
        - Push Providers
      summary: Retrieve a Push Provider
      description: Retrieves a push provider by `pushProviderId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: pushProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the push provider
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ppctekcmngGaqeiBxB0g4
                name: APNs Example
                providerType: APNS
                lastUpdatedDate: '2022-01-01T00:00:00.000Z'
                configuration:
                  keyId: KEY_ID
                  teamId: TEAM_ID
                  fileName: fileName.p8
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/push-providers/ppctekcmngGaqeiBxB0g4
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Push Providers
      summary: Replace a Push Provider
      description: Replaces a push provider by `pushProviderId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: APNs Example
                providerType: APNS
                configuration:
                  keyId: KEY_ID
                  teamId: TEAM_ID
                  tokenSigningKey: >-
                    -----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE
                    KEY-----\n
                  fileName: fileName.p8
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: pushProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the push provider
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ppctekcmngGaqeiBxB0g4
                name: APNs Example
                providerType: APNS
                lastUpdatedDate: '2022-01-01T00:00:00.000Z'
                configuration:
                  keyId: KEY_ID
                  teamId: TEAM_ID
                  fileName: fileName.p8
                _links:
                  self:
                    href: >-
                      https://your-subdomain.okta.com/api/v1/push-providers/ppctekcmngGaqeiBxB0g4
                    hints:
                      allow:
                        - DELETE
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Push Providers
      summary: Delete a Push Provider
      description: >-
        Deletes a push provider by `pushProviderId`. If the push provider is
        currently being used in the org by a custom authenticator, the delete
        will not be allowed.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: pushProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Id of the push provider
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '409':
          description: Conflict
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000187
                errorSummary: >-
                  Cannot delete push provider because it is being used by a
                  custom app authenticator.
                errorLink: E0000187
                errorId: oaenwA1ra80S9W-pvbh4m6haA
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/rate-limit-settings/admin-notifications:
    get:
      tags:
        - Rate Limit Settings
      summary: Retrieve the Rate Limit Admin Notification Settings
      description: >-
        Retrieves the currently configured Rate Limit Admin Notification
        Settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                notificationsEnabled: true
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Rate Limit Settings
      summary: Replace the Rate Limit Admin Notification Settings
      description: >-
        Replaces the Rate Limit Admin Notification Settings and returns the
        configured properties
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                notificationsEnabled: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                notificationsEnabled: true
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/rate-limit-settings/per-client:
    get:
      tags:
        - Rate Limit Settings
      summary: Retrieve the Per-Client Rate Limit Settings
      description: Retrieves the currently configured Per-Client Rate Limit Settings
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                defaultMode: ENFORCE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Rate Limit Settings
      summary: Replace the Per-Client Rate Limit Settings
      description: >-
        Replaces the Per-Client Rate Limit Settings and returns the configured
        properties
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                defaultMode: ENFORCE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                defaultMode: ENFORCE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/rate-limit-settings/warning-threshold:
    get:
      tags:
        - Rate Limit Settings
      summary: Retrieve the Rate Limit Warning Threshold Percentage
      description: >-
        Retrieves the currently configured threshold for warning notifications
        when the API's rate limit is exceeded
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                warningThreshold: 66
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Rate Limit Settings
      summary: Replace the Rate Limit Warning Threshold Percentage
      description: >-
        Replaces the Rate Limit Warning Threshold Percentage and returns the
        configured property
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                warningThreshold: 66
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                warningThreshold: 66
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets:
    get:
      tags:
        - Resource Sets
      summary: List all Resource Sets
      description: Lists all Resource Sets with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                resource-sets:
                  - id: iamoJDFKaJxGIr0oamd9g
                    label: SF-IT-1
                    description: First San Francisco IT Resource Set
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                      resources:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources
                      bindings:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
                  - id: iamoJDFKaJxGIr0oamd0q
                    label: SF-IT-2
                    description: Second San Francisco IT Resource Set
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q
                      resources:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q/resources
                      bindings:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q/bindings
                _links:
                  next:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets?after=iamoJDFKaJxGIr0oamd0q
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Resource Sets
      summary: Create a Resource Set
      description: Creates a new Resource Set
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                label: SF-IT-People
                description: People in the IT department of San Francisco
                resources:
                  - https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                  - >-
                    https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users
                  - https://{yourOktaDomain}/api/v1/users
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: iamoJDFKaJxGIr0oamd9g
                label: SF-IT-People
                description: People in the IT department of San Francisco
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                  resources:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}:
    get:
      tags:
        - Resource Sets
      summary: Retrieve a Resource Set
      description: Retrieves a Resource Set by `resourceSetId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: iamoJDFKaJxGIr0oamd9g
                label: SF-IT-People
                description: People in the IT department of San Francisco
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                  resources:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Resource Sets
      summary: Replace a Resource Set
      description: Replaces a Resource Set by `resourceSetId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                label: SF-IT-People
                description: People in the IT department of San Francisco
                resources:
                  - https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                  - >-
                    https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users
                  - https://{yourOktaDomain}/api/v1/users
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: iamoJDFKaJxGIr0oamd9g
                label: SF-IT-People
                description: People in the IT department of San Francisco
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                  resources:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Resource Sets
      summary: Delete a Resource Set
      description: Deletes a role by `resourceSetId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/bindings:
    get:
      tags:
        - Resource Sets
      summary: List all Bindings
      description: Lists all Resource Set bindings with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                roles:
                  - id: cr0WxyzJxGIr0ouum0g4
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0WxyzJxGIr0ouum0g4
                      members:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0WxyzJxGIr0ouum0g4/members
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
                  resource-set:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                  next:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings?after=cr0WxyzJxGIr0ouum0g4
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Resource Sets
      summary: Create a Resource Set Binding
      description: Creates a new Resource Set binding
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                role: cr0Yq6IJxGIr0ouum0g3
                members:
                  - https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
                  resource-set:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}:
    get:
      tags:
        - Resource Sets
      summary: Retrieve a Binding
      description: Retrieves a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: cr0Yq6IJxGIr0ouum0g3
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
                  resource-set:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Resource Sets
      summary: Delete a Binding
      description: Deletes a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members:
    get:
      tags:
        - Resource Sets
      summary: List all Members of a binding
      description: Lists all members of a Resource Set binding with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                members:
                  - id: irb1qe6PGuMc7Oh8N0g4
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/users/00uuk41Hjga5qGfQ30g3
                  - id: irb1q92TFAHzySt3x0g4
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                _links:
                  binding:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3
                  next:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members?after=0ouRq6IJmGIr3ouum0g3
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    patch:
      tags:
        - Resource Sets
      summary: Add more Members to a binding
      description: Adds more members to a Resource Set binding
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                additions:
                  - https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                  - https://{yourOktaDomain}/api/v1/users/00u67DU2qNCjNZYO0g3
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
                  resource-set:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members/{memberId}:
    get:
      tags:
        - Resource Sets
      summary: Retrieve a Member of a binding
      description: Retrieves a member identified by `memberId` for a binding
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: memberId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a member
          example: irb1qe6PGuMc7Oh8N0g4
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: irb1qe6PGuMc7Oh8N0g4
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/users/00uuk41Hjga5qGfQ30g3
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Resource Sets
      summary: Unassign a Member from a binding
      description: Unassigns a member identified by `memberId` from a binding
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: memberId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a member
          example: irb1qe6PGuMc7Oh8N0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/resources:
    get:
      tags:
        - Resource Sets
      summary: List all Resources of a Resource Set
      description: Lists all resources that make up the Resource Set
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                resources:
                  - id: ire106sQKoHoXXsAe0g4
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                  - id: ire106riDrTYl4qA70g4
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users
                  - id: irezvo4AwE2ngpMw40g3
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      users:
                        href: https://{yourOktaDomain}/api/v1/users
                      groups:
                        href: https://{yourOktaDomain}/api/v1/groups
                _links:
                  next:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources?after=irezvn1ZZxLSIBM2J0g3
                  resource-set:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    patch:
      tags:
        - Resource Sets
      summary: Add more Resource to a Resource Set
      description: Adds more resources to a Resource Set
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                additions:
                  - https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3
                  - >-
                    https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: iamoJDFKaJxGIr0oamd9g
                label: SF-IT-People
                description: People in the IT department of San Francisco
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g
                  resources:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources
                  bindings:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/resource-sets/{resourceSetId}/resources/{resourceId}:
    delete:
      tags:
        - Resource Sets
      summary: Delete a Resource from a Resource Set
      description: Deletes a resource identified by `resourceId` from a Resource Set
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: resourceSetId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a Resource Set
          example: iamoJDFKaJxGIr0oamd9g
        - name: resourceId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of a resource
          example: ire106sQKoHoXXsAe0g4
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/risk/events/ip:
    post:
      tags:
        - Risk Events
      summary: Send multiple Risk Events
      description: >-
        Sends multiple IP risk events to Okta.

        This request is used by a third-party risk provider to send IP risk
        events to Okta. The third-party risk provider needs to be registered
        with Okta before they can send events to Okta. See [Risk
        Providers](/openapi/okta-management/management/tag/RiskProvider/).

        This API has a rate limit of 30 requests per minute. You can include
        multiple risk events (up to a maximum of 20 events) in a single payload
        to reduce the number of API calls. Prioritize sending high risk signals
        if you have a burst of signals to send that would exceed the maximum
        request limits.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - timestamp: '2021-01-20T00:00:00.001Z'
                  subjects:
                    - ip: 6.7.6.7
                      riskLevel: MEDIUM
                    - ip: 1.1.1.1
                      riskLevel: HIGH
                      message: Detected Attack tooling and suspicious activity
                - timestamp: '2021-01-20T01:00:00.001Z'
                  subjects:
                    - ip: 6.7.6.7
                      riskLevel: LOW
                    - ip: 2.2.2.2
                      riskLevel: HIGH
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '202':
          description: Accepted
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/risk/providers:
    get:
      tags:
        - Risk Providers
      summary: List all Risk Providers
      description: Lists all Risk Provider objects
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 00rp12r4skkjkjgsn
                  action: log_only
                  name: Risk-Partner-X
                  clientId: 00ckjsfgjkdkjdkkljjsd
                  created: '2021-01-05 22:18:30'
                  lastUpdated: '2021-01-05 22:18:30'
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn
                      hints:
                        allow:
                          - GET
                          - PUT
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Risk Providers
      summary: Create a Risk Provider
      description: >-
        Creates a Risk Provider object. A maximum of three Risk Provider objects
        can be created.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Risk-Partner-X
                action: log_only
                clientId: 00ckjsfgjkdkjdkkljjsd
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 00rp12r4skkjkjgsn
                action: log_only
                name: Risk-Partner-X
                clientId: 00ckjsfgjkdkjdkkljjsd
                created: '2021-01-05 22:18:30'
                lastUpdated: '2021-01-05 22:18:30'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn
                    hints:
                      allow:
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/risk/providers/{riskProviderId}:
    get:
      tags:
        - Risk Providers
      summary: Retrieve a Risk Provider
      description: Retrieves a Risk Provider object by ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: riskProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Risk Provider object
          example: 00rp12r4skkjkjgsn
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 00rp12r4skkjkjgsn
                action: log_only
                name: Risk-Partner-X
                clientId: 00ckjsfgjkdkjdkkljjsd
                created: '2021-01-05 22:18:30'
                lastUpdated: '2021-01-05 22:18:30'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn
                    hints:
                      allow:
                        - GET
                        - PUT
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Risk Providers
      summary: Replace a Risk Provider
      description: Replaces the properties for a given Risk Provider object ID
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Risk-Partner-Y
                action: enforce_and_log
                clientId: 00ckjsfgjkdkjdkkljjsd
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: riskProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Risk Provider object
          example: 00rp12r4skkjkjgsn
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 00rp12r4skkjkjgsn
                action: enforce_and_log
                name: Risk-Partner-Y
                clientId: 00ckjsfgjkdkjdkkljjsd
                created: '2021-01-05 22:18:30'
                lastUpdated: '2021-01-05 23:18:30'
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn
                    hints:
                      allow:
                        - GET
                        - PUT
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Risk Providers
      summary: Delete a Risk Provider
      description: Deletes a Risk Provider object by its ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: riskProviderId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Risk Provider object
          example: 00rp12r4skkjkjgsn
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/roles:
    get:
      tags:
        - Roles
      summary: List all Roles
      description: Lists all roles with pagination support
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                roles:
                  - id: cr0Yq6IJxGIr0ouum0g3
                    label: UserCreator
                    description: Create users
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      permissions:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                  - id: cr0Fw7HKcWIroo88m3r1
                    label: GroupMembershipManager
                    description: Manage group membership
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      permissions:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Fw7HKcWIroo88m3r1/permissions
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Fw7HKcWIroo88m3r1
                _links:
                  next:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles?after=cr0Fw7HKcWIroo88m3r1
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Roles
      summary: Create a Role
      description: Creates a new role
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                label: UserCreator
                description: Create users
                permissions:
                  - okta.users.create
                  - okta.users.read
                  - okta.groups.read
                  - okta.users.userprofile.manage
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: cr0Yq6IJxGIr0ouum0g3
                label: UserCreator
                description: Create users
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  permissions:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/roles/{roleIdOrLabel}:
    get:
      tags:
        - Roles
      summary: Retrieve a Role
      description: Retrieves a role by `roleIdOrLabel`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: cr0Yq6IJxGIr0ouum0g3
                label: UserCreator
                description: Create users
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  permissions:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Roles
      summary: Replace a Role
      description: Replaces a role by `roleIdOrLabel`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                label: UserCreator
                description: Create users
                permissions:
                  - okta.users.create
                  - okta.users.read
                  - okta.groups.read
                  - okta.users.userprofile.manage
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: cr0Yq6IJxGIr0ouum0g3
                label: UserCreator
                description: Create users
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  permissions:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Roles
      summary: Delete a Role
      description: Deletes a role by `roleIdOrLabel`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/roles/{roleIdOrLabel}/permissions:
    get:
      tags:
        - Roles
      summary: List all Permissions
      description: Lists all permissions of the role by `roleIdOrLabel`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                permissions:
                  - label: okta.users.create
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      role:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.create
                  - label: okta.users.read
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      role:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read
                  - label: okta.groups.read
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      role:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.groups.read
                  - label: okta.users.userprofile.manage
                    created: '2021-02-06T16:20:57.000Z'
                    lastUpdated: '2021-02-06T16:20:57.000Z'
                    _links:
                      role:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                      self:
                        href: >-
                          https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.userprofile.manage
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}:
    get:
      tags:
        - Roles
      summary: Retrieve a Permission
      description: Retrieves a permission by `permissionType`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: permissionType
          in: path
          schema:
            type: string
          required: true
          description: (Required) An okta permission type
          example: okta.users.manage
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                label: okta.users.manage
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  role:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.manage
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Roles
      summary: Create a Permission
      description: Creates a permission specified by `permissionType` to the role
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                conditions:
                  include:
                    okta:ResourceAttribute/User/Profile:
                      - city
                      - state
                      - zipCode
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: permissionType
          in: path
          schema:
            type: string
          required: true
          description: (Required) An okta permission type
          example: okta.users.manage
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Roles
      summary: Replace a Permission
      description: Replaces a permission specified by `permissionType` in the role
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                conditions:
                  include:
                    okta:ResourceAttribute/User/Profile:
                      - city
                      - state
                      - zipCode
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: permissionType
          in: path
          schema:
            type: string
          required: true
          description: (Required) An okta permission type
          example: okta.users.manage
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                label: okta.users.read
                conditions:
                  include:
                    okta:ResourceAttribute/User/Profile:
                      - city
                      - state
                      - zipCode
                created: '2021-02-06T16:20:57.000Z'
                lastUpdated: '2021-02-06T16:20:57.000Z'
                _links:
                  role:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Roles
      summary: Delete a Permission
      description: Deletes a permission from a role by `permissionType`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleIdOrLabel
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` or `label` of the role
          example: cr0Yq6IJxGIr0ouum0g3
        - name: permissionType
          in: path
          schema:
            type: string
          required: true
          description: (Required) An okta permission type
          example: okta.users.manage
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles:
    get:
      tags:
        - Role Assignments
      summary: List all Assigned Roles of Group
      description: Lists all assigned roles of group identified by `groupId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - assignmentType: GROUP
                  created: '2019-09-02T00:43:28.201Z'
                  description: consectetur fugiat magna ipsum exercita
                  id: ullamco in ea
                  label: adipisicing incididunt magna
                  lastUpdated: '1988-11-21T15:08:59.860Z'
                  status: ACTIVE
                  type: SUPER_ADMIN
                  _embedded:
                    dolore4d:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    in49d:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - assignmentType: GROUP
                  created: '1955-03-04T05:03:44.614Z'
                  description: qui quis culpa mollit velit
                  id: quis fugiat culpa cillum cupidatat
                  label: occaecat commodo
                  lastUpdated: '1945-11-30T01:57:12.039Z'
                  status: ACTIVE
                  type: GROUP_MEMBERSHIP_ADMIN
                  _embedded:
                    voluptateeed:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    quis_3c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    velitefe:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Role Assignments
      summary: Assign a Role to a Group
      description: Assigns a role to a group
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: HELP_DESK_ADMIN
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: disableNotifications
          in: query
          schema:
            type: boolean
          description: Setting this to `true` grants the group third-party admin status
          example: 'true'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                assignmentType: USER
                created: '1951-10-09T20:28:13.369Z'
                description: amet enim Lorem
                id: quis irure consequat velit
                label: elit velit deserunt
                lastUpdated: '2021-04-11T02:13:42.776Z'
                status: INACTIVE
                type: USER_ADMIN
                _embedded:
                  cupidatat_42: {}
                  mollitf: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}:
    get:
      tags:
        - Role Assignments
      summary: Retrieve a Role assigned to Group
      description: >-
        Retrieves a role identified by `roleId` assigned to group identified by
        `groupId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                assignmentType: USER
                created: '1951-10-09T20:28:13.369Z'
                description: amet enim Lorem
                id: quis irure consequat velit
                label: elit velit deserunt
                lastUpdated: '2021-04-11T02:13:42.776Z'
                status: INACTIVE
                type: USER_ADMIN
                _embedded:
                  cupidatat_42: {}
                  mollitf: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Assignments
      summary: Unassign a Role from a Group
      description: >-
        Unassigns a role identified by `roleId` assigned to group identified by
        `groupId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/iam/assignees/users:
    get:
      tags:
        - Role Assignments
      summary: List all Users with Role Assignments
      description: Lists all users with Role Assignments
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: Specifies the number of results returned. Defaults to `100`.
          example: '100'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                value:
                  - id: 00u118oQYT4TBGuay0g4
                    orn: orn:okta:00o5rb5mt2H3d1TJd0h7:users:00u118oQYT4TBGuay0g4
                    _links:
                      self:
                        href: >-
                          http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4
                      roles:
                        href: >-
                          http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4/roles
                _links:
                  next:
                    href: >-
                      http://your-subdomain.okta.com/api/v1/iam/assignees/users?after=00u118oQYT4TBGuay0g4&limit=1
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles:
    get:
      tags:
        - Role Assignments
      summary: List all Roles assigned to a User
      description: Lists all roles assigned to a user identified by `userId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - assignmentType: GROUP
                  created: '2019-09-02T00:43:28.201Z'
                  description: consectetur fugiat magna ipsum exercita
                  id: ullamco in ea
                  label: adipisicing incididunt magna
                  lastUpdated: '1988-11-21T15:08:59.860Z'
                  status: ACTIVE
                  type: SUPER_ADMIN
                  _embedded:
                    dolore4d:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    in49d:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - assignmentType: GROUP
                  created: '1955-03-04T05:03:44.614Z'
                  description: qui quis culpa mollit velit
                  id: quis fugiat culpa cillum cupidatat
                  label: occaecat commodo
                  lastUpdated: '1945-11-30T01:57:12.039Z'
                  status: ACTIVE
                  type: GROUP_MEMBERSHIP_ADMIN
                  _embedded:
                    voluptateeed:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    quis_3c:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    velitefe:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Role Assignments
      summary: Assign a Role to a User
      description: Assigns a role to a user identified by `userId`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: HELP_DESK_ADMIN
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: disableNotifications
          in: query
          schema:
            type: boolean
          description: Setting this to `true` grants the user third-party admin status
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                assignmentType: USER
                created: '1951-10-09T20:28:13.369Z'
                description: amet enim Lorem
                id: quis irure consequat velit
                label: elit velit deserunt
                lastUpdated: '2021-04-11T02:13:42.776Z'
                status: INACTIVE
                type: USER_ADMIN
                _embedded:
                  cupidatat_42: {}
                  mollitf: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}:
    get:
      tags:
        - Role Assignments
      summary: Retrieve a Role assigned to a User
      description: >-
        Retrieves a role identified by `roleId` assigned to a user identified by
        `userId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                assignmentType: USER
                created: '1951-10-09T20:28:13.369Z'
                description: amet enim Lorem
                id: quis irure consequat velit
                label: elit velit deserunt
                lastUpdated: '2021-04-11T02:13:42.776Z'
                status: INACTIVE
                type: USER_ADMIN
                _embedded:
                  cupidatat_42: {}
                  mollitf: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Assignments
      summary: Unassign a Role from a User
      description: >-
        Unassigns a role identified by `roleId` from a user identified by
        `userId`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps:
    get:
      tags:
        - Role Targets
      summary: List all Application Targets for an Application Administrator Role
      description: >-
        Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This
        methods return list may include full Applications or Instances. The
        response for an instance will have an `ID` value, while Application will
        not have an ID.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - category: sint
                  description: dolor adipisicing
                  displayName: sed c
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: pariatur elit
                  lastUpdated: '1979-02-09T03:02:20.245Z'
                  name: ut amet nostrud fugiat
                  signOnModes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  verificationStatus: officia
                  website: commodo
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - category: ut sit
                  description: aliquip
                  displayName: proident et
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: qui eiusmod
                  lastUpdated: '1969-02-08T23:10:30.758Z'
                  name: ea laboris ad
                  signOnModes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  verificationStatus: magna
                  website: nisi non
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}:
    put:
      tags:
        - Role Targets
      summary: Assign an Application Target to Administrator Role
      description: Assigns an application target to administrator role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: Unassign an Application Target from Application Administrator Role
      description: Unassigns an application target from application administrator role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}:
    put:
      tags:
        - Role Targets
      summary: Assign an Application Instance Target to Application Administrator Role
      description: Assigns App Instance Target to App Administrator Role given to a Group
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: >-
        Unassign an Application Instance Target from an Application
        Administrator Role
      description: >-
        Unassigns an application instance target from application administrator
        role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}/targets/groups:
    get:
      tags:
        - Role Targets
      summary: List all Group Targets for a Group Role
      description: Lists all group targets for a group role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1995-08-20T21:44:43.031Z'
                  id: enim ipsum Ut voluptate
                  lastMembershipUpdated: '2007-08-20T16:50:51.194Z'
                  lastUpdated: '1965-01-05T02:16:15.930Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: OKTA_GROUP
                  _embedded:
                    commodo_53:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2012-08-12T02:57:35.257Z'
                  id: non voluptate
                  lastMembershipUpdated: '1984-07-17T11:29:04.203Z'
                  lastUpdated: '1954-12-04T04:48:25.373Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ea_0: -16626924
                    ut_ba: -66191779.46507646
                  type: OKTA_GROUP
                  _embedded:
                    enim_52:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deserunt_a:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}:
    put:
      tags:
        - Role Targets
      summary: Assign a Group Target to a Group Role
      description: Assigns a group target to a group role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: targetGroupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: 00g1e9dfjHeLAsdX983d
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: Unassign a Group Target from a Group Role
      description: Unassigns a group target from a group role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: targetGroupId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: 00g1e9dfjHeLAsdX983d
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps:
    get:
      tags:
        - Role Targets
      summary: List all Application Targets for Application Administrator Role
      description: >-
        Lists all App targets for an `APP_ADMIN` Role assigned to a User. This
        methods return list may include full Applications or Instances. The
        response for an instance will have an `ID` value, while Application will
        not have an ID.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - category: enim nisi irure
                  description: minim ullamco mollit et
                  displayName: ut sint
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: Excepteur
                  lastUpdated: '1996-07-14T06:08:23.310Z'
                  name: consectetur
                  signOnModes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  verificationStatus: Excepteur proident consequat sed
                  website: in in deserunt aliqua fugiat
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - category: adipisicing tempor
                  description: Ut ex sunt est magna
                  displayName: sunt
                  features:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  id: velit Excepteur nulla
                  lastUpdated: '2017-05-26T22:26:24.252Z'
                  name: ex sit
                  signOnModes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  verificationStatus: mollit nulla
                  website: laborum eiusmod aute
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Role Targets
      summary: Assign all Apps as Target to Role
      description: Assigns all Apps as Target to Role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}:
    put:
      tags:
        - Role Targets
      summary: Assign an Application Target to Administrator Role
      description: Assigns an application target to administrator role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: Unassign an Application Target from an Application Administrator Role
      description: Unassigns an application target from application administrator role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}:
    put:
      tags:
        - Role Targets
      summary: >-
        Assign an Application Instance Target to an Application Administrator
        Role
      description: Assigns anapplication instance target to appplication administrator role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: >-
        Unassign an Application Instance Target from an Application
        Administrator Role
      description: >-
        Unassigns an application instance target from an application
        administrator role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: appName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: oidc_client
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}/targets/groups:
    get:
      tags:
        - Role Targets
      summary: List all Group Targets for Role
      description: Lists all group targets for role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1995-08-20T21:44:43.031Z'
                  id: enim ipsum Ut voluptate
                  lastMembershipUpdated: '2007-08-20T16:50:51.194Z'
                  lastUpdated: '1965-01-05T02:16:15.930Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: OKTA_GROUP
                  _embedded:
                    commodo_53:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2012-08-12T02:57:35.257Z'
                  id: non voluptate
                  lastMembershipUpdated: '1984-07-17T11:29:04.203Z'
                  lastUpdated: '1954-12-04T04:48:25.373Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ea_0: -16626924
                    ut_ba: -66191779.46507646
                  type: OKTA_GROUP
                  _embedded:
                    enim_52:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    deserunt_a:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}:
    put:
      tags:
        - Role Targets
      summary: Assign a Group Target to Role
      description: Assigns a Group Target to Role
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Role Targets
      summary: Unassign a Group Target from Role
      description: Unassigns a Group Target from Role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: roleId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Role
          example: 3Vg1Pjp3qzw4qcCK5EdO
        - name: groupId
          in: path
          schema:
            type: string
          required: true
          description: (Required) The `id` of the group
          example: 00g1emaKYZTWRYYRRTSK
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/apps/{appId}/default:
    get:
      tags:
        - Schemas
      summary: Retrieve the default Application User Schema for an Application
      description: Retrieves the Schema for an App User
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                $schema: irure consequat amet
                created: quis
                definitions:
                  type: object
                  properties:
                    base:
                      type: object
                      properties:
                        id:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        properties:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        required:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        type:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                    custom:
                      type: object
                      properties:
                        id:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        properties:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        required:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                        type:
                          value: >-
                            <Error: Too many levels of nesting to fake this
                            schema>
                id: non labore est
                lastUpdated: irure dolor
                name: anim culpa reprehenderit Ut Excepteur
                properties:
                  profile:
                    allOf:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                title: aliquip nisi irure
                type: anim pariatur proident
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Schemas
      summary: Update the default Application User Schema for an Application
      description: >-
        Partially updates on the User Profile properties of the Application User
        Schema
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                definitions:
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      twitterUserName:
                        title: Twitter username
                        description: User's username for twitter.com
                        type: string
                        required: false
                        minLength: 1
                        maxLength: 20
                    required: []
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: appId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Application ID
          example: 0oafxqCAJWWGELFTYASJ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: >-
                  https://{yourOktaDomain}/meta/schemas/apps/0oa25gejWwdXNnFH90g4/default
                $schema: http://json-schema.org/draft-04/schema#
                name: Example App
                title: Example App User
                lastUpdated: '2017-07-18T23:18:43.000Z'
                created: '2017-07-18T22:35:30.000Z'
                definitions:
                  base:
                    id: '#base'
                    type: object
                    properties:
                      userName:
                        title: Username
                        type: string
                        required: true
                        scope: NONE
                        maxLength: 100
                    required:
                      - userName
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      twitterUserName:
                        title: Twitter username
                        description: User's username for twitter.com
                        type: string
                        scope: NONE
                        minLength: 1
                        maxLength: 20
                    required: []
                type: object
                properties:
                  profile:
                    allOf:
                      - $ref: '#/definitions/base'
                      - $ref: '#/definitions/custom'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/group/default:
    get:
      tags:
        - Schemas
      summary: Retrieve the default Group Schema
      description: Retrieves the group schema
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                $schema: http://json-schema.org/draft-04/schema#
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/meta/schemas/group/default
                    method: GET
                    rel: self
                created: '2021-01-30T00:18:24.000Z'
                definitions:
                  base:
                    id: '#base'
                    properties: {}
                    required:
                      - name
                    type: object
                  custom:
                    id: '#custom'
                    properties:
                      groupContact:
                        description: Group administrative contact
                        master:
                          type: PROFILE_MASTER
                        mutability: READ_WRITE
                        permissions:
                          - action: READ_WRITE
                            principal: SELF
                        scope: NONE
                        title: Group administrative contact
                        type: string
                    required: []
                    type: object
                description: Okta group profile template
                id: https://{yourOktaDomain}/meta/schemas/group/default
                lastUpdated: '2021-02-25T23:05:31.000Z'
                name: group
                properties:
                  profile:
                    allOf:
                      - $ref: '#/definitions/custom'
                      - $ref: '#/definitions/base'
                title: Okta group
                type: object
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Schemas
      summary: Update the default Group Schema
      description: >-
        Updates the default group schema. This updates, adds, or removes one or
        more custom Group Profile properties in the schema.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                definitions:
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      groupContact:
                        title: Group administrative contact
                        description: Group administrative contact
                        type: string
                        required: false
                        minLength: 1
                        maxLength: 20
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required: []
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                Response with a subset of properties for brevity:
                  $ref: '#/components/examples/GroupSchemaResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/logStream:
    get:
      tags:
        - Schemas
      summary: List the Log Stream Schemas
      description: Lists the schema for all log stream types visible for this org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - $schema: https://json-schema.org/draft/2020-12/schema
                  $id: >-
                    http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge
                  title: AWS EventBridge
                  type: object
                  properties:
                    settings:
                      description: Configuration properties specific to AWS EventBridge
                      type: object
                      properties:
                        accountId:
                          title: AWS Account ID
                          description: Your Amazon AWS Account ID.
                          type: string
                          writeOnce: true
                          pattern: ^\d{12}$
                        eventSourceName:
                          title: AWS Event Source Name
                          description: >-
                            An alphanumeric name (no spaces) to identify this
                            event source in AWS EventBridge.
                          type: string
                          writeOnce: true
                          pattern: ^[\.\-_A-Za-z0-9]{1,75}$
                        region:
                          title: AWS Region
                          description: >-
                            The destination AWS region for your system log
                            events.
                          type: string
                          writeOnce: true
                          oneOf:
                            - title: US East (Ohio)
                              const: us-east-2
                            - title: US East (N. Virginia)
                              const: us-east-1
                            - title: US West (N. California)
                              const: us-west-1
                            - title: US West (Oregon)
                              const: us-west-2
                            - title: Canada (Central)
                              const: ca-central-1
                            - title: Europe (Frankfurt)
                              const: eu-central-1
                            - title: Europe (Ireland)
                              const: eu-west-1
                            - title: Europe (London)
                              const: eu-west-2
                            - title: Europe (Paris)
                              const: eu-west-3
                            - title: Europe (Milan)
                              const: eu-south-1
                            - title: Europe (Stockholm)
                              const: eu-north-1
                      required:
                        - eventSourceName
                        - accountId
                        - region
                      errorMessage:
                        properties:
                          accountId: Account number must be 12 digits.
                          eventSourceName: >-
                            Event source name can use numbers, letters, the
                            symbols ".", "-" or "_". It must use fewer than 76
                            characters.
                    name:
                      title: Name
                      description: A name for this log stream in Okta
                      type: string
                      writeOnce: false
                      pattern: ^.{1,100}$
                  required:
                    - name
                    - settings
                  errorMessage:
                    properties:
                      name: Name can't exceed 100 characters.
                - $schema: https://json-schema.org/draft/2020-12/schema
                  $id: >-
                    http://{yourOktaDomain}/api/v1/meta/schemas/logStream/splunk_cloud_logstreaming
                  title: Splunk Cloud
                  type: object
                  properties:
                    settings:
                      description: Configuration properties specific to Splunk Cloud
                      type: object
                      properties:
                        host:
                          title: Host
                          description: >-
                            The domain for your Splunk Cloud instance without
                            http or https. For example: acme.splunkcloud.com
                          type: string
                          writeOnce: false
                          pattern: >-
                            ^([a-z0-9]+(-[a-z0-9]+)*){1,100}\.splunkcloud(gc|fed)?\.com$
                        token:
                          title: HEC Token
                          description: >-
                            The token from your Splunk Cloud HTTP Event
                            Collector (HEC).
                          type: string
                          writeOnce: false
                          pattern: >-
                            [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
                      required:
                        - host
                        - token
                      errorMessage:
                        properties:
                          host: >-
                            Host should be a domain without http or https. For
                            example: acme.splunkcloud.com
                    name:
                      title: Name
                      description: A name for this log stream in Okta
                      type: string
                      writeOnce: false
                      pattern: ^.{1,100}$
                  required:
                    - name
                    - settings
                  errorMessage:
                    properties:
                      name: Name can't exceed 100 characters.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/logStream/{logStreamType}:
    get:
      tags:
        - Schemas
      summary: Retrieve the Log Stream Schema for the schema type
      description: >-
        Retrieves the schema for a Log Stream type. The `logStreamType` element
        in the URL specifies the Log Stream type, which is either
        `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the
        `aws_eventbridge` literal to retrieve the AWS EventBridge type schema,
        and use the `splunk_cloud_logstreaming` literal retrieve the Splunk
        Cloud type schema.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: logStreamType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: aws_eventbridge
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                $schema: https://json-schema.org/draft/2020-12/schema
                $id: >-
                  http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge
                title: AWS EventBridge
                type: object
                properties:
                  settings:
                    description: Configuration properties specific to AWS EventBridge
                    type: object
                    properties:
                      accountId:
                        title: AWS Account ID
                        description: Your Amazon AWS Account ID.
                        type: string
                        writeOnce: true
                        pattern: ^\d{12}$
                      eventSourceName:
                        title: AWS Event Source Name
                        description: >-
                          An alphanumeric name (no spaces) to identify this
                          event source in AWS EventBridge.
                        type: string
                        writeOnce: true
                        pattern: ^[\.\-_A-Za-z0-9]{1,75}$
                      region:
                        title: AWS Region
                        description: The destination AWS region for your system log events.
                        type: string
                        writeOnce: true
                        oneOf:
                          - title: US East (Ohio)
                            const: us-east-2
                          - title: US East (N. Virginia)
                            const: us-east-1
                          - title: US West (N. California)
                            const: us-west-1
                          - title: US West (Oregon)
                            const: us-west-2
                          - title: Canada (Central)
                            const: ca-central-1
                          - title: Europe (Frankfurt)
                            const: eu-central-1
                          - title: Europe (Ireland)
                            const: eu-west-1
                          - title: Europe (London)
                            const: eu-west-2
                          - title: Europe (Paris)
                            const: eu-west-3
                          - title: Europe (Milan)
                            const: eu-south-1
                          - title: Europe (Stockholm)
                            const: eu-north-1
                    required:
                      - eventSourceName
                      - accountId
                      - region
                    errorMessage:
                      properties:
                        accountId: Account number must be 12 digits.
                        eventSourceName: >-
                          Event source name can use numbers, letters, the
                          symbols ".", "-" or "_". It must use fewer than 76
                          characters.
                  name:
                    title: Name
                    description: A name for this log stream in Okta
                    type: string
                    writeOnce: false
                    pattern: ^.{1,100}$
                required:
                  - name
                  - settings
                errorMessage:
                  properties:
                    name: Name can't exceed 100 characters.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/schemas/user/{schemaId}:
    get:
      tags:
        - Schemas
      summary: Retrieve a User Schema
      description: Retrieves the schema for a Schema Id
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: schemaId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: https://{yourOktaDomain}/meta/schemas/user/default
                $schema: http://json-schema.org/draft-04/schema#
                name: user
                title: Default Okta User
                lastUpdated: '2015-09-05T10:40:45.000Z'
                created: '2015-02-02T10:27:36.000Z'
                definitions:
                  base:
                    id: '#base'
                    type: object
                    properties:
                      login:
                        title: Username
                        type: string
                        required: true
                        minLength: 5
                        maxLength: 100
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      firstName:
                        title: First name
                        type: string
                        required: true
                        minLength: 1
                        maxLength: 50
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      lastName:
                        title: Last name
                        type: string
                        required: true
                        minLength: 1
                        maxLength: 50
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      email:
                        title: Primary email
                        type: string
                        required: true
                        format: email
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required:
                      - login
                      - firstName
                      - lastName
                      - email
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      twitterUserName:
                        title: Twitter username
                        description: User's username for twitter.com
                        type: string
                        required: false
                        minLength: 1
                        maxLength: 20
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required: []
                type: object
                properties:
                  profile:
                    allOf:
                      - $ref: '#/definitions/base'
                      - $ref: '#/definitions/custom'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Schemas
      summary: Update a User Schema
      description: Partially updates on the User Profile properties of the user schema
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                definitions:
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      twitterUserName:
                        title: Twitter username
                        description: Twitter Username
                        type: string
                        required: false
                        minLength: 1
                        maxLength: 20
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required: []
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: schemaId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: https://{yourOktaDomain}/meta/schemas/user/default
                $schema: http://json-schema.org/draft-04/schema#
                name: user
                title: Default Okta User
                lastUpdated: '2015-09-05T10:40:45.000Z'
                created: '2015-02-02T10:27:36.000Z'
                definitions:
                  base:
                    id: '#base'
                    type: object
                    properties:
                      login:
                        title: Username
                        type: string
                        required: true
                        minLength: 5
                        maxLength: 100
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      firstName:
                        title: First name
                        type: string
                        required: true
                        minLength: 1
                        maxLength: 50
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      lastName:
                        title: Last name
                        type: string
                        required: true
                        minLength: 1
                        maxLength: 50
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                      email:
                        title: Primary email
                        type: string
                        required: true
                        format: email
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required:
                      - login
                      - firstName
                      - lastName
                      - email
                  custom:
                    id: '#custom'
                    type: object
                    properties:
                      twitterUserName:
                        title: Twitter username
                        description: User's username for twitter.com
                        type: string
                        required: false
                        minLength: 1
                        maxLength: 20
                        permissions:
                          - principal: SELF
                            action: READ_WRITE
                    required: []
                type: object
                properties:
                  profile:
                    allOf:
                      - $ref: '#/definitions/base'
                      - $ref: '#/definitions/custom'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/sessions:
    post:
      tags:
        - Sessions
      summary: Create a Session with session token
      description: >-
        Creates a new Session for a user with a valid session token. Use this
        API if, for example, you want to set the session cookie yourself instead
        of allowing Okta to set it, or want to hold the session ID to delete a
        session through the API instead of visiting the logout URL.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                sessionToken: 00HiohZYpJgMSHwmL9TQy7RRzuY-q9soKp1SPmYYow
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                amr:
                  - pwd
                createdAt: '2019-08-24T14:15:22Z'
                expiresAt: '2019-08-24T14:15:22Z'
                id: l7FbDVqS8zHSy65uJD85
                idp:
                  id: 01a2bcdef3GHIJKLMNOP
                  type: ACTIVE_DIRECTORY
                lastFactorVerification: '2019-08-24T14:15:22Z'
                lastPasswordVerification: '2019-08-24T14:15:22Z'
                login: user@example.com
                status: ACTIVE
                userId: 00u0abcdefGHIJKLMNOP
                _links:
                  self:
                    hints:
                      allow:
                        - DELETE
                  href: >-
                    https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/sessions/me:
    get:
      tags:
        - Sessions
      summary: Retrieve the current Session
      description: >-
        Retrieves Session information for the current user. Use this method in a
        browser-based application to determine if the user is signed in. 


        > **Note:** This operation requires a session cookie for the user. An
        API token isn't allowed for this operation. 
      parameters:
        - name: Cookie
          in: header
          schema:
            type: string
          example: sid=abcde-123 or idx=abcde-123
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                amr:
                  - pwd
                createdAt: '2019-08-24T14:15:22Z'
                expiresAt: '2019-08-24T14:15:22Z'
                id: l7FbDVqS8zHSy65uJD85
                idp:
                  id: 01a2bcdef3GHIJKLMNOP
                  type: ACTIVE_DIRECTORY
                lastFactorVerification: '2019-08-24T14:15:22Z'
                lastPasswordVerification: '2019-08-24T14:15:22Z'
                login: user@example.com
                status: ACTIVE
                userId: 00u0abcdefGHIJKLMNOP
                _links:
                  self:
                    hints:
                      allow:
                        - GET
                        - DELETE
                    href: https://{yourOktaDomain}/api/v1/sessions/me
                  refresh:
                    hints:
                      allow:
                        - POST
                    href: >-
                      https://{yourOktaDomain}/api/v1/sessions/me/lifecycle/refresh
                  user:
                    hints:
                      allow:
                        - GET
                    href: https://{yourOktaDomain}/api/v1/users/me
                    name: User Name
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    delete:
      tags:
        - Sessions
      summary: Close the current Session
      description: >-
        Closes the Session for the user who is currently signed in. Use this
        method in a browser-based application to sign out a user.


        > **Note:** This operation requires a session cookie for the user. An
        API token isn't allowed for this operation.
      parameters:
        - name: Cookie
          in: header
          schema:
            type: string
          example: sid=abcde-123 or idx=abcde-123
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
  /api/v1/sessions/me/lifecycle/refresh:
    post:
      tags:
        - Sessions
      summary: Refresh the current Session
      description: >-
        Refreshes the Session for the current user


        > **Note:** This operation requires a session cookie for the user. An
        API token isn't allowed for this operation.
      requestBody:
        content: {}
      parameters:
        - name: Cookie
          in: header
          schema:
            type: string
          example: sid=abcde-123 or idx=abcde-123
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                amr:
                  - pwd
                createdAt: '2019-08-24T14:15:22Z'
                expiresAt: '2019-08-24T14:15:22Z'
                id: l7FbDVqS8zHSy65uJD85
                idp:
                  id: 01a2bcdef3GHIJKLMNOP
                  type: ACTIVE_DIRECTORY
                lastFactorVerification: '2019-08-24T14:15:22Z'
                lastPasswordVerification: '2019-08-24T14:15:22Z'
                login: user@example.com
                status: ACTIVE
                userId: 00u0abcdefGHIJKLMNOP
                _links:
                  self:
                    hints:
                      allow:
                        - GET
                        - DELETE
                    href: https://{yourOktaDomain}/api/v1/sessions/me
                  refresh:
                    hints:
                      allow:
                        - POST
                    href: >-
                      https://{yourOktaDomain}/api/v1/sessions/me/lifecycle/refresh
                  user:
                    hints:
                      allow:
                        - GET
                    href: https://{yourOktaDomain}/api/v1/users/me
                    name: User Name
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /api/v1/sessions/{sessionId}:
    get:
      tags:
        - Sessions
      summary: Retrieve a Session
      description: >-
        Retrieves information about the Session specified by the given session
        ID
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Session
          example: l7FbDVqS8zHSy65uJD85
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                amr:
                  - pwd
                createdAt: '2019-08-24T14:15:22Z'
                expiresAt: '2019-08-24T14:15:22Z'
                id: l7FbDVqS8zHSy65uJD85
                idp:
                  id: 01a2bcdef3GHIJKLMNOP
                  type: ACTIVE_DIRECTORY
                lastFactorVerification: '2019-08-24T14:15:22Z'
                lastPasswordVerification: '2019-08-24T14:15:22Z'
                login: user@example.com
                status: ACTIVE
                userId: 00u0abcdefGHIJKLMNOP
                _links:
                  self:
                    hints:
                      allow:
                        - DELETE
                  href: >-
                    https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Sessions
      summary: Revoke a Session
      description: Revokes the specified Session
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Session
          example: l7FbDVqS8zHSy65uJD85
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/sessions/{sessionId}/lifecycle/refresh:
    post:
      tags:
        - Sessions
      summary: Refresh a Session
      description: >-
        Refreshes an existing Session using the `id` for that Session. A
        successful response contains the refreshed Session with an updated
        `expiresAt` timestamp.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sessionId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Session
          example: l7FbDVqS8zHSy65uJD85
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                amr:
                  - pwd
                createdAt: '2019-08-25T14:17:22Z'
                expiresAt: '2019-08-25T14:17:22Z'
                id: l7FbDVqS8zHSy65uJD85
                idp:
                  id: 01a2bcdef3GHIJKLMNOP
                  type: ACTIVE_DIRECTORY
                lastFactorVerification: '2019-08-24T14:15:22Z'
                lastPasswordVerification: '2019-08-24T14:15:22Z'
                login: user@example.com
                status: ACTIVE
                userId: 00u0abcdefGHIJKLMNOP
                _links:
                  self:
                    hints:
                      allow:
                        - DELETE
                  href: >-
                    https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/roles/{roleRef}/subscriptions:
    get:
      tags:
        - Subscriptions
      summary: List all Subscriptions for a Role
      description: Lists all subscriptions available to a specified Role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleRef
          in: path
          schema:
            type: string
          required: true
          description: >-
            (Required) A reference to an existing role. Standard roles require a
            `roleType`, while Custom Roles require a `roleId`. See [Standard
            Role
            Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types).
          example: MOBILE_ADMIN
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - channels:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  notificationType: OKTA_UPDATE
                  status: unsubscribed
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - channels:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  notificationType: LDAP_AGENT
                  status: unsubscribed
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/roles/{roleRef}/subscriptions/{notificationType}:
    get:
      tags:
        - Subscriptions
      summary: Retrieve a Subscription for a Role
      description: Retrieves a subscription by `notificationType` for a specified Role
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleRef
          in: path
          schema:
            type: string
          required: true
          description: >-
            (Required) A reference to an existing role. Standard roles require a
            `roleType`, while Custom Roles require a `roleId`. See [Standard
            Role
            Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types).
          example: MOBILE_ADMIN
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channels:
                  - ut sit cupid
                  - magna
                notificationType: OKTA_ISSUE
                status: subscribed
                _links:
                  self:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/roles/{roleRef}/subscriptions/{notificationType}/subscribe:
    post:
      tags:
        - Subscriptions
      summary: Subscribe a Role to a Specific Notification Type
      description: >-
        Subscribes a Role to a specified notification type. Changes to Role
        subscriptions override the subscription status of any individual users
        with the Role.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleRef
          in: path
          schema:
            type: string
          required: true
          description: >-
            (Required) A reference to an existing role. Standard roles require a
            `roleType`, while Custom Roles require a `roleId`. See [Standard
            Role
            Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types).
          example: MOBILE_ADMIN
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribe:
    post:
      tags:
        - Subscriptions
      summary: Unsubscribe a Role from a Specific Notification Type
      description: >-
        Unsubscribes a Role from a specified notification type. Changes to Role
        subscriptions override the subscription status of any individual users
        with the Role.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: roleRef
          in: path
          schema:
            type: string
          required: true
          description: >-
            (Required) A reference to an existing role. Standard roles require a
            `roleType`, while Custom Roles require a `roleId`. See [Standard
            Role
            Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types).
          example: MOBILE_ADMIN
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/subscriptions:
    get:
      tags:
        - Subscriptions
      summary: List all Subscriptions for a User
      description: >-
        Lists all subscriptions available to a specified User. Returns an
        `AccessDeniedException` message if requests are made for another user.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: aliqua
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - channels:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  notificationType: AGENT_AUTO_UPDATE_NOTIFICATION
                  status: unsubscribed
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - channels:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  notificationType: AD_AGENT
                  status: subscribed
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/subscriptions/{notificationType}:
    get:
      tags:
        - Subscriptions
      summary: Retrieve a Subscription for a User
      description: >-
        Retrieves a subscription by `notificationType` for a specified User.
        Returns an `AccessDeniedException` message if requests are made for
        another user.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: aliqua
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                channels:
                  - ut sit cupid
                  - magna
                notificationType: OKTA_ISSUE
                status: subscribed
                _links:
                  self:
                    href:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe:
    post:
      tags:
        - Subscriptions
      summary: Subscribe a User to a Specific Notification Type
      description: >-
        Subscribes the current user to a specified notification type. Returns an
        `AccessDeniedException` message if requests are made for another user.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: aliqua
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe:
    post:
      tags:
        - Subscriptions
      summary: Unsubscribe a User from a Specific Notification Type
      description: >-
        Unsubscribes the current user from a specified notification type.
        Returns an `AccessDeniedException` message if requests are made for
        another user.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: aliqua
        - name: notificationType
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: LDAP_AGENT
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/logs:
    get:
      tags:
        - System Log
      summary: List all System Log Events
      description: >-
        Lists all system log events. The Okta System Log API provides read
        access to your organization’s system log. This API provides more
        functionality than the Events API
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: since
          in: query
          schema:
            type: string
          example: '2022-07-09T22:28:13.484Z'
        - name: until
          in: query
          schema:
            type: string
          example: '2022-07-09T22:28:13.484Z'
        - name: filter
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '100'
        - name: sortOrder
          in: query
          schema:
            type: string
          example: ASCENDING
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - actor:
                    alternateId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    detailEntry:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    displayName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticationContext:
                    authenticationProvider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authenticationStep:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentialProvider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentialType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    externalSessionId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    interface:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  client:
                    device:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    geographicalContext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ipAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userAgent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    zone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  debugContext:
                    debugData:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  displayMessage: reprehenderit voluptate consequat ex
                  eventType: anim nostrud nisi
                  legacyEventType: aute esse
                  outcome:
                    reason:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    result:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  published: '2013-12-12T23:13:49.486Z'
                  request:
                    ipChain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  securityContext:
                    asNumber:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    asOrg:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    domain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isp:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isProxy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  severity: ERROR
                  target:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  transaction:
                    detail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  uuid: ea cupidatat irure mollit anim
                  version: fugi
                - actor:
                    alternateId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    detailEntry:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    displayName:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  authenticationContext:
                    authenticationProvider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    authenticationStep:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentialProvider:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentialType:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    externalSessionId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    interface:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  client:
                    device:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    geographicalContext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ipAddress:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    userAgent:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    zone:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  debugContext:
                    debugData:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  displayMessage: consectetur reprehenderit i
                  eventType: ''
                  legacyEventType: ipsum commodo ullamco fugiat qui
                  outcome:
                    reason:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    result:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  published: '1990-05-21T22:25:07.020Z'
                  request:
                    ipChain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  securityContext:
                    asNumber:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    asOrg:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    domain:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isp:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    isProxy:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  severity: INFO
                  target:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  transaction:
                    detail:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  uuid: proident sint cillum Lorem
                  version: laborum fugiat in
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/templates/sms:
    get:
      tags:
        - SMS Templates
      summary: List all SMS Templates
      description: >-
        Lists all custom SMS templates. A subset of templates can be returned
        that match a template type.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateType
          in: query
          schema:
            type: string
          example: SMS_VERIFY_CODE
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1946-05-09T08:41:46.017Z'
                  id: Excepteur ea elit
                  lastUpdated: '1963-01-26T21:45:10.108Z'
                  name: commodo Lorem
                  template: ''
                  translations: {}
                  type: SMS_VERIFY_CODE
                - created: '1954-08-24T23:46:36.245Z'
                  id: est consequat cillum cupidatat anim
                  lastUpdated: '1947-09-03T01:04:24.192Z'
                  name: aliquip ea eiusmod ut
                  template: enim ea tempor consequat
                  translations: {}
                  type: SMS_VERIFY_CODE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - SMS Templates
      summary: Create an SMS Template
      description: Creates a new custom SMS template
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: elit non officia
                template: cupidatat dolor magna reprehenderit fugiat
                translations: {}
                type: SMS_VERIFY_CODE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2008-03-19T05:25:07.391Z'
                id: fugiat
                lastUpdated: '1956-03-31T06:33:34.946Z'
                name: Lorem
                template: magna veniam do
                translations: {}
                type: SMS_VERIFY_CODE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/templates/sms/{templateId}:
    get:
      tags:
        - SMS Templates
      summary: Retrieve an SMS Template
      description: Retrieves a specific template by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Template
          example: 6NQUJ5yR3bpgEiYmq8IC
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2008-03-19T05:25:07.391Z'
                id: fugiat
                lastUpdated: '1956-03-31T06:33:34.946Z'
                name: Lorem
                template: magna veniam do
                translations: {}
                type: SMS_VERIFY_CODE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - SMS Templates
      summary: Update an SMS Template
      description: Updates an SMS template
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: elit non officia
                template: cupidatat dolor magna reprehenderit fugiat
                translations: {}
                type: SMS_VERIFY_CODE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Template
          example: 6NQUJ5yR3bpgEiYmq8IC
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2008-03-19T05:25:07.391Z'
                id: fugiat
                lastUpdated: '1956-03-31T06:33:34.946Z'
                name: Lorem
                template: magna veniam do
                translations: {}
                type: SMS_VERIFY_CODE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - SMS Templates
      summary: Replace an SMS Template
      description: Replaces the SMS template
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: elit non officia
                template: cupidatat dolor magna reprehenderit fugiat
                translations: {}
                type: SMS_VERIFY_CODE
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Template
          example: 6NQUJ5yR3bpgEiYmq8IC
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2008-03-19T05:25:07.391Z'
                id: fugiat
                lastUpdated: '1956-03-31T06:33:34.946Z'
                name: Lorem
                template: magna veniam do
                translations: {}
                type: SMS_VERIFY_CODE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - SMS Templates
      summary: Delete an SMS Template
      description: Deletes an SMS template
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Template
          example: 6NQUJ5yR3bpgEiYmq8IC
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/threats/configuration:
    get:
      tags:
        - ThreatInsight
      summary: Retrieve the ThreatInsight Configuration
      description: Retrieves the ThreatInsight configuration for the org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                action: none
                excludeZones: []
                created: '2020-08-05T22:18:30.629Z'
                lastUpdated: '2020-08-05T22:18:30.629Z'
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/threats/configuration
                    hints:
                      allow:
                        - GET
                        - POST
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - ThreatInsight
      summary: Update the ThreatInsight Configuration
      description: Updates the ThreatInsight configuration for the org
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                action: audit
                excludeZones:
                  - nzo1q7jEOsoCnoKcj0g4
                  - nzouagptWUz5DlLfM0g3
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                action: audit
                excludeZones:
                  - nzo1q7jEOsoCnoKcj0g4
                  - nzouagptWUz5DlLfM0g3
                created: '2020-08-05T22:18:30.629Z'
                lastUpdated: '2020-10-13T21:23:10.178Z'
                _links:
                  self:
                    href: https://{yourOktaDomain}/api/v1/threats/configuration
                    hints:
                      allow:
                        - GET
                        - POST
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/trustedOrigins:
    get:
      tags:
        - Trusted Origins
      summary: List all Trusted Origins
      description: Lists all trusted origins
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: filter
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          example: '-1'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1997-07-09T17:34:32.052Z'
                  createdBy: labore nulla
                  id: est velit
                  lastUpdated: '1972-04-06T07:39:09.779Z'
                  lastUpdatedBy: id
                  name: adipisicing eiusmod proident et est
                  origin: officia aliquip deserunt
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: commodo
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '1978-08-21T05:03:51.688Z'
                  createdBy: quis eu fugiat
                  id: culpa consectetur Duis
                  lastUpdated: '1960-07-13T09:06:49.015Z'
                  lastUpdatedBy: minim laborum reprehenderit
                  name: pariatu
                  origin: ut nulla proident
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: in Duis
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Trusted Origins
      summary: Create a Trusted Origin
      description: Creates a trusted origin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                createdBy: reprehenderit
                lastUpdatedBy: enim ad est nostrud ex
                name: est nulla consequat proident
                origin: quis
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: cillum nulla cupidatat incididunt
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2009-04-08T13:27:10.267Z'
                createdBy: in in do
                id: 'elit esse '
                lastUpdated: '1965-01-21T03:31:58.230Z'
                lastUpdatedBy: ut fugiat
                name: eu
                origin: nostrud tempor aliqua ea ad
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: incididunt irure
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/trustedOrigins/{trustedOriginId}:
    get:
      tags:
        - Trusted Origins
      summary: Retrieve a Trusted Origin
      description: Retrieves a trusted origin
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trustedOriginId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Trusted Origin
          example: 7j2PkU1nyNIDe26ZNufR
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2009-04-08T13:27:10.267Z'
                createdBy: in in do
                id: 'elit esse '
                lastUpdated: '1965-01-21T03:31:58.230Z'
                lastUpdatedBy: ut fugiat
                name: eu
                origin: nostrud tempor aliqua ea ad
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: incididunt irure
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Trusted Origins
      summary: Replace a Trusted Origin
      description: Replaces a trusted origin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                createdBy: reprehenderit
                lastUpdatedBy: enim ad est nostrud ex
                name: est nulla consequat proident
                origin: quis
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: cillum nulla cupidatat incididunt
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trustedOriginId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Trusted Origin
          example: 7j2PkU1nyNIDe26ZNufR
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2009-04-08T13:27:10.267Z'
                createdBy: in in do
                id: 'elit esse '
                lastUpdated: '1965-01-21T03:31:58.230Z'
                lastUpdatedBy: ut fugiat
                name: eu
                origin: nostrud tempor aliqua ea ad
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: incididunt irure
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Trusted Origins
      summary: Delete a Trusted Origin
      description: Deletes a trusted origin
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trustedOriginId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Trusted Origin
          example: 7j2PkU1nyNIDe26ZNufR
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate:
    post:
      tags:
        - Trusted Origins
      summary: Activate a Trusted Origin
      description: Activates a trusted origin
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trustedOriginId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Trusted Origin
          example: 7j2PkU1nyNIDe26ZNufR
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2009-04-08T13:27:10.267Z'
                createdBy: in in do
                id: 'elit esse '
                lastUpdated: '1965-01-21T03:31:58.230Z'
                lastUpdatedBy: ut fugiat
                name: eu
                origin: nostrud tempor aliqua ea ad
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: incididunt irure
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate:
    post:
      tags:
        - Trusted Origins
      summary: Deactivate a Trusted Origin
      description: Deactivates a trusted origin
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: trustedOriginId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of the Trusted Origin
          example: 7j2PkU1nyNIDe26ZNufR
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '2009-04-08T13:27:10.267Z'
                createdBy: in in do
                id: 'elit esse '
                lastUpdated: '1965-01-21T03:31:58.230Z'
                lastUpdatedBy: ut fugiat
                name: eu
                origin: nostrud tempor aliqua ea ad
                scopes:
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - allowedOktaApps:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                status: incididunt irure
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/uischemas:
    get:
      tags:
        - UI Schema
      summary: List all UI Schemas
      description: Lists all UI Schemas in your org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: uis4a7liocgcRgcxZ0g7
                  uiSchema:
                    type: Group
                    label: Sign in
                    buttonLabel: Submit
                    elements:
                      - type: Control
                        scope: '#/properties/firstName'
                        label: First name
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/lastName'
                        label: Last name
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/email'
                        label: Email
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/countryCode'
                        label: Country code
                        options:
                          format: select
                      - type: Control
                        scope: '#/properties/bool2'
                        label: bool2
                        options:
                          format: checkbox
                      - type: Control
                        scope: '#/properties/date'
                        label: date
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/enum'
                        label: enum
                        options:
                          format: radio
                  created: '2022-07-25T12:56:31.000Z'
                  lastUpdated: '2022-07-26T11:53:59.000Z'
                  _links:
                    self:
                      href: >-
                        https://example.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
                - id: uis4abjqkkKXVPGAU0g7
                  uiSchema:
                    type: Group
                    label: Sign in 2
                    buttonLabel: Submit
                    elements:
                      - type: Control
                        scope: '#/properties/firstName'
                        label: First name
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/lastName'
                        label: Last name
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/email'
                        label: Email
                        options:
                          format: text
                      - type: Control
                        scope: '#/properties/countryCode'
                        label: Country code
                        options:
                          format: select
                      - type: Control
                        scope: '#/properties/bool2'
                        label: bool2
                        options:
                          format: checkbox
                      - type: Control
                        scope: '#/properties/date'
                        label: date
                      - type: Control
                        scope: '#/properties/enum'
                        label: enum
                        options:
                          format: radio
                  created: '2022-07-25T12:56:31.000Z'
                  lastUpdated: '2022-07-26T11:53:59.000Z'
                  _links:
                    self:
                      href: >-
                        https://example.com/api/v1/meta/uischemas/uis4abjqkkKXVPGAU0g7
                      hints:
                        allow:
                          - GET
                          - PUT
                          - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - UI Schema
      summary: Create a UI Schema
      description: Creates an input for an enrollment form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                uiSchema:
                  type: Group
                  elements:
                    - type: Control
                      scope: '#/properties/firstName'
                      label: First Name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/lastName'
                      label: Last Name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/email'
                      label: Primary email
                      options:
                        format: text
                  buttonLabel: Submit
                  label: Sign in
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: uis4a7liocgcRgcxZ0g7
                uiSchema:
                  type: Group
                  label: Sign in
                  buttonLabel: Submit
                  elements:
                    - type: Control
                      scope: '#/properties/firstName'
                      label: First name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/lastName'
                      label: Last name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/email'
                      label: Primary email
                      options:
                        format: text
                created: '2022-07-25T12:56:31.000Z'
                lastUpdated: '2022-07-26T11:53:59.000Z'
                _links:
                  self:
                    href: >-
                      https://exmaple.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/uischemas/{id}:
    get:
      tags:
        - UI Schema
      summary: Retrieve a UI Schema
      description: Retrieves a UI Schema by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique ID of the UI Schema
          example: uis4a7liocgcRgcxZ0g7
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: uis4a7liocgcRgcxZ0g7
                uiSchema:
                  type: Group
                  label: Sign in
                  buttonLabel: Submit
                  elements:
                    - type: Control
                      scope: '#/properties/firstName'
                      label: First name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/lastName'
                      label: Last name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/email'
                      label: Email
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/countryCode'
                      label: Country code
                      options:
                        format: select
                    - type: Control
                      scope: '#/properties/bool2'
                      label: bool2
                      options:
                        format: checkbox
                    - type: Control
                      scope: '#/properties/date'
                      label: date
                    - type: Control
                      scope: '#/properties/enum'
                      label: enum
                      options:
                        format: radio
                created: '2022-07-25T12:56:31.000Z'
                lastUpdated: '2022-07-26T11:53:59.000Z'
                _links:
                  self:
                    href: >-
                      https://exmaple.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - UI Schema
      summary: Replace a UI Schema
      description: Replaces a UI Schema by `id`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                uiSchema:
                  type: Group
                  elements:
                    - type: Control
                      scope: '#/properties/firstName'
                      label: First Name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/lastName'
                      label: Last Name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/email'
                      label: Primary email
                      options:
                        format: text
                  buttonLabel: Submit
                  label: Sign in
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique ID of the UI Schema
          example: uis4a7liocgcRgcxZ0g7
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: uis4a7liocgcRgcxZ0g7
                uiSchema:
                  type: Group
                  label: Sign in
                  buttonLabel: Submit
                  elements:
                    - type: Control
                      scope: '#/properties/firstName'
                      label: First name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/lastName'
                      label: Last name
                      options:
                        format: text
                    - type: Control
                      scope: '#/properties/email'
                      label: Primary email
                      options:
                        format: text
                created: '2022-07-25T12:56:31.000Z'
                lastUpdated: '2022-07-26T11:53:59.000Z'
                _links:
                  self:
                    href: >-
                      https://exmaple.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7
                    hints:
                      allow:
                        - GET
                        - PUT
                        - DELETE
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - UI Schema
      summary: Delete a UI Schema
      description: Deletes a UI Schema by `id`
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The unique ID of the UI Schema
          example: uis4a7liocgcRgcxZ0g7
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users:
    get:
      tags:
        - Users
      summary: List all Users
      description: >-
        Lists all users that do not have a status of 'DEPROVISIONED' (by
        default), up to the maximum (200 for most orgs), with pagination.  A
        subset of users can be returned that match a supported filter expression
        or search criteria.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: q
          in: query
          schema:
            type: string
          description: Finds a user that matches firstName, lastName, and email properties
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: >-
            Specifies the number of results returned. Defaults to 10 if `q` is
            provided.
          example: '200'
        - name: filter
          in: query
          schema:
            type: string
          description: Filters users with a supported expression for a subset of properties
          example: mollit occaecat cupidatat
        - name: search
          in: query
          schema:
            type: string
          description: >-
            Searches for users with a supported filtering expression for most
            properties. Okta recommends using this parameter for search for best
            performance.
          example: mollit occaecat cupidatat
        - name: sortBy
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: sortOrder
          in: query
          schema:
            type: string
          description: >-
            Sorting is done in ASCII sort order (that is, by ASCII character
            value), but isn't case sensitive.
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 00u118oQYT4TBTemp0g4
                  status: ACTIVE
                  created: '2022-04-04T15:56:05.000Z'
                  activated: null
                  statusChanged: null
                  lastLogin: '2022-05-04T19:50:52.000Z'
                  lastUpdated: '2022-05-05T18:15:44.000Z'
                  passwordChanged: '2022-04-04T16:00:22.000Z'
                  type:
                    id: oty1162QAr8hJjTaq0g4
                  profile:
                    firstName: Alice
                    lastName: Smith
                    mobilePhone: null
                    secondEmail: null
                    login: alice.smith@example.com
                    email: alice.smith@example.com
                  credentials:
                    password: {}
                    provider:
                      type: OKTA
                      name: OKTA
                  _links:
                    self:
                      href: >-
                        http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: nisi sunt Excepteur nulla dolor
                errorId: minim et qui commodo ea
                errorLink: laboris esse
                errorSummary: ''
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Users
      summary: Create a User
      description: >-
        Creates a new user in your Okta organization with or without
        credentials<br>

        > **Legal Disclaimer**<br>

        After a user is added to the Okta directory, they receive an activation
        email. As part of signing up for this service,

        you agreed not to use Okta's service/product to spam and/or send
        unsolicited messages.

        Please refrain from adding unrelated accounts to the directory as Okta
        is not responsible for, and disclaims any and all

        liability associated with, the activation email's content. You, and you
        alone, bear responsibility for the emails sent to any recipients.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                profile:
                  city: m
                  costCenter: sunt mollit
                  countryCode: i
                  department: mollit elit cupidatat
                  displayName: est amet eu quis
                  division: ullamco
                  email: 7BfFzf9pkPYb2@qzOKfZbnJqhGadvKPxo.tuxt
                  employeeNumber: dolore qui sit laboris
                  firstName: irure id eius
                  honorificPrefix: in aliqua
                  honorificSuffix: est aliqua in
                  lastName: id
                  locale: cillum
                  login: officia
                  manager: laboris
                  managerId: amet officia
                  middleName: cupidatat
                  mobilePhone: mollit in ut exercitation ea
                  nickName: in dolor ut
                  organization: ipsum sint commodo
                  postalAddress: est
                  preferredLanguage: sed
                  primaryPhone: in
                  profileUrl: qui deserunt
                  secondEmail: 9HKcjICj-NK5ZY@OFeqozeULlPlenzyLLDBqjcSVdGWpJO.wkdl
                  state: cupidatat reprehenderit
                  streetAddress: ipsum enim nisi
                  timezone: tempor deserunt quis reprehenderit
                  title: amet
                  userType: pariatur
                  zipCode: ut occaecat Duis labor
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider: {}
                  recovery_question:
                    answer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                groupIds:
                  - veniam est Excepteur laboris
                  - Lorem officia elit ullamco
                type:
                  id: eiusmod enim consectetur est in
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: activate
          in: query
          schema:
            type: boolean
          description: Executes activation lifecycle operation when creating the user
          example: 'true'
        - name: provider
          in: query
          schema:
            type: boolean
          description: >-
            Indicates whether to create a user with a specified authentication
            provider
          example: 'false'
        - name: nextLogin
          in: query
          schema:
            type: string
          description: >-
            With activate=true, set nextLogin to "changePassword" to have the
            password be EXPIRED, so user must change it the next time they log
            in.
          example: changePassword
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activated: '1970-11-10T03:31:49.024Z'
                created: '1999-12-22T12:08:55.376Z'
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider:
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  recovery_question:
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                id: ut ad sit eu
                lastLogin: '1966-04-23T08:41:47.830Z'
                lastUpdated: '2005-07-24T07:57:56.344Z'
                passwordChanged: '2003-10-22T22:14:04.477Z'
                profile:
                  city: 'velit '
                  costCenter: do eu magna dolore aliqua
                  countryCode: ''
                  department: exercitation aliquip et irure officia
                  displayName: dolor nisi ut aute culpa
                  division: nostrud non ipsum ut
                  email: DMQW@Q.cq
                  employeeNumber: 'consectetur velit sed '
                  firstName: qui in non et in
                  honorificPrefix: aliqua adipisicing qui aliquip
                  honorificSuffix: sit velit
                  lastName: 'occaecat '
                  locale: Duis ex officia
                  login: Lorem qui dolore aliqua
                  manager: cupidatat commodo
                  managerId: ut
                  middleName: ad eu non
                  mobilePhone: non quis culpa velit
                  nickName: incididunt i
                  organization: exercitation eiusmod
                  postalAddress: est eiusmod irure
                  preferredLanguage: fugiat laboris
                  primaryPhone: aliqua
                  profileUrl: non cupidatat Lorem dolore deserunt
                  secondEmail: dkhpZBnf0@BeWdRJVJOKavzkzqDyYiblYwSzqOEwEjD.ns
                  state: tempor ut magna
                  streetAddress: deserunt
                  timezone: laborum sit magna
                  title: ex
                  userType: 'sint voluptate '
                  zipCode: Lore
                status: PASSWORD_EXPIRED
                statusChanged: '1952-04-07T16:58:10.741Z'
                transitioningToStatus: ACTIVE
                type:
                  id: ut in
                _embedded:
                  eu_e65: {}
                  laborum_a65: {}
                  cillum_8e2: {}
                  dolore_5a: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetFactors:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  expirePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changeRecoveryQuestion:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  schema:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  suspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unsuspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlock:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000093
                errorSummary: Target count limit exceeded
                errorLink: E0000093
                errorId: oaePVSLIYnIQsC0B-ptBIllVA
                errorCauses:
                  - errorSummary: The number of group targets is too large.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}:
    get:
      tags:
        - Users
      summary: Retrieve a User
      description: Retrieves a user from your Okta organization
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          description: >-
            An optional parameter to include metadata in the `_embedded`
            attribute. Valid value: `blocks`
          example: blocks
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activated: '2000-03-31T10:50:05.849Z'
                created: '1989-06-04T03:04:32.851Z'
                credentials:
                  password:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  provider:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  recovery_question:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                id: irure
                lastLogin: '1946-04-07T11:22:11.409Z'
                lastUpdated: '2021-11-04T14:21:15.014Z'
                passwordChanged: '1964-01-27T23:35:45.445Z'
                profile:
                  city:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  costCenter:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  countryCode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  department:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  displayName:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  division:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  email:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  employeeNumber:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  firstName:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  honorificPrefix:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  honorificSuffix:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  lastName:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  locale:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  login:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  manager:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  managerId:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  middleName:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  mobilePhone:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  nickName:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  organization:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  postalAddress:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  preferredLanguage:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  primaryPhone:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  profileUrl:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  secondEmail:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  state:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  streetAddress:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  timezone:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  title:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  userType:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  zipCode:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                status: PASSWORD_EXPIRED
                statusChanged: '1950-08-16T11:59:50.076Z'
                transitioningToStatus: PROVISIONED
                type:
                  id:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                _embedded:
                  blocks:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  culpa_c:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  ipsum0e:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - Users
      summary: Update a User
      description: Updates a user partially determined by the request parameters
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider: {}
                  recovery_question:
                    answer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                profile:
                  city: cillum commodo id minim
                  costCenter: deserunt dolor
                  countryCode: q
                  department: proident
                  displayName: commodo qui in cillum dolor
                  division: voluptate non
                  email: GPWUNs7F8e@FxzHHtpHoDCywOzxpMhkEu.ptz
                  employeeNumber: ipsum
                  firstName: amet consequat
                  honorificPrefix: est nisi
                  honorificSuffix: mollit ut officia
                  lastName: labore nostrud aute
                  locale: nisi ea amet
                  login: quis dolore qui nulla id
                  manager: nisi id ali
                  managerId: 'cillum eiusmod '
                  middleName: laboris id
                  mobilePhone: velit occaecat
                  nickName: qui deserunt do nisi
                  organization: aliquip magna irure ad molli
                  postalAddress: qui proident pariatur nisi
                  preferredLanguage: in Ut quis ad
                  primaryPhone: nostrud aliquip
                  profileUrl: magna dolor consequat ut
                  secondEmail: rh3ev@bsyHcnhBIHZCRVoqqsToad.xrnl
                  state: minim laboris aute
                  streetAddress: nostrud Duis eu Ut nulla
                  timezone: culpa laboris sit
                  title: in aliqua
                  userType: officia proident occaecat
                  zipCode: 'Lorem sed commodo veniam '
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: strict
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activated: '1970-11-10T03:31:49.024Z'
                created: '1999-12-22T12:08:55.376Z'
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider:
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  recovery_question:
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                id: ut ad sit eu
                lastLogin: '1966-04-23T08:41:47.830Z'
                lastUpdated: '2005-07-24T07:57:56.344Z'
                passwordChanged: '2003-10-22T22:14:04.477Z'
                profile:
                  city: 'velit '
                  costCenter: do eu magna dolore aliqua
                  countryCode: ''
                  department: exercitation aliquip et irure officia
                  displayName: dolor nisi ut aute culpa
                  division: nostrud non ipsum ut
                  email: DMQW@Q.cq
                  employeeNumber: 'consectetur velit sed '
                  firstName: qui in non et in
                  honorificPrefix: aliqua adipisicing qui aliquip
                  honorificSuffix: sit velit
                  lastName: 'occaecat '
                  locale: Duis ex officia
                  login: Lorem qui dolore aliqua
                  manager: cupidatat commodo
                  managerId: ut
                  middleName: ad eu non
                  mobilePhone: non quis culpa velit
                  nickName: incididunt i
                  organization: exercitation eiusmod
                  postalAddress: est eiusmod irure
                  preferredLanguage: fugiat laboris
                  primaryPhone: aliqua
                  profileUrl: non cupidatat Lorem dolore deserunt
                  secondEmail: dkhpZBnf0@BeWdRJVJOKavzkzqDyYiblYwSzqOEwEjD.ns
                  state: tempor ut magna
                  streetAddress: deserunt
                  timezone: laborum sit magna
                  title: ex
                  userType: 'sint voluptate '
                  zipCode: Lore
                status: PASSWORD_EXPIRED
                statusChanged: '1952-04-07T16:58:10.741Z'
                transitioningToStatus: ACTIVE
                type:
                  id: ut in
                _embedded:
                  eu_e65: {}
                  laborum_a65: {}
                  cillum_8e2: {}
                  dolore_5a: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetFactors:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  expirePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changeRecoveryQuestion:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  schema:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  suspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unsuspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlock:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - Users
      summary: Replace a User
      description: >-
        Replaces a user's profile and/or credentials using strict-update
        semantics
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider: {}
                  recovery_question:
                    answer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                profile:
                  city: dolore incididunt
                  costCenter: laborum laboris sint ex
                  countryCode: d
                  department: nulla ut sit labore est
                  displayName: adipisicing Ut velit dolore
                  division: quis
                  email: L7xFM@GdLxaN.az
                  employeeNumber: ex
                  firstName: dolor
                  honorificPrefix: Excepteur
                  honorificSuffix: minim eiusmod est pariatur
                  lastName: cupidatat comm
                  locale: occaecat magna proident qui quis
                  login: cupidatat amet ad
                  manager: id aliqua
                  managerId: nulla qui dolore dolore
                  middleName: incididunt ullamco
                  mobilePhone: irure
                  nickName: irure
                  organization: laboris
                  postalAddress: consequat ea nisi velit
                  preferredLanguage: Lorem culpa elit amet
                  primaryPhone: sit ex exercitation
                  profileUrl: reprehenderit ex
                  secondEmail: BEw@SnlUVNoxmjGwPbaeDxKVwWGEk.qpv
                  state: irure ut
                  streetAddress: non
                  timezone: proident consequat culpa ut
                  title: consectetur elit lab
                  userType: nulla cillum
                  zipCode: sed qui ad
                type:
                  id: do proident
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetFactors:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  expirePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changeRecoveryQuestion:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  schema:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  suspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unsuspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlock:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: strict
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activated: '1970-11-10T03:31:49.024Z'
                created: '1999-12-22T12:08:55.376Z'
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider:
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  recovery_question:
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                id: ut ad sit eu
                lastLogin: '1966-04-23T08:41:47.830Z'
                lastUpdated: '2005-07-24T07:57:56.344Z'
                passwordChanged: '2003-10-22T22:14:04.477Z'
                profile:
                  city: 'velit '
                  costCenter: do eu magna dolore aliqua
                  countryCode: ''
                  department: exercitation aliquip et irure officia
                  displayName: dolor nisi ut aute culpa
                  division: nostrud non ipsum ut
                  email: DMQW@Q.cq
                  employeeNumber: 'consectetur velit sed '
                  firstName: qui in non et in
                  honorificPrefix: aliqua adipisicing qui aliquip
                  honorificSuffix: sit velit
                  lastName: 'occaecat '
                  locale: Duis ex officia
                  login: Lorem qui dolore aliqua
                  manager: cupidatat commodo
                  managerId: ut
                  middleName: ad eu non
                  mobilePhone: non quis culpa velit
                  nickName: incididunt i
                  organization: exercitation eiusmod
                  postalAddress: est eiusmod irure
                  preferredLanguage: fugiat laboris
                  primaryPhone: aliqua
                  profileUrl: non cupidatat Lorem dolore deserunt
                  secondEmail: dkhpZBnf0@BeWdRJVJOKavzkzqDyYiblYwSzqOEwEjD.ns
                  state: tempor ut magna
                  streetAddress: deserunt
                  timezone: laborum sit magna
                  title: ex
                  userType: 'sint voluptate '
                  zipCode: Lore
                status: PASSWORD_EXPIRED
                statusChanged: '1952-04-07T16:58:10.741Z'
                transitioningToStatus: ACTIVE
                type:
                  id: ut in
                _embedded:
                  eu_e65: {}
                  laborum_a65: {}
                  cillum_8e2: {}
                  dolore_5a: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetFactors:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  expirePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changeRecoveryQuestion:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  schema:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  suspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unsuspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlock:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Delete a User
      description: >-
        Deletes a user permanently. This operation can only be performed on
        users that have a `DEPROVISIONED` status.  **This action cannot be
        recovered!**. Calling this on an `ACTIVE` user will transition the user
        to `DEPROVISIONED`.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCauses:
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - errorSummary:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                errorCode: consectetur do
                errorId: in laborum
                errorLink: ad
                errorSummary: anim nisi sed
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/appLinks:
    get:
      tags:
        - Users
      summary: List all Assigned Application Links
      description: >-
        Lists all appLinks for all direct or indirect (via group membership)
        assigned applications
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - appAssignmentId: reprehenderit ipsum aliqua
                  appInstanceId: ex
                  appName: laboris et fugiat occaecat est
                  credentialsSetup: false
                  hidden: false
                  id: enim dolore
                  label: ipsum ve
                  linkUrl: et deserunt irure Du
                  logoUrl: incididunt
                  sortOrder: 53565505
                - appAssignmentId: pariatur nostrud est velit
                  appInstanceId: Lorem aute do
                  appName: aliqu
                  credentialsSetup: true
                  hidden: false
                  id: et ipsum
                  label: Excepteur dolore in proident culpa
                  linkUrl: minim nulla
                  logoUrl: occaecat voluptate ea Duis
                  sortOrder: -16586985
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/blocks:
    get:
      tags:
        - Users
      summary: List all User Blocks
      description: >-
        Lists information about how the user is blocked from accessing their
        account
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - type: DEVICE_BASED
                  appliesTo: UNKNOWN_DEVICES
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/clients:
    get:
      tags:
        - Users
      summary: List all Clients
      description: >-
        Lists all client resources for which the specified user has grants or
        tokens
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - client_id: ipsum sit
                  client_name: aliquip esse tempor
                  client_uri: et null
                  logo_uri: proi
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - client_id: laboris Lorem non eu
                  client_name: est esse ut sint
                  client_uri: Lorem non ea sunt
                  logo_uri: ut dolore sit
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/clients/{clientId}/grants:
    get:
      tags:
        - Users
      summary: List all Grants for a Client
      description: Lists all grants for a specified user and client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - issuer: https://my_test_okta_org.oktapreview.com
                  scopeId: okta.users.read
                  clientId: labore esse aliquip sunt elit
                  created: '1998-07-27T09:46:28.023Z'
                  createdBy:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: exercitation eiusm
                  lastUpdated: '1963-05-31T23:55:44.047Z'
                  source: ADMIN
                  status: ACTIVE
                  userId: dolore sint ullamco laborum veniam
                  _embedded:
                    scope:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - issuer: https://my_test_okta_org.oktapreview.com
                  scopeId: okta.users.read
                  clientId: incididunt nisi in
                  created: '2013-07-14T23:04:09.677Z'
                  createdBy:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: pariatur aliquip ea Excepteur
                  lastUpdated: '1994-03-31T15:29:37.602Z'
                  source: ADMIN
                  status: ACTIVE
                  userId: ad
                  _embedded:
                    scope:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Revoke all Grants for a Client
      description: Revokes all grants for the specified user and client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/clients/{clientId}/tokens:
    get:
      tags:
        - Users
      summary: List all Refresh Tokens for a Client
      description: Lists all refresh tokens issued for the specified User and Client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - clientId: nostrud do dolore
                  created: '2005-04-20T05:35:43.754Z'
                  expiresAt: '1993-01-15T04:32:24.187Z'
                  id: qui aute
                  issuer: ut consequat
                  lastUpdated: '2022-09-22T07:05:28.458Z'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  userId: eiusmod elit laboris
                  _embedded:
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - clientId: tempor fugiat proident Duis
                  created: '2003-03-03T09:40:20.769Z'
                  expiresAt: '1996-02-10T23:54:32.866Z'
                  id: ut cu
                  issuer: voluptate ut ea nisi
                  lastUpdated: '1972-07-18T00:27:50.086Z'
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  status: ACTIVE
                  userId: enim Ut ullamco in
                  _embedded:
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Revoke all Refresh Tokens for a Client
      description: Revokes all refresh tokens issued for the specified User and Client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}:
    get:
      tags:
        - Users
      summary: Retrieve a Refresh Token for a Client
      description: Retrieves a refresh token issued for the specified User and Client
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                clientId: quis enim Duis
                created: '2012-10-04T04:56:39.064Z'
                expiresAt: '2006-05-12T16:41:46.544Z'
                id: dolore dolor aute
                issuer: officia
                lastUpdated: '2023-01-11T00:15:38.403Z'
                scopes:
                  - nulla exercitation esse
                  - mollit culpa magna nostrud dolore
                status: ACTIVE
                userId: consectetur
                _embedded:
                  scopes:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  revoke:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  client:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  user:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  authorizationServer:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Revoke a Token for a Client
      description: Revokes the specified refresh token
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: clientId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `client_id` of the app
          example: 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD
        - name: tokenId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of Token
          example: sHHSth53yJAyNSTQKDJZ
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/credentials/change_password:
    post:
      tags:
        - Users
      summary: Change Password
      description: >-
        Changes a user's password by validating the user's current password.
        This operation can only be performed on users in `STAGED`, `ACTIVE`,
        `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password
        credential
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                newPassword:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  value: sed dolor sint eiusmod
                oldPassword:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  value: sed quis dolor
                revokeSessions: true
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: strict
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                password:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                provider:
                  name: ut ea exercitation ut
                  type: IMPORT
                recovery_question:
                  question: fugiat esse dolor ex
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/credentials/change_recovery_question:
    post:
      tags:
        - Users
      summary: Change Recovery Question
      description: >-
        Changes a user's recovery question & answer credential by validating the
        user's current password.  This operation can only be performed on users
        in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid
        password credential
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                password:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  value: Ut dolor eiusmod
                provider: {}
                recovery_question:
                  answer: eiusmod aliqua fugiat ut magn
                  question: elit quis cillum ad
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                password:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                provider:
                  name: ut ea exercitation ut
                  type: IMPORT
                recovery_question:
                  question: fugiat esse dolor ex
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/credentials/forgot_password:
    post:
      tags:
        - Users
      summary: Initiate Forgot Password
      description: >-
        Initiates the forgot password flow. Generates a one-time token (OTT)
        that can be used to reset a user's password.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                resetPasswordUrl: occaecat proid
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/credentials/forgot_password_recovery_question:
    post:
      tags:
        - Users
      summary: Reset Password with Recovery Question
      description: >-
        Resets the user's password to the specified password if the provided
        answer to the recovery question is correct
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                password:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  value: Ut dolor eiusmod
                provider: {}
                recovery_question:
                  answer: eiusmod aliqua fugiat ut magn
                  question: elit quis cillum ad
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                password:
                  hash:
                    algorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    digestAlgorithm:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iterationCount:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keySize:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    salt:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    saltOrder:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    value:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    workFactor:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  hook:
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                provider:
                  name: ut ea exercitation ut
                  type: IMPORT
                recovery_question:
                  question: fugiat esse dolor ex
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/grants:
    get:
      tags:
        - Users
      summary: List all User Grants
      description: Lists all grants for the specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: scopeId
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - issuer: https://my_test_okta_org.oktapreview.com
                  scopeId: okta.users.read
                  clientId: labore esse aliquip sunt elit
                  created: '1998-07-27T09:46:28.023Z'
                  createdBy:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: exercitation eiusm
                  lastUpdated: '1963-05-31T23:55:44.047Z'
                  source: ADMIN
                  status: ACTIVE
                  userId: dolore sint ullamco laborum veniam
                  _embedded:
                    scope:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - issuer: https://my_test_okta_org.oktapreview.com
                  scopeId: okta.users.read
                  clientId: incididunt nisi in
                  created: '2013-07-14T23:04:09.677Z'
                  createdBy:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  id: pariatur aliquip ea Excepteur
                  lastUpdated: '1994-03-31T15:29:37.602Z'
                  source: ADMIN
                  status: ACTIVE
                  userId: ad
                  _embedded:
                    scope:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Revoke all User Grants
      description: Revokes all grants for a specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/grants/{grantId}:
    get:
      tags:
        - Users
      summary: Retrieve a User Grant
      description: Retrieves a grant for the specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: expand
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: grantId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Grant ID
          example: iJoqkwx50mrgX4T9LcaH
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                issuer: https://my_test_okta_org.oktapreview.com
                scopeId: okta.users.read
                clientId: in dolor quis
                created: '1947-10-23T01:47:14.008Z'
                createdBy:
                  id: do cupidatat pariatur
                  type: User
                id: Ut adipisicing
                lastUpdated: '1959-08-22T03:38:56.803Z'
                source: ADMIN
                status: ACTIVE
                userId: sit adipisicing
                _embedded:
                  scope:
                    id:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  app:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  client:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Revoke a User Grant
      description: Revokes one grant for a specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: grantId
          in: path
          schema:
            type: string
          required: true
          description: (Required) Grant ID
          example: iJoqkwx50mrgX4T9LcaH
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/groups:
    get:
      tags:
        - Users
      summary: List all Groups
      description: Lists all groups of which the user is a member
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          description: >-
            The cursor to use for pagination. It is an opaque string that
            specifies your current location in the list and is obtained from the
            `Link` response header. See [Pagination](/#pagination).
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: integer
          description: A limit on the number of objects to return
          example: '20'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '2021-07-13T06:59:32.090Z'
                  id: elit dolor
                  lastMembershipUpdated: '2020-11-07T12:55:04.132Z'
                  lastUpdated: '2002-12-08T01:36:22.060Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    doloref: in Lorem quis ipsum magna
                  type: BUILT_IN
                  _embedded:
                    enimc:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ullamco_0:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2001-03-29T01:06:12.622Z'
                  id: nulla aliqua et
                  lastMembershipUpdated: '1976-06-28T11:11:45.504Z'
                  lastUpdated: '1977-10-01T04:39:51.347Z'
                  objectClass:
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                    - value: '<Error: Too many levels of nesting to fake this schema>'
                  profile:
                    description:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  type: APP_GROUP
                  _embedded:
                    officia_4:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    dolore_1:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/idps:
    get:
      tags:
        - Users
      summary: List all Identity Providers
      description: Lists the IdPs associated with the user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1973-05-09T13:38:42.636Z'
                  id: incididunt occaecat proident
                  issuerMode: CUSTOM_URL
                  lastUpdated: '1989-12-05T21:32:46.810Z'
                  name: enim fugiat qui ipsum
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  properties:
                    additionalAmr:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  protocol:
                    algorithms:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentials:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    endpoints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    relayState:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    settings:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  type: IWA
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2020-06-12T14:31:19.369Z'
                  id: est tempor culpa labore sint
                  issuerMode: DYNAMIC
                  lastUpdated: '1996-07-24T07:46:25.934Z'
                  name: commodo
                  policy:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  properties:
                    additionalAmr:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  protocol:
                    algorithms:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credentials:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    endpoints:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    issuer:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    relayState:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    scopes:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    settings:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  status: INACTIVE
                  type: LINKEDIN
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/activate:
    post:
      tags:
        - Users
      summary: Activate a User
      description: >-
        Activates a user. This operation can only be performed on users with a
        `STAGED` or `DEPROVISIONED` status.

        Activation of a user is an asynchronous operation. The user will have
        the `transitioningToStatus`

        property with a value of `ACTIVE` during activation to indicate that the
        user hasn't completed the asynchronous operation.

        The user will have a status of `ACTIVE` when the activation process is
        complete.

        > **Multibrand and User activation**<br>

        If you want to send a branded User Activation email, change the
        subdomain of your request to the custom domain that's associated with
        the brand.

        For example, change `subdomain.okta.com` to `custom.domain.one`. See
        [Multibrand and custom
        domains](https://developer.okta.com/docs/concepts/brands/#multibrand-and-custom-domains).

        <br><br>

        > **Legal disclaimer**<br>

        After a user is added to the Okta directory, they receive an activation
        email. As part of signing up for this service,

        you agreed not to use Okta's service/product to spam and/or send
        unsolicited messages.

        Please refrain from adding unrelated accounts to the directory as Okta
        is not responsible for, and disclaims any and all

        liability associated with, the activation email's content. You, and you
        alone, bear responsibility for the emails sent to any recipients.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          description: (Required) Sends an activation email to the user if true
          example: 'true'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activationToken: deserunt cupidatat culpa
                activationUrl: reprehenderit sint
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/deactivate:
    post:
      tags:
        - Users
      summary: Deactivate a User
      description: >-
        Deactivates a user. This operation can only be performed on users that
        do not have a `DEPROVISIONED` status. While the asynchronous operation
        (triggered by HTTP header `Prefer: respond-async`) is proceeding the
        user's `transitioningToStatus` property is `DEPROVISIONED`. The user's
        status is `DEPROVISIONED` when the deactivation process is complete.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/expire_password:
    post:
      tags:
        - Users
      summary: Expire Password
      description: >-
        Expires a user's password and transitions the user to the status of
        `PASSWORD_EXPIRED` so that the user is required to change their password
        at their next login
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activated: '1970-11-10T03:31:49.024Z'
                created: '1999-12-22T12:08:55.376Z'
                credentials:
                  password:
                    hash:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    hook:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  provider:
                    name:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    type:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  recovery_question:
                    question:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                id: ut ad sit eu
                lastLogin: '1966-04-23T08:41:47.830Z'
                lastUpdated: '2005-07-24T07:57:56.344Z'
                passwordChanged: '2003-10-22T22:14:04.477Z'
                profile:
                  city: 'velit '
                  costCenter: do eu magna dolore aliqua
                  countryCode: ''
                  department: exercitation aliquip et irure officia
                  displayName: dolor nisi ut aute culpa
                  division: nostrud non ipsum ut
                  email: DMQW@Q.cq
                  employeeNumber: 'consectetur velit sed '
                  firstName: qui in non et in
                  honorificPrefix: aliqua adipisicing qui aliquip
                  honorificSuffix: sit velit
                  lastName: 'occaecat '
                  locale: Duis ex officia
                  login: Lorem qui dolore aliqua
                  manager: cupidatat commodo
                  managerId: ut
                  middleName: ad eu non
                  mobilePhone: non quis culpa velit
                  nickName: incididunt i
                  organization: exercitation eiusmod
                  postalAddress: est eiusmod irure
                  preferredLanguage: fugiat laboris
                  primaryPhone: aliqua
                  profileUrl: non cupidatat Lorem dolore deserunt
                  secondEmail: dkhpZBnf0@BeWdRJVJOKavzkzqDyYiblYwSzqOEwEjD.ns
                  state: tempor ut magna
                  streetAddress: deserunt
                  timezone: laborum sit magna
                  title: ex
                  userType: 'sint voluptate '
                  zipCode: Lore
                status: PASSWORD_EXPIRED
                statusChanged: '1952-04-07T16:58:10.741Z'
                transitioningToStatus: ACTIVE
                type:
                  id: ut in
                _embedded:
                  eu_e65: {}
                  laborum_a65: {}
                  cillum_8e2: {}
                  dolore_5a: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  activate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  resetFactors:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  expirePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  forgotPassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changeRecoveryQuestion:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  deactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  reactivate:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  changePassword:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  schema:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  suspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unsuspend:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  unlock:
                    value: '<Error: Too many levels of nesting to fake this schema>'
                  type:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/expire_password_with_temp_password:
    post:
      tags:
        - Users
      summary: Expire Password and Set Temporary Password
      description: >-
        Expires a user's password and transitions the user to the status of
        `PASSWORD_EXPIRED` so that the user is required to change their password
        at their next login, and also sets the user's password to a temporary
        password returned in the response
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: revokeSessions
          in: query
          schema:
            type: boolean
          description: >-
            When set to `true` (and the session is a user session), all user
            sessions are revoked except the current session.
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                tempPassword: in laboris
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/reactivate:
    post:
      tags:
        - Users
      summary: Reactivate a User
      description: >-
        Reactivates a user.  This operation can only be performed on users with
        a `PROVISIONED` status.  This operation restarts the activation workflow
        if for some reason the user activation was not completed when using the
        activationToken from [Activate User](#activate-user).
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          description: Sends an activation email to the user if true
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                activationToken: deserunt cupidatat culpa
                activationUrl: reprehenderit sint
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/reset_factors:
    post:
      tags:
        - Users
      summary: Reset all Factors
      description: >-
        Resets all factors for the specified user. All MFA factor enrollments
        returned to the unenrolled state. The user's status remains ACTIVE. This
        link is present only if the user is currently enrolled in one or more
        MFA factors.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: removeRecoveryEnrollment
          in: query
          schema:
            type: boolean
          description: >-
            If `true`, removes the phone number as both a recovery method and a
            Factor. Supported Factors: `sms` and `call`
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/reset_password:
    post:
      tags:
        - Users
      summary: Generate a Reset Password Token
      description: >-
        Generates a one-time token (OTT) that can be used to reset a user's
        password.  The OTT link can be automatically emailed to the user or
        returned to the API caller and distributed using a custom flow.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: sendEmail
          in: query
          schema:
            type: boolean
          description: '(Required) '
          example: 'true'
        - name: revokeSessions
          in: query
          schema:
            type: boolean
          description: >-
            When set to `true` (and the session is a user session), all user
            sessions are revoked except the current session.
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                resetPasswordUrl: occaecat proid
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/suspend:
    post:
      tags:
        - Users
      summary: Suspend a User
      description: >-
        Suspends a user.  This operation can only be performed on users with an
        `ACTIVE` status.  The user will have a status of `SUSPENDED` when the
        process is complete.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/unlock:
    post:
      tags:
        - Users
      summary: Unlock a User
      description: >-
        Unlocks a user with a `LOCKED_OUT` status or unlocks a user with an
        `ACTIVE` status that is blocked from unknown devices. Unlocked users
        have an `ACTIVE` status and can sign in with their current password.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/lifecycle/unsuspend:
    post:
      tags:
        - Users
      summary: Unsuspend a User
      description: >-
        Unsuspends a user and returns them to the `ACTIVE` state.  This
        operation can only be performed on users that have a `SUSPENDED` status.
      requestBody:
        content: {}
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}:
    put:
      tags:
        - Users
      summary: Create a Linked Object for two Users
      description: Creates a Linked Object for two users
      requestBody:
        content: {}
      security:
        - oauth2Auth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: primaryRelationshipName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
        - name: primaryUserId
          in: path
          schema:
            type: string
          required: true
          description: (Required) `id` of primary User
          example: ctxeQ5JnAVdGFBB7Zr7W
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/linkedObjects/{relationshipName}:
    get:
      tags:
        - Users
      summary: List all Linked Objects
      description: >-
        Lists all linked objects for a user, relationshipName can be a primary
        or associated relationship name
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: after
          in: query
          schema:
            type: string
          example: mollit occaecat cupidatat
        - name: limit
          in: query
          schema:
            type: number
          example: '-1'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: relationshipName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - Users
      summary: Delete a Linked Object
      description: >-
        Deletes linked objects for a user, relationshipName can be ONLY a
        primary relationship name
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: relationshipName
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/sessions:
    delete:
      tags:
        - Users
      summary: Revoke all User Sessions
      description: >-
        Revokes all active identity provider sessions of the user. This forces
        the user to authenticate on the next operation. Optionally revokes
        OpenID Connect and OAuth refresh and access tokens issued to the user.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: oauthTokens
          in: query
          schema:
            type: boolean
          description: Revoke issued OpenID Connect and OAuth refresh and access tokens
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors:
    get:
      tags:
        - User Factors
      summary: List all enrolled Factors
      description: Lists all enrolled Factors for the specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1978-12-06T18:55:17.724Z'
                  factorType: webauthn
                  id: sed dolore molli
                  lastUpdated: '2001-07-28T02:57:35.288Z'
                  profile: {}
                  provider: CUSTOM
                  status: NOT_SETUP
                  vendorName: OKTA
                  _embedded:
                    ea_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    in_8:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    aute_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    occaecatd:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2010-02-24T09:16:51.880Z'
                  factorType: sms
                  id: commodo quis anim sunt
                  lastUpdated: '1956-12-11T05:57:11.531Z'
                  profile: {}
                  provider: SYMANTEC
                  status: ENROLLED
                  vendorName: OKTA
                  _embedded:
                    nulla_f62:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - User Factors
      summary: Enroll a Factor
      description: Enrolls a supported Factor for the specified user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                factorType: webauthn
                profile: {}
                provider: OKTA
                status: ENROLLED
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: updatePhone
          in: query
          schema:
            type: boolean
          description: >-
            If `true`, indicates that you'll update the `phoneNumber`. Only used
            for `sms` Factors that are pending activation.
          example: 'false'
        - name: templateId
          in: query
          schema:
            type: string
          description: >-
            ID of an existing custom SMS template. See the [SMS Templates
            API](../Template). Only used by `sms` Factors.
          example: cstk2flOtuCMDJK4b0g3
        - name: tokenLifetimeSeconds
          in: query
          schema:
            type: integer
          description: Defines how long the token remains valid
          example: '300'
        - name: activate
          in: query
          schema:
            type: boolean
          description: >-
            If `true`, the `sms` Factor is immediately activated as part of the
            enrollment. An activation text message isn't sent to the device.
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1982-01-05T14:24:26.561Z'
                factorType: token
                id: Ut
                lastUpdated: '1953-07-29T17:46:05.037Z'
                profile: {}
                provider: SYMANTEC
                status: EXPIRED
                vendorName: OKTA
                _embedded:
                  nisi9: {}
                  do_665: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/catalog:
    get:
      tags:
        - User Factors
      summary: List all supported Factors
      description: >-
        Lists all the supported Factors that can be enrolled for the specified
        user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - created: '1978-12-06T18:55:17.724Z'
                  factorType: webauthn
                  id: sed dolore molli
                  lastUpdated: '2001-07-28T02:57:35.288Z'
                  profile: {}
                  provider: CUSTOM
                  status: NOT_SETUP
                  vendorName: OKTA
                  _embedded:
                    ea_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    in_8:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    aute_:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    occaecatd:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                - created: '2010-02-24T09:16:51.880Z'
                  factorType: sms
                  id: commodo quis anim sunt
                  lastUpdated: '1956-12-11T05:57:11.531Z'
                  profile: {}
                  provider: SYMANTEC
                  status: ENROLLED
                  vendorName: OKTA
                  _embedded:
                    nulla_f62:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  _links:
                    self:
                      value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/questions:
    get:
      tags:
        - User Factors
      summary: List all supported Security Questions
      description: Lists all available Security Questions for the specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - question: disliked_food
                  questionText: What is the food you least liked as a child?
                - question: name_of_first_plush_toy
                  questionText: What is the name of your first stuffed animal?
                - question: first_award
                  questionText: What did you earn your first medal or award for?
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/{factorId}:
    get:
      tags:
        - User Factors
      summary: Retrieve a Factor
      description: Retrieves an existing Factor for the specified user
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1982-01-05T14:24:26.561Z'
                factorType: token
                id: Ut
                lastUpdated: '1953-07-29T17:46:05.037Z'
                profile: {}
                provider: SYMANTEC
                status: EXPIRED
                vendorName: OKTA
                _embedded:
                  nisi9: {}
                  do_665: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - User Factors
      summary: Unenroll a Factor
      description: >-
        Unenrolls an existing Factor for the specified user. This allows the
        user to enroll a new Factor.


        > **Note**: If you unenroll the `push` or the `signed_nonce` Factors,
        Okta also unenrolls any other `totp`, `signed_nonce`, or Okta Verify
        `push` Factors associated with the user.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: removeRecoveryEnrollment
          in: query
          schema:
            type: boolean
          description: >-
            If `true`, removes the the phone number as both a recovery method
            and a Factor. Only used for `sms` and `call` Factors.
          example: 'false'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate:
    post:
      tags:
        - User Factors
      summary: Activate a Factor
      description: >-
        Activates a Factor. The `sms` and `token:software:totp` factor types
        require activation to complete the enrollment process.


        Okta enforces a rate limit of five activation attempts within five
        minutes.

        After a user exceeds the rate limit, Okta returns an error message.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                attestation: commodo adipisicing nisi
                clientData: mollit consectetur qui aute
                passCode: pariatu
                registrationData: in esse do
                stateToken: laboris do
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1982-01-05T14:24:26.561Z'
                factorType: token
                id: Ut
                lastUpdated: '1953-07-29T17:46:05.037Z'
                profile: {}
                provider: SYMANTEC
                status: EXPIRED
                vendorName: OKTA
                _embedded:
                  nisi9: {}
                  do_665: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/{factorId}/resend:
    post:
      tags:
        - User Factors
      summary: Resend a Factor enrollment
      description: >-
        Resends an `sms`, `call`, or `email` factor challenge as part of an
        enrollment flow.


        For `call` and `sms` factors, Okta enforces a rate limit of one OTP
        challenge per device every 30 seconds. You can configure your `sms` and
        `call` factors to use a third-party telephony provider. See the
        [Telephony inline hook
        reference](https://developer.okta.com/docs/reference/telephony-hook/).
        Okta round-robins between SMS providers with every resend request to
        help ensure delivery of an SMS and Call OTPs across different carriers.


        > **Note**: Resend operations aren't allowed after a factor exceeds the
        activation rate limit. See [Activate a
        Factor](./#tag/UserFactor/operation/activateFactor).
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                factorType: webauthn
                profile: {}
                provider: OKTA
                status: ENROLLED
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: query
          schema:
            type: string
          description: >-
            ID of an existing custom SMS template. See the [SMS Templates
            API](../Template). Only used by `sms` Factors.
          example: cstk2flOtuCMDJK4b0g3
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created: '1982-01-05T14:24:26.561Z'
                factorType: token
                id: Ut
                lastUpdated: '1953-07-29T17:46:05.037Z'
                profile: {}
                provider: SYMANTEC
                status: EXPIRED
                vendorName: OKTA
                _embedded:
                  nisi9: {}
                  do_665: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}:
    get:
      tags:
        - User Factors
      summary: Retrieve a Factor transaction status
      description: Retrieves the status of a `push` Factor verification transaction
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
        - name: transactionId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Factor verification transaction
          example: gPAQcN3NDjSGOCAeG2Jv
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiresAt: '1985-10-11T05:47:32.854Z'
                factorResult: WAITING
                factorResultMessage: in sunt tempor Ut
                _embedded:
                  proident_dc_: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/users/{userId}/factors/{factorId}/verify:
    post:
      tags:
        - User Factors
      summary: Verify a Factor
      description: >-
        Verifies an OTP for a Factor. Some Factors (`call`, `email`, `push`,
        `sms`, `u2f`, and `webauthn`) require Okta to issue a challenge to
        initiate the transaction. Do this by making a request without a body.
        After a challenge is issued, make another request to verify the Factor.


        **Note**: To verify a `push` factor, use the **poll** link returned when
        you issue the challenge. See [Retrieve a Factor Transaction
        Status](/openapi/okta-management/management/tag/UserFactor/#tag/UserFactor/operation/getFactorTransactionStatus).
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                activationToken: commodo in Lore
                answer: eiusmod ut veniam ea dolor
                attestation: ex nisi proident sunt
                clientData: ullamco officia
                nextPassCode: 3956685498
                passCode: ipsum dolore in ad
                registrationData: dolore ex amet
                stateToken: eiusmod ad
      security:
        - apikeyAuth: []
      parameters:
        - name: X-Forwarded-For
          in: header
          schema:
            type: string
          description: Public IP address for the user agent
          example: mollit occaecat cupidatat
        - name: User-Agent
          in: header
          schema:
            type: string
          description: Type of user agent detected when the request is made
          example: mollit occaecat cupidatat
        - name: Accept-Language
          in: header
          schema:
            type: string
          description: >-
            Sets a two-letter language code that defines a localized message to
            send. Only used by the `sms` Factor.


            * If the language code doesn't exist in the SMS template, the
            message uses the default template.

            * If the `templateId` doesn't exist, the message is sent using the
            default template.
          example: mollit occaecat cupidatat
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: templateId
          in: query
          schema:
            type: string
          description: >-
            ID of an existing custom SMS template. See the [SMS Templates
            API](../Template). Only used by `sms` Factors.
          example: cstk2flOtuCMDJK4b0g3
        - name: tokenLifetimeSeconds
          in: query
          schema:
            type: integer
          description: Defines how long the token remains valid
          example: '300'
        - name: userId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing Okta user
          example: mollit occaecat cupidatat
        - name: factorId
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of an existing User Factor
          example: zAgrsaBe0wVGRugDYtdv
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expiresAt: '1985-10-11T05:47:32.854Z'
                factorResult: WAITING
                factorResultMessage: in sunt tempor Ut
                _embedded:
                  proident_dc_: {}
                _links:
                  self:
                    value: '<Error: Too many levels of nesting to fake this schema>'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/types/user:
    get:
      tags:
        - User Types
      summary: List all User Types
      description: Lists all User Types in your org
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                - id: otyfnly5cQjJT9PnR0g4
                  displayName: New User Type
                  name: newUserType
                  description: A new custom user type
                  createdBy: sprz9fj1ycBcsgopy1d6
                  lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                  created: '2021-07-05T20:40:38.000Z'
                  lastUpdated: '2021-07-05T20:40:38.000Z'
                  default: false
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                - id: otyz9fj2jMiRBC1ZT1d6
                  displayName: User
                  name: user
                  description: Okta user profile template with default permission settings
                  createdBy: sprz9fj1ycBcsgopy1d6
                  lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                  created: '2021-07-05T20:40:38.000Z'
                  lastUpdated: '2021-07-05T20:40:38.000Z'
                  default: true
                  _links:
                    self:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                    schema:
                      href: >-
                        https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - User Types
      summary: Create a User Type
      description: >-
        Creates a new User Type. Okta automatically creates a `default` User
        Type for your org. You may add up to nine additional User Types.

        > **Note**: New User Types are based on the current default schema
        template. Modifications to this schema do not automatically propagate to
        previously created User Types.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: A new custom user type
                displayName: New User Type
                name: newUserType
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: otyfnly5cQjJT9PnR0g4
                displayName: New User Type
                name: newUserType
                description: A new custom user type
                createdBy: sprz9fj1ycBcsgopy1d6
                lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                created: '2021-07-05T20:40:38.000Z'
                lastUpdated: '2021-07-05T20:40:38.000Z'
                default: false
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                  schema:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /api/v1/meta/types/user/{typeId}:
    get:
      tags:
        - User Types
      summary: Retrieve a User Type
      description: >-
        Retrieves a User Type by ID. Use `default` to fetch the default User
        Type.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: typeId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: sunt ipsum ullamco
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: otyfnly5cQjJT9PnR0g4
                displayName: New User Type
                name: newUserType
                description: A new custom user type
                createdBy: sprz9fj1ycBcsgopy1d6
                lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                created: '2021-07-05T20:40:38.000Z'
                lastUpdated: '2021-07-05T20:40:38.000Z'
                default: false
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                  schema:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    post:
      tags:
        - User Types
      summary: Update a User Type
      description: >-
        Updates an existing User Type.

        > **Note**: You can only update the `displayName` and `description`
        elements. The `name` of an existing User Type can't be changed.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                displayName: Updated Display Name
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: typeId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: sunt ipsum ullamco
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: otyfnly5cQjJT9PnR0g4
                displayName: Updated Display Name
                name: newUserType
                description: A new custom user type
                createdBy: sprz9fj1ycBcsgopy1d6
                lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                created: '2021-07-05T20:40:38.000Z'
                lastUpdated: '2021-07-05T20:40:38.000Z'
                default: false
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                  schema:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    put:
      tags:
        - User Types
      summary: Replace a User Type
      description: >-
        Replaces an existing User Type.

        > **Note**: The `name` of an existing User Type can't be changed, but
        must be part of the request body. You can only replace the `displayName`
        and `description` elements.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                displayName: Replacement Display Name
                description: Replacement description
                name: newUserType
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: typeId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: sunt ipsum ullamco
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: otyfnly5cQjJT9PnR0g4
                displayName: Replacement Display Name
                name: newUserType
                description: Replacement description
                createdBy: sprz9fj1ycBcsgopy1d6
                lastUpdatedBy: sprz9fj1ycBcsgopy1d6
                created: '2021-07-05T20:40:38.000Z'
                lastUpdated: '2021-07-05T20:40:38.000Z'
                default: false
                _links:
                  self:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
                  schema:
                    href: >-
                      https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: {0}'
                errorLink: E0000001
                errorId: sampleiCF-8D5rLW6myqiPItW
                errorCauses: []
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
    delete:
      tags:
        - User Types
      summary: Delete a User Type
      description: >-
        Deletes a User Type permanently.

        > **Note**: You can't delete the default User Type or a User Type that
        is currently assigned to users.
      security:
        - apikeyAuth: []
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: typeId
          in: path
          schema:
            type: string
          required: true
          description: '(Required) '
          example: sunt ipsum ullamco
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /webauthn-registration/api/v1/activate:
    post:
      tags:
        - WebAuthnPreregistration
      summary: Activate a Preregistered WebAuthn Factor
      description: >-
        Activates a preregistered WebAuthn Factor. As part of this operation,
        Okta first decrypts and verifies the Factor PIN and enrollment data sent
        by the fulfillment provider.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                credResponses:
                  - authenticatorEnrollmentId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credResponseJWE:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - authenticatorEnrollmentId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credResponseJWE:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                fulfillmentProvider: yubico
                pinResponseJwe: dolore in eiusmod laborum in
                serial: Ut reprehenderit
                userId: ea aliquip in
                version: pariatur nostrud
                yubicoSigningJwks:
                  - x:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    'y':
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    kty:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    crv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    use:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    kid:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - x:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    'y':
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    kty:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    crv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    use:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    kid:
                      value: '<Error: Too many levels of nesting to fake this schema>'
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                authenticatorEnrollmentIds:
                  - proident ad aliquip officia
                  - eu elit enim laborum
                fulfillmentProvider: yubico
                userId: id Lorem
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: pinResponse|credResponses'
                errorLink: E0000001
                errorId: oaehk3rssXQmOWDRsaFfxe8B
                errorCauses:
                  errorSummary: >-
                    There was a problem generating the
                    pinResponse|credResponses.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /webauthn-registration/api/v1/enroll:
    post:
      tags:
        - WebAuthnPreregistration
      summary: Enroll a Preregistered WebAuthn Factor
      description: >-
        Enrolls a preregistered WebAuthn Factor. This WebAuthn Factor has a
        longer challenge timeout period to accommodate the fulfillment request
        process. As part of this operation, Okta generates EC key-pairs used to
        encrypt the Factor PIN and enrollment data sent by the fulfillment
        provider.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                enrollmentRpIds:
                  - est occaecat ullamco
                  - qui Excepteur
                fulfillmentProvider: yubico
                userId: dolore pariatur
                yubicoTransportKeyJWK:
                  x: commodo cupidatat Duis
                  'y': ipsum
                  kty: EC
                  crv: P-384
                  use: enc
                  kid: occaecat dolor
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                credRequests:
                  - authenticatorEnrollmentId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credRequestJwe:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keyId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                  - authenticatorEnrollmentId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    credRequestJwe:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    keyId:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                fulfillmentProvider: yubico
                pinRequestJwe: fugiat quis magna
                userId: ea laborum ut
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000001
                errorSummary: 'Api validation failed: pinRequest|credRequests'
                errorLink: E0000001
                errorId: oaehk3rssXQmOWDRsaFfxe8A
                errorCauses:
                  errorSummary: There was a problem generating the pinRequest|credRequests.
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
  /webauthn-registration/api/v1/initiate-fulfillment-request:
    post:
      tags:
        - WebAuthnPreregistration
      summary: Generate a Fulfillment Request
      description: >-
        Generates a fulfillment request by sending a WebAuthn Preregistration
        event to start the flow. The Okta Workflows WebAuthn preregistration
        integration uses this to populate the fulfillment request.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                fulfillmentData:
                  customizationId: officia sunt esse
                  inventoryProductId: dolore
                  productId: commodo dolore
                fulfillmentProvider: yubico
                userId: cillum aliqua dolor nulla
      security:
        - apikeyAuth: []
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000006
                errorSummary: You do not have permission to perform the requested action
                errorLink: E0000006
                errorId: sampleNUSD_8fdkFd8fs8SDBK
                errorCauses: []
        '404':
          description: Not Found
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000007
                errorSummary: 'Not found: {0}'
                errorLink: E0000007
                errorId: sampleMlLvGUj_YD5v16vkYWY
                errorCauses: []
        '429':
          description: Too Many Requests
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                errorCode: E0000047
                errorSummary: >-
                  You exceeded the maximum number of requests. Try again in a
                  while.
                errorLink: E0000047
                errorId: sampleQPivGUj_ND5v78vbYWW
                errorCauses: []
