openapi: 3.0.0
info:
  description: The PingOne Platform API covering the base and SSO services (otherwise
    known as the Management APIs)
  title: PingOne Platform API - SSO and Base
  version: 2023-06-29
externalDocs:
  description: PingOne Platform API Reference - Management APIs
  url: https://apidocs.pingidentity.com/pingone/platform/v1/api/#management-apis
servers:
- description: PingOne Platform API Endpoint
  url: "{protocol}://{baseDomain}.{suffix}/v1"
  variables:
    suffix:
      default: com
      enum:
      - asia
      - ca
      - com
      - com.au
      - eu
    baseDomain:
      default: api.pingone
    protocol:
      default: https
- description: PingOne Platform API Endpoint
  url: "{protocol}://{baseHostname}/v1"
  variables:
    baseHostname:
      default: api.pingone.com
    protocol:
      default: https
security:
- bearer: []
tags:
- name: Management APIs
- name: Accounting for Latency
- name: Active Identity Counts
- name: Agreement Management
- name: Agreements Resources
- name: Agreement Languages Resources
- name: Agreement Revisions Resources
- name: Alerting
- name: Applications
- name: Application Secret
- name: Application Metadata
- name: Application Resource Grants
- name: Application Flow Policy Assignments
- name: Application Sign-On Policy Assignments
- name: Application Role Assignments
- name: Application Attribute Mapping
- name: Application MFA Push Credentials
- name: Audit Activities
- name: Authentications per Application
- name: Bill of Materials (BOM)
- name: Branding Settings
- name: Branding Themes
- name: Capabilities
- name: Certificate Management
- name: Custom Domains
- name: Device Authentication Policy
- name: Environments
- name: Flow Policies
- name: Gateway Management
- name: Gateways
- name: Gateway Credentials
- name: Gateway Instances
- name: Gateway Role Assignments
- name: Groups
- name: Identity Propagation (Provisioning)
- name: Key Rotation Policies
- name: Propagation Revisions
- name: Propagation Plans
- name: Propagation Stores
- name: Propagation Store Metadata
- name: Propagation Rules
- name: Propagation Mappings
- name: Identity Provider Management
- name: Identity Providers
- name: Identity Provider Attributes
- name: Images
- name: Integration Catalog
- name: Language Management
- name: Languages
- name: Language Localization Status
- name: Licenses
- name: Notifications
- name: Notifications Templates
- name: Notifications Settings
- name: Notifications Settings (SMTP)
- name: Phone Delivery Settings
- name: Trusted Email Domains
- name: Trusted Email Addresses
- name: Organizations
- name: Password Policies
- name: Populations
- name: Resources
- name: Resource Scopes
- name: Resource Attributes
- name: Roles
- name: Schemas
- name: Sign-On Policies
- name: Sign-On Policy Actions
- name: Subscriptions (webhooks)
- name: Total Identities
- name: User Activities
- name: Users
- name: Group Membership
- name: Enable Users
- name: Linked Accounts
- name: User Populations
- name: User Passwords
- name: User Role Assignments
- name: User ID Verification
- name: User Agreement Consents
- name: User Accounts
- name: Sessions
paths:
  /environments:
    get:
      operationId: readAllEnvironments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - description: "Adding a cursor value to retrieve the next page of results,\
          \ used with the `limit` parameter. The cursor value is returned in the `_links.next.href`\
          \ link in the response payload."
        explode: true
        in: query
        name: cursor
        required: false
        schema:
          type: string
        style: form
      - description: "Adding a SCIM filter for an environment to display only those\
          \ resources associated with the specified environment. 'sw', 'eq' and 'and'\
          \ are supported"
        example: name sw "S" and license.id eq "34f0efac-21d9-4a17-8a35-196bb3362983"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Environments
      tags:
      - Environments
    post:
      operationId: createEnvironmentActiveLicense
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
          description: Successful response
      summary: CREATE Environment (Active License)
      tags:
      - Environments
  /environments/{environmentID}:
    delete:
      operationId: deleteEnvironment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Environment
      tags:
      - Environments
    get:
      operationId: readOneEnvironment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
          description: Successful response
      summary: READ One Environment
      tags:
      - Environments
    put:
      operationId: updateEnvironment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
          description: Successful response
      summary: UPDATE Environment
      tags:
      - Environments
  /environments/{environmentID}/activeIdentityCounts:
    get:
      parameters:
      - example: startDate ge "2019-05-01T19:00:00Z" and samplingPeriod eq "10"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
        style: form
      - example: -startDate
        explode: true
        in: query
        name: order
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Active Identity Counts (Deprecated)
      tags:
      - Active Identity Counts
  /environments/{environmentID}/metrics/activeIdentityCounts:
    get:
      parameters:
      - example: startDate ge "2020-05-01T19:00:00Z"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - example: "10"
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - example: -startDate
        explode: true
        in: query
        name: order
        required: false
        schema:
          type: string
        style: form
      - example: MONTH
        explode: true
        in: query
        name: samplePeriod
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Active Identity Counts by Date Range
      tags:
      - Active Identity Counts
  /environments/{environmentID}/adminConfig:
    get:
      operationId: readAdministratorSecurity
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdministratorSecurity'
          description: Successful response
      summary: READ Administrator Security
      tags:
      - Administrator Security
    put:
      operationId: updateAdministratorSecurity
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdministratorSecurity'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdministratorSecurity'
          description: Successful response
      summary: UPDATE Administrator Security
      tags:
      - Administrator Security
  /environments/{environmentID}/agreements:
    get:
      operationId: readAllAgreements
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Agreements
      tags:
      - Agreements Resources
    post:
      operationId: createAgreement
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Agreement'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agreement'
          description: Successful response
      summary: CREATE Agreement
      tags:
      - Agreements Resources
  /environments/{environmentID}/agreements/{agreementID}:
    delete:
      operationId: deleteAgreement
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Agreement
      tags:
      - Agreements Resources
    get:
      operationId: readOneAgreement
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agreement'
          description: Successful response
      summary: READ One Agreement
      tags:
      - Agreements Resources
    put:
      operationId: updateAgreement
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Agreement'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agreement'
          description: Successful response
      summary: UPDATE Agreement
      tags:
      - Agreements Resources
  /environments/{environmentID}/agreements/{agreementID}/languages:
    get:
      operationId: readAllAgreementLanguages
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Languages
      tags:
      - Agreement Languages Resources
    post:
      operationId: createAgreementLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgreementLanguage'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementLanguage'
          description: Successful response
      summary: CREATE Language
      tags:
      - Agreement Languages Resources
  /environments/{environmentID}/agreements/{agreementID}/languages/{languageID}:
    delete:
      operationId: deleteAgreementLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Language
      tags:
      - Agreement Languages Resources
    get:
      operationId: readOneAgreementLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementLanguage'
          description: Successful response
      summary: READ One Language
      tags:
      - Agreement Languages Resources
    put:
      operationId: updateAgreementLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgreementLanguage'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementLanguage'
          description: Successful response
      summary: UPDATE Language
      tags:
      - Agreement Languages Resources
  /environments/{environmentID}/agreements/{agreementID}/languages/{languageID}/revisions:
    get:
      operationId: readAllAgreementLanguageRevisions
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Revisions
      tags:
      - Agreement Revisions Resources
    post:
      operationId: createAgreementLanguageRevision
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgreementLanguageRevision'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementLanguageRevision'
          description: Successful response
      summary: CREATE Revision
      tags:
      - Agreement Revisions Resources
  /environments/{environmentID}/agreements/{agreementID}/languages/{languageID}/revisions/{revisionID}:
    delete:
      operationId: deleteAgreementLanguageRevision
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: revisionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Revision
      tags:
      - Agreement Revisions Resources
    get:
      operationId: readOneAgreementLanguageRevision
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: revisionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementLanguageRevision'
          description: Successful response
      summary: READ One Revision
      tags:
      - Agreement Revisions Resources
  /environments/{environmentID}/alertChannels:
    get:
      operationId: readAllAlertChannels
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Alert Channels
      tags:
      - Alerting
    post:
      operationId: createAlertChannel
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannel'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
          description: Successful response
      summary: CREATE Alert Channel
      tags:
      - Alerting
  /environments/{environmentID}/alertChannels/{alertChannelID}:
    delete:
      operationId: deleteAlertChannel
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: alertChannelID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Alert Channel
      tags:
      - Alerting
    put:
      operationId: updateAlertChannel
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: alertChannelID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannel'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
          description: Successful response
      summary: UPDATE Alert Channel
      tags:
      - Alerting
  /environments/{environmentID}/applications:
    get:
      operationId: readAllApplications
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Applications
      tags:
      - Applications
    post:
      operationId: createApplication
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createApplication_request'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createApplication_201_response'
          description: Successful response
      summary: CREATE Application
      tags:
      - Applications
  /environments/{environmentID}/applications/{applicationID}:
    delete:
      operationId: deleteApplication
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Application
      tags:
      - Applications
    get:
      operationId: readOneApplication
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readOneApplication_200_response'
          description: Successful response
      summary: READ One Application
      tags:
      - Applications
    put:
      operationId: updateApplication
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateApplication_request'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readOneApplication_200_response'
          description: Successful response
      summary: UPDATE Application
      tags:
      - Applications
  /environments/{environmentID}/applications/{applicationID}/secret:
    delete:
      operationId: deletePreviousApplicationSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Previous Application Secret
      tags:
      - Application Secret
    get:
      operationId: readApplicationSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSecret'
          description: Successful response
      summary: READ Application Secret
      tags:
      - Application Secret
    post:
      operationId: updateApplicationSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSecret'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSecret'
          description: Successful response
      summary: UPDATE Application Secret
      tags:
      - Application Secret
  /environments/{environmentID}/applications/{applicationID}/metadata:
    get:
      operationId: readApplicationMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationMetadata'
          description: Successful response
      summary: READ Application Metadata
      tags:
      - Application Metadata
    put:
      operationId: updateApplicationMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationMetadata'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationMetadata'
          description: Successful response
      summary: UPDATE Application Metadata
      tags:
      - Application Metadata
  /environments/{environmentID}/applications/{applicationID}/grants:
    get:
      operationId: readAllApplicationGrants
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Grants for an Application
      tags:
      - Application Resource Grants
    post:
      operationId: createApplicationGrant
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationResourceGrant'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResourceGrant'
          description: Successful response
      summary: CREATE Grant
      tags:
      - Application Resource Grants
  /environments/{environmentID}/applications/{applicationID}/grants/{grantID}:
    delete:
      operationId: deleteApplicationGrant
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: grantID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Grant
      tags:
      - Application Resource Grants
    get:
      operationId: readOneApplicationGrant
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: grantID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResourceGrant'
          description: Successful response
      summary: READ One Grant for an Application
      tags:
      - Application Resource Grants
    put:
      operationId: updateApplicationGrant
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: grantID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationResourceGrant'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResourceGrant'
          description: Successful response
      summary: UPDATE Grant
      tags:
      - Application Resource Grants
  /environments/{environmentID}/applications/{applicationID}/signOnPolicyAssignments:
    get:
      operationId: readAllSignOnPolicyAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All SOP Assignments
      tags:
      - Application Sign-On Policy Assignments
    post:
      operationId: createSignOnPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicyAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAssignment'
          description: Successful response
      summary: CREATE SOP Assignment
      tags:
      - Application Sign-On Policy Assignments
  /environments/{environmentID}/applications/{applicationID}/signOnPolicyAssignments/{SOPAssignmentID}:
    delete:
      operationId: deleteSignOnPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: SOPAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE SOP Assignment
      tags:
      - Application Sign-On Policy Assignments
    get:
      operationId: readOneSignOnPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: SOPAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAssignment'
          description: Successful response
      summary: READ One SOP Assignment
      tags:
      - Application Sign-On Policy Assignments
    put:
      operationId: updateSignOnPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: SOPAssignmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicyAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAssignment'
          description: Successful response
      summary: UPDATE SOP Assignment
      tags:
      - Application Sign-On Policy Assignments
  /environments/{environmentID}/applications/{applicationID}/flowPolicyAssignments:
    get:
      operationId: readAllFlowPolicyAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Flow Policy Assignments
      tags:
      - Application Flow Policy Assignments
    post:
      operationId: createFlowPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowPolicyAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPolicyAssignment'
          description: Successful response
      summary: CREATE Flow Assignment
      tags:
      - Application Flow Policy Assignments
  /environments/{environmentID}/applications/{applicationID}/flowPolicyAssignments/{flowPolicyAssignmentID}:
    delete:
      operationId: deleteFlowPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: flowPolicyAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Flow Policy Assignment
      tags:
      - Application Flow Policy Assignments
    get:
      operationId: readOneFlowPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: flowPolicyAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPolicyAssignment'
          description: Successful response
      summary: READ One Flow Policy Assignment
      tags:
      - Application Flow Policy Assignments
    put:
      operationId: updateFlowPolicyAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: flowPolicyAssignmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowPolicyAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPolicyAssignment'
          description: Successful response
      summary: UPDATE Flow Policy Assignment
      tags:
      - Application Flow Policy Assignments
  /environments/{environmentID}/applications/{applicationID}/roleAssignments:
    get:
      operationId: readApplicationRoleAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Application Role Assignments
      tags:
      - Application Role Assignments
    post:
      operationId: createApplicationRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: CREATE Application Role Assignments
      tags:
      - Application Role Assignments
  /environments/{environmentID}/applications/{applicationID}/roleAssignments/{roleAssignmentID}:
    delete:
      operationId: deleteApplicationRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Application Role Assignment
      tags:
      - Application Role Assignments
    get:
      operationId: readOneApplicationRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: READ One Application Role Assignment
      tags:
      - Application Role Assignments
  /environments/{environmentID}/applications/{applicationID}/attributes:
    get:
      operationId: readAllApplicationAttributeMappings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Application Attribute Mappings
      tags:
      - Application Attribute Mapping
    post:
      operationId: createApplicationAttributeMapping
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationAttributeMapping'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAttributeMapping'
          description: Successful response
      summary: CREATE Application Attribute Mapping
      tags:
      - Application Attribute Mapping
  /environments/{environmentID}/applications/{applicationID}/attributes/{attrMappingID}:
    delete:
      operationId: deleteApplicationAttributeMapping
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attrMappingID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Application Attribute Mapping
      tags:
      - Application Attribute Mapping
    get:
      operationId: readOneApplicationAttributeMapping
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attrMappingID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAttributeMapping'
          description: Successful response
      summary: READ One Application Attribute Mapping
      tags:
      - Application Attribute Mapping
    put:
      operationId: updateApplicationAttributeMapping
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attrMappingID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationAttributeMapping'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAttributeMapping'
          description: Successful response
      summary: UPDATE Application Attribute Mapping
      tags:
      - Application Attribute Mapping
  /environments/{environmentID}/activities:
    get:
      parameters:
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - example: recordedat gt "2018-08-20T00:00:00Z" AND recordedat lt "2018-08-22T23:59:00Z"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: GET User Activities
      tags:
      - Audit Activities
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                filter: recordedat gt "2019-01-01T22:54:12.988Z" AND recordedat lt
                  "2019-01-31T22:54:12.988Z" AND actors.user.name eq "Bill"
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: GET User Activities
      tags:
      - Audit Activities
  /environments/{environmentID}/activities/{activityID}:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: activityID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: GET One User Activity
      tags:
      - Audit Activities
  /environments/{environmentID}/applicationSignons:
    get:
      parameters:
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - example: "1"
        explode: true
        in: query
        name: samplePeriod
        required: false
        schema:
          type: integer
        style: form
      - example: "100"
        explode: true
        in: query
        name: samplePeriodCount
        required: false
        schema:
          type: integer
        style: form
      - example: occurredAt ge "2019-10-03T00:00:00Z""
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Authentications Per Application (Partial)
      tags:
      - Authentications per Application
  /environments/{environmentID}/billOfMaterials:
    get:
      operationId: readOneBillOfMaterials
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillOfMaterials'
          description: Successful response
      summary: READ One Bill of Materials
      tags:
      - Bill of Materials (BOM)
    put:
      operationId: updateBillOfMaterials
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillOfMaterials'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillOfMaterials'
          description: Successful response
      summary: UPDATE Bill of Materials
      tags:
      - Bill of Materials (BOM)
  /environments/{environmentID}/brandingSettings:
    get:
      operationId: readBrandingSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingSettings'
          description: Successful response
      summary: READ Branding Settings
      tags:
      - Branding Settings
    put:
      operationId: updateBrandingSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingSettings'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingSettings'
          description: Successful response
      summary: UPDATE Branding Settings
      tags:
      - Branding Settings
  /environments/{environmentID}/capabilities:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Environment Capabilities
      tags:
      - Capabilities
  /environments/{environmentID}/flowPolicies:
    get:
      operationId: readAllFlowPolicies
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - example: trigger.type eq "AUTHENTICATION"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Flow Policies
      tags:
      - Flow Policies
  /environments/{environmentID}/flowPolicies/{flowPolicyID}:
    get:
      operationId: readOneFlowPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: flowPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPolicy'
          description: Successful response
      summary: READ ONE Flow Policy
      tags:
      - Flow Policies
  /environments/{environmentID}/forms:
    get:
      operationId: readAllForms
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Forms
      tags:
      - Form Management
    post:
      operationId: createForm
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form'
          description: Successful response
      summary: CREATE Form
      tags:
      - Form Management
  /environments/{environmentID}/forms/{formID}:
    delete:
      operationId: deleteForm
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: formID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Form
      tags:
      - Form Management
    get:
      operationId: readForm
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: formID
        required: true
        schema:
          type: string
        style: simple
      - explode: true
        in: query
        name: include
        required: false
        schema:
          $ref: '#/components/schemas/EnumFormsIncludeParameter'
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form'
          description: Successful response
      summary: READ One Form
      tags:
      - Form Management
    put:
      operationId: updateForm
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: formID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form'
          description: Successful response
      summary: UPDATE Form
      tags:
      - Form Management
  /environments/{environmentID}/keys:
    get:
      operationId: getKeys
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: GET Keys
      tags:
      - Certificate Management
    post:
      operationId: createKey
      parameters:
      - example: application/x-pkcs12-certificates
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Certificate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PKIKeyFileUpload'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
          description: Successful response
      summary: CREATE Key
      tags:
      - Certificate Management
  /environments/{environmentID}/keys/{keyID}:
    delete:
      operationId: deleteKey
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Key
      tags:
      - Certificate Management
    get:
      operationId: getKey
      parameters:
      - explode: false
        in: header
        name: Accept
        required: false
        schema:
          $ref: '#/components/schemas/EnumGetKeyAcceptHeader'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
            application/x-x509-ca-cert:
              schema:
                format: byte
                type: string
            application/x-pkcs7-certificates:
              schema:
                format: binary
                type: string
          description: Successful response
      summary: GET Key
      tags:
      - Certificate Management
    put:
      operationId: updateKey
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificateKeyUpdate'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
          description: Successful response
      summary: UPDATE Key
      tags:
      - Certificate Management
  /environments/{environmentID}/keys/{keyID}/applications:
    get:
      operationId: getKeyApplications
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: GET Key Applications
      tags:
      - Certificate Management
  /environments/{environmentID}/keys/{keyID}/csr:
    get:
      operationId: exportCSR
      parameters:
      - example: application/pkcs10
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          $ref: '#/components/schemas/EnumCSRExportHeader'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/pkcs10:
              schema:
                format: byte
                type: string
            application/x-pem-file:
              schema:
                format: byte
                type: string
          description: Successful response
      summary: Export a certificate signing request (CSR)
      tags:
      - Certificate Management
    post:
      operationId: importCSRResponse
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PKICAResponseFileUpload'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
          description: Successful response
      summary: Import Certificate Authority (CA) Response to a CSR
      tags:
      - Certificate Management
  /environments/{environmentID}/keyRotationPolicies:
    get:
      operationId: getKeyRotationPolicies
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: GET Key Rotation Policies
      tags:
      - Key Rotation Policies
    post:
      operationId: createKeyRotationPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyRotationPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationPolicy'
          description: Successful response
      summary: CREATE Key Rotation Policy
      tags:
      - Key Rotation Policies
  /environments/{environmentID}/keyRotationPolicies/{keyRotationPolicyID}:
    delete:
      operationId: deleteKeyRotationPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyRotationPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Key Rotation Policy
      tags:
      - Key Rotation Policies
    get:
      operationId: getKeyRotationPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyRotationPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationPolicy'
          description: Successful response
      summary: GET Key Rotation Policy
      tags:
      - Key Rotation Policies
    put:
      operationId: updateKeyRotationPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: keyRotationPolicyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyRotationPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationPolicy'
          description: Successful response
      summary: UPDATE Key Rotation Policy
      tags:
      - Key Rotation Policies
  /environments/{environmentID}/certificates:
    get:
      operationId: getCertificates
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: GET Certificates
      tags:
      - Certificate Management
    post:
      operationId: createCertificateFromFile
      parameters:
      - example: application/x-pkcs7-certificates
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          $ref: '#/components/schemas/EnumCreateCertificateAcceptHeader'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PKIFileUpload'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
          description: Successful response
      summary: CREATE Certificate with PKCS7 or PEM File
      tags:
      - Certificate Management
  /environments/{environmentID}/certificates/{certID}:
    delete:
      operationId: deleteCertificate
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: certID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Certificate
      tags:
      - Certificate Management
    get:
      operationId: getCertificate
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: certID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
          description: Successful response
      summary: GET Certificate
      tags:
      - Certificate Management
  /environments/{environmentID}/certificates/{certID}/applications:
    get:
      operationId: getCertificateApplications
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: certID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: GET Certificate Applications
      tags:
      - Certificate Management
  /environments/{environmentID}/encryptions:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                key:
                  id: "{keyId}"
                certificate:
                  id: "{certificateId}"
                plainText: SGVsbG8sIFdvcmxkIQ==
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: ENCRYPT Data
      tags:
      - Certificate Management
  /environments/{environmentID}/decryptions:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                key:
                  id: 40e6c099-20dd-4763-be84-a5d9fd30f3ba
                cipherText: 0kEOngncmwvmGal0pT1y71bNsfWfvllmoDQlPfUq4UxiFE/u2w0RoS0yqPieNY1samW971zFuZ+XGtqIp69id6KSd9WXaaZliE18GAk8XvnilKF4A6TW1lmkpGuezI6G6AxPaaFVMKZyPx6R8Ai90aRBkcZ+2TtOrzZjGWh0Z132R/3syiFpEzBIqmo/ksnHKcojfj0Eq8cMwaSeymLaxT/wykeCwDC4x2QrRQLVmM4yCDNM2eC/3ArkB24pjMXHKfcr5jzR9ZtHdlh7Bs8D4JpdNMyD+uI6mrJyFll+E3TLGUhRymjMc4ZiUpPPntoXVzYq4xupZdNTbbcClA6hyg==
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: DECRYPT Data
      tags:
      - Certificate Management
  /environments/{environmentID}/signings:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                algorithm: SHA256withRSA
                plainText: string
                key:
                  id: "{keyId}"
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: SIGN Data
      tags:
      - Certificate Management
  /environments/{environmentID}/verifications:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                key:
                  id: "{keyId}"
                certificate:
                  id: "{certificateId}"
                plainText: SGVsbG8sIFdvcmxkIQ==
                signature: "{signature}"
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: VERIFY Signed Data
      tags:
      - Certificate Management
  /environments/{environmentID}/customDomains:
    get:
      operationId: readAllDomains
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Domains
      tags:
      - Custom Domains
    post:
      operationId: createDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomain'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
          description: Successful response
      summary: CREATE Domain
      tags:
      - Custom Domains
  /environments/{environmentID}/customDomains/{customDomainID}:
    delete:
      operationId: deleteDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Domain
      tags:
      - Custom Domains
    get:
      operationId: readOneDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
          description: Successful response
      summary: READ One Domain
      tags:
      - Custom Domains
    post:
      operationId: updateDomain
      parameters:
      - explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          $ref: '#/components/schemas/EnumCustomDomainPostHeader'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customDomainID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomainCertificateRequest'
        required: false
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomain'
          description: Successful response
      summary: Update Domain
      tags:
      - Custom Domains
  /environments/{environmentID}/emailDomains:
    get:
      operationId: readAllTrustedEmailDomains
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Trusted Email Domains
      tags:
      - Trusted Email Domains
    post:
      operationId: createTrustedEmailDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailDomain'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
          description: Successful response
      summary: CREATE Trusted Email Domain
      tags:
      - Trusted Email Domains
  /environments/{environmentID}/emailDomains/{emailDomainID}:
    delete:
      operationId: deleteTrustedEmailDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Trusted Email Domain
      tags:
      - Trusted Email Domains
    get:
      operationId: readOneTrustedEmailDomain
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
          description: Successful response
      summary: READ One Trusted Email Domain
      tags:
      - Trusted Email Domains
  /environments/{environmentID}/emailDomains/{emailDomainID}/ownership:
    get:
      operationId: readTrustedEmailDomainOwnershipStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainOwnershipStatus'
          description: Successful response
      summary: READ Trusted Email Domain Ownership Status
      tags:
      - Trusted Email Domains
  /environments/{environmentID}/emailDomains/{emailDomainID}/dkim:
    get:
      operationId: readTrustedEmailDomainDKIMStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainDKIMStatus'
          description: Successful response
      summary: READ Trusted Email Domain DKIM Status
      tags:
      - Trusted Email Domains
  /environments/{environmentID}/emailDomains/{emailDomainID}/spf:
    get:
      operationId: readTrustedEmailDomainSPFStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainSPFStatus'
          description: Successful response
      summary: READ Trusted Email Domain SPF Status
      tags:
      - Trusted Email Domains
  /environments/{environmentID}/emailDomains/{emailDomainID}/trustedEmails/{trustedEmailId}:
    delete:
      operationId: deleteTrustedEmailAddress
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: trustedEmailId
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Trusted Email Address
      tags:
      - Trusted Email Addresses
    get:
      operationId: readOneTrustedEmailAddress
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: trustedEmailId
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainTrustedEmail'
          description: Successful response
      summary: READ One Trusted Email Address
      tags:
      - Trusted Email Addresses
    post:
      operationId: resendVerificationCodeToEmail
      parameters:
      - example: application/vnd.pingidentity.trustedEmail.sendVerificationCode+json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: trustedEmailId
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainTrustedEmail'
          description: Successful response
      summary: Resend Verification Code To Email
      tags:
      - Trusted Email Addresses
  /environments/{environmentID}/emailDomains/{emailDomainID}/trustedEmails:
    get:
      operationId: readAllTrustedEmailAddresses
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Trusted Email Addresses
      tags:
      - Trusted Email Addresses
    post:
      operationId: createTrustedEmailAddress
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: emailDomainID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailDomainTrustedEmail'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainTrustedEmail'
          description: Successful response
      summary: CREATE Trusted Email Address
      tags:
      - Trusted Email Addresses
  /environments/{environmentID}/type:
    put:
      operationId: updateEnvironmentType
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateEnvironmentType_request'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
          description: Successful response
      summary: UPDATE Environment Type
      tags:
      - Environments
  /environments/{environmentID}/gateways:
    get:
      operationId: readAllGateways
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Gateways
      tags:
      - Gateways
    post:
      operationId: createGateway
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createGateway_request'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGateway_201_response'
          description: Successful response
      summary: CREATE Gateway
      tags:
      - Gateways
  /environments/{environmentID}/gateways/{gatewayID}:
    delete:
      operationId: deleteGateway
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Gateway
      tags:
      - Gateways
    get:
      operationId: readOneGateway
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGateway_201_response'
          description: Successful response
      summary: READ One Gateway
      tags:
      - Gateways
    put:
      operationId: updateGateway
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createGateway_request'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGateway_201_response'
          description: Successful response
      summary: UPDATE Gateway
      tags:
      - Gateways
  /environments/{environmentID}/gateways/{gatewayID}/credentials:
    get:
      operationId: readAllGatewayCredentials
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Gateway Credentials
      tags:
      - Gateway Credentials
    post:
      operationId: createGatewayCredential
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayCredential'
          description: Successful response
      summary: CREATE Gateway Credentials
      tags:
      - Gateway Credentials
  /environments/{environmentID}/gateways/{gatewayID}/credentials/{credentialID}:
    delete:
      operationId: deleteGatewayCredential
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: credentialID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Gateway Credentials
      tags:
      - Gateway Credentials
    get:
      operationId: readOneGatewayCredential
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: credentialID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayCredential'
          description: Successful response
      summary: READ One Gateway Credential
      tags:
      - Gateway Credentials
  /environments/{environmentID}/gateways/{gatewayID}/instances:
    get:
      operationId: readAllGatewayInstances
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Gateway Instances
      tags:
      - Gateway Instances
  /environments/{environmentID}/gateways/{gatewayID}/instances/{instanceID}:
    get:
      operationId: readOneGatewayInstance
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: instanceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayInstance'
          description: Successful response
      summary: READ One Gateway Instance
      tags:
      - Gateway Instances
  /environments/{environmentID}/gateways/{gatewayID}/roleAssignments:
    get:
      operationId: readGatewayRoleAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Gateway Role Assignments
      tags:
      - Gateway Role Assignments
    post:
      operationId: createGatewayRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: CREATE Gateway Role Assignments
      tags:
      - Gateway Role Assignments
  /environments/{environmentID}/gateways/{gatewayID}/roleAssignments/{gatewayRoleAssignmentID}:
    delete:
      operationId: deleteGatewayRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayRoleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Gateway Role Assignment
      tags:
      - Gateway Role Assignments
    get:
      operationId: readOneGatewayRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayRoleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: READ One Gateway Role Assignment
      tags:
      - Gateway Role Assignments
    put:
      operationId: updateGatewayRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: gatewayRoleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                role:
                  id: "{{envRoleID}}"
                scope:
                  id: "{{environmentID}}"
                  type: ENVIRONMENT
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: UPDATE Gateway Role Assignments
      tags:
      - Gateway Role Assignments
  /environments/{environmentID}/groups:
    get:
      operationId: readAllGroups
      parameters:
      - example: name eq "Training"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          maximum: 1000
          minimum: 1
          type: integer
        style: form
      - description: "Adding a cursor value to retrieve the next page of results,\
          \ used with the `limit` parameter. The cursor value is returned in the `_links.next.href`\
          \ link in the response payload."
        explode: true
        in: query
        name: cursor
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Groups
      tags:
      - Groups
    post:
      operationId: createGroup
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
      summary: CREATE Group
      tags:
      - Groups
  /environments/{environmentID}/groups/{groupID}:
    delete:
      operationId: deleteGroup
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Group
      tags:
      - Groups
    get:
      operationId: readOneGroup
      parameters:
      - example: totalMemberCounts
        explode: true
        in: query
        name: include
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
      summary: READ One Group
      tags:
      - Groups
    put:
      operationId: updateGroup
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
      summary: UPDATE Group
      tags:
      - Groups
  /environments/{environmentID}/groups/{groupID}/memberOfGroups:
    get:
      operationId: readGroupNesting
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Group Nesting
      tags:
      - Groups
    post:
      operationId: createGroupNesting
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupNesting'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupNesting'
          description: Successful response
      summary: CREATE Group Nesting
      tags:
      - Groups
  /environments/{environmentID}/groups/{groupID}/memberOfGroups/{nestedGroupID}:
    delete:
      operationId: deleteGroupNesting
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: nestedGroupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Group Nesting
      tags:
      - Groups
    get:
      operationId: readOneGroupNesting
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: nestedGroupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupNesting'
          description: Successful response
      summary: READ One Group Nesting
      tags:
      - Groups
  /environments/{environmentID}/groups/{groupID}/roleAssignments:
    get:
      operationId: readGroupRoleAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Role Assignments
      tags:
      - Group Role Assignments
    post:
      operationId: createGroupRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: CREATE Group Role Assignment
      tags:
      - Group Role Assignments
  /environments/{environmentID}/groups/{groupID}/roleAssignments/{roleAssignmentID}:
    delete:
      operationId: deleteGroupRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Group's Role Assignment
      tags:
      - Group Role Assignments
    get:
      operationId: readOneGroupRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: READ One Group Assignment
      tags:
      - Group Role Assignments
  /environments/{environmentID}/propagation/revisions:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json: {}
          description: Successful response
      summary: CREATE Revision
      tags:
      - Propagation Revisions
  /environments/{environmentID}/propagation/revisions/id:latest:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Latest Revision
      tags:
      - Propagation Revisions
  /environments/{environmentID}/propagation/revisions/{previousRevisionID}:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: previousRevisionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Previous Revision
      tags:
      - Propagation Revisions
  /environments/{environmentID}/propagation/plans:
    get:
      operationId: readAllPlans
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Plans
      tags:
      - Identity Propagation Plans
    post:
      operationId: createPlan
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityPropagationPlan'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityPropagationPlan'
          description: Successful response
      summary: CREATE Plan
      tags:
      - Identity Propagation Plans
  /environments/{environmentID}/propagation/plans/{planID}:
    delete:
      operationId: deletePlan
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: planID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Plan
      tags:
      - Identity Propagation Plans
    get:
      operationId: readOnePlan
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: planID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityPropagationPlan'
          description: Successful response
      summary: READ One Plan
      tags:
      - Identity Propagation Plans
    put:
      operationId: updatePlan
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: planID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityPropagationPlan'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityPropagationPlan'
          description: Successful response
      summary: UPDATE Plan
      tags:
      - Identity Propagation Plans
  /environments/{environmentID}/propagation/stores:
    get:
      operationId: readAllStores
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Stores
      tags:
      - Propagation Stores
    post:
      operationId: createPropagationStore
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropagationStore'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropagationStore'
          description: Successful response
      summary: CREATE Propagation Store
      tags:
      - Propagation Stores
  /environments/{environmentID}/propagation/stores/{storeID}:
    delete:
      operationId: deletePropagationStore
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: storeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Store
      tags:
      - Propagation Stores
    get:
      operationId: readOnePropagationStore
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: storeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropagationStore'
          description: Successful response
      summary: READ One Store
      tags:
      - Propagation Stores
    put:
      operationId: updatePropagationStore
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: storeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropagationStore'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropagationStore'
          description: Successful response
      summary: UPDATE Store
      tags:
      - Propagation Stores
  /environments/{environmentID}/propagation/stores/connection/status:
    post:
      operationId: testConnectionConfiguration
      parameters:
      - example: application/vnd.pingidentity.connection.check+json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          $ref: '#/components/schemas/EnumPropagationStoreConnectionStatusContentType'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropagationStore'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          description: Successful response
      summary: TEST Connection Configuration
      tags:
      - Propagation Stores
  /environments/{environmentID}/propagation/storeMetadata/scim:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                type: scim
                configuration:
                  AUTHENTICATION_METHOD: Basic Authentication
                  USER_FILTER: username Eq "%s"
                  UNIQUE_USER_IDENTIFIER: userName
                  REMOVE_ACTION: Disable
                  USERS_RESOURCE: /user
                  SCIM_VERSION: "1.1"
                  SCIM_URL: SCIM URL
                  AUTHORIZATION_TYPE: Basic
                  BASIC_AUTH_USER: username
                  BASIC_AUTH_PASSWORD: password
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Identity Propagation Store Metadata (SCIM)
      tags:
      - Propagation Store Metadata
  /environments/{environmentID}/propagation/storeMetadata/Salesforce:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                type: Saleforce
                configuration:
                  SALESFORCE_DOMAIN: mySalesforceDomain.salesforce.com
                  CLIENT_ID: salesforceClientID
                  CLIENT_SECRET: salesforceClientSecret
                  OAUTH_ACCESS_TOKEN: token
                  OAUTH_REFRESH_TOKEN: token
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Identity Propagation Store Metadata (Salesforce)
      tags:
      - Propagation Store Metadata
  /environments/{environmentID}/propagation/storeMetadata/SalesforceContacts:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                type: SaleforceContacts
                configuration:
                  SALESFORCE_DOMAIN: my.salesforce.com
                  CLIENT_ID: yourClientID
                  CLIENT_SECRET: yourClientSecret
                  OAUTH_ACCESS_TOKEN: yourAccessToken
                  OAUTH_REFRESH_TOKEN: yourRefreshToken
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Identity Propagation Store Metadata (SalesforceContacts)
      tags:
      - Propagation Store Metadata
  /environments/{environmentID}/propagation/storeMetadata/Aquera:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                type: Aquera
                configuration:
                  AUTHENTICATION_METHOD: Basic Authentication
                  USER_FILTER: username Eq "%s"
                  UNIQUE_USER_IDENTIFIER: userName
                  REMOVE_ACTION: Disable
                  USERS_RESOURCE: /user
                  SCIM_VERSION: "1.1"
                  SCIM_URL: SCIM URL
                  AUTHORIZATION_TYPE: Basic
                  BASIC_AUTH_USER: username
                  BASIC_AUTH_PASSWORD: password
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Identity Propagation Store Metadata (Aquera)
      tags:
      - Propagation Store Metadata
  /environments/{environmentID}/propagation/rules:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - explode: false
        in: header
        name: Authorization
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ All Rules
      tags:
      - Propagation Rules
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                plan:
                  id: 9d108dd7-a97e-41ae-98dc-dbe391f68cf0
                environment:
                  id: 38b56b78-eb38-4f7a-afcc-0a1c0f5acd32
                sourceStore:
                  id: 4722a0c4-6e67-4ef5-a8f8-9b275f00bc09
                targetStore:
                  id: a09e3c58-022f-4390-8d9f-d28e9c33537c
                populations:
                - id: 1425fb3b-476e-4cbe-9ef4-e06a52b74ab8
                deprovision: true
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json: {}
          description: Successful response
      summary: CREATE Rule
      tags:
      - Propagation Rules
  /environments/{environmentID}/propagation/rules/{ruleID}:
    delete:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: ruleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Rule
      tags:
      - Propagation Rules
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: ruleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Rule
      tags:
      - Propagation Rules
  /environments/{environmentID}/propagation/plans/{planID}/rules:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - example: application/json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: planID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Plan's Rules
      tags:
      - Propagation Rules
  /environments/{environmentID}/propagation/rules/{storeID}:
    put:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: storeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                plan:
                  id: 9d108dd7-a97e-41ae-98dc-dbe391f68cf0
                name: updated rule
                environment:
                  id: 38b56b78-eb38-4f7a-afcc-0a1c0f5acd32
                sourceStore:
                  id: 4722a0c4-6e67-4ef5-a8f8-9b275f00bc09
                targetStore:
                  id: a09e3c58-022f-4390-8d9f-d28e9c33537c
                populations:
                - id: 1425fb3b-476e-4cbe-9ef4-e06a52b74ab8
                deprovision: true
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE Rule
      tags:
      - Propagation Rules
  /environments/{environmentID}/propagation/mappings/{mappingID}:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: mappingID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Mapping
      tags:
      - Propagation Mappings
    put:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: mappingID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                rule:
                  id: 8c9cc5b2-4171-4804-abd4-115a8948e453
                sourceAttribute: username
                targetAttribute: accountId
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE Mapping
      tags:
      - Propagation Mappings
  /environments/{environmentID}/propagation/rules/{ruleID}/mappings:
    get:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - example: application/json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: ruleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Rule  Mapping
      tags:
      - Propagation Mappings
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: ruleID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                sourceAttribute: accountId
                targetAttribute: userName
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json: {}
          description: Successful response
      summary: CREATE Rule Mapping
      tags:
      - Propagation Mappings
  /environments/{environmentID}/propagation/mapping/{mappingID}:
    delete:
      parameters:
      - example: application/json
        explode: false
        in: header
        name: Accept
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: mappingID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Mapping
      tags:
      - Propagation Mappings
  /environments/{environmentID}/identityProviders:
    get:
      operationId: readAllIdentityProviders
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Identity Providers
      tags:
      - Identity Providers
    post:
      operationId: createIdentityProvider
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProvider'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProvider'
          description: Successful response
      summary: CREATE Identity Provider
      tags:
      - Identity Providers
  /environments/{environmentID}/identityProviders/{providerID}:
    delete:
      operationId: deleteIdentityProvider
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Identity Provider
      tags:
      - Identity Providers
    get:
      operationId: readOneIdentityProvider
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProvider'
          description: Successful response
      summary: READ One Identity Provider
      tags:
      - Identity Providers
    put:
      operationId: updateIdentityProvider
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProvider'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProvider'
          description: Successful response
      summary: UPDATE Identity Provider
      tags:
      - Identity Providers
  /environments/{environmentID}/identityProviders/{providerID}/attributes:
    get:
      operationId: readAllIdentityProviderAttributes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Identity Provider Attributes
      tags:
      - Identity Provider Attributes
    post:
      operationId: createIdentityProviderAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderAttribute'
          description: Successful response
      summary: CREATE Identity Provider Attribute
      tags:
      - Identity Provider Attributes
  /environments/{environmentID}/identityProviders/{providerID}/attributes/{providerAttributeID}:
    delete:
      operationId: deleteIdentityProviderAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerAttributeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Identity Provider Attribute
      tags:
      - Identity Provider Attributes
    get:
      operationId: readOneIdentityProviderAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerAttributeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderAttribute'
          description: Successful response
      summary: READ One Identity Provider Attribute
      tags:
      - Identity Provider Attributes
    put:
      operationId: updateIdentityProviderAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: providerAttributeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderAttribute'
          description: Successful response
      summary: UPDATE Identity Provider Attribute
      tags:
      - Identity Provider Attributes
  /environments/{environmentID}/images:
    post:
      operationId: createImage
      parameters:
      - example: image/jpeg
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - example: attachment; filename=name.jpg
        explode: false
        in: header
        name: Content-Disposition
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          image/*:
            schema:
              format: binary
              type: string
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
          description: Successful response
      summary: CREATE Image
      tags:
      - Images
  /environments/{environmentID}/images/{imgID}:
    delete:
      operationId: deleteImage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: imgID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Image
      tags:
      - Images
    get:
      operationId: readImage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: imgID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
          description: Successful response
      summary: READ Image
      tags:
      - Images
  /environments/{environmentID}/integrations:
    get:
      operationId: readAllIntegrationMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - example: (pingProductNames eq "PINGFEDERATE" and version.releasedOn ge "2020-05-20")
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - example: versions
        explode: true
        in: query
        name: expand
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Integration Metadata
      tags:
      - Integration Catalog
  /environments/{environmentID}/integrations/{integrationID}:
    get:
      operationId: readOneIntegrationMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integration'
          description: Successful response
      summary: READ One Integration Metadata
      tags:
      - Integration Catalog
  /environments/{environmentID}/integrations/{integrationID}/versions:
    get:
      operationId: readIntegrationVersionMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: Read All Integration Versions Metadata
      tags:
      - Integration Catalog
  /environments/{environmentID}/integrations/{integrationID}/versions/{integrationVersionID}:
    get:
      operationId: readOneIntegrationVersionMetadata
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationVersionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationVersion'
          description: Successful response
      summary: READ One Integration Version Metadata
      tags:
      - Integration Catalog
  /environments/{environmentID}/integrations/{integrationID}/versions/{integrationVersionID}/asset:
    get:
      operationId: downloadOneIntegrationVersionAsset
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationVersionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/zip:
              schema:
                format: byte
                type: string
            application/x-zip-compressed:
              schema:
                format: byte
                type: string
          description: Successful response
      summary: Download Integration Version Asset
      tags:
      - Integration Catalog
  /environments/{environmentID}/integrations/{integrationID}/versions/{integrationVersionID}/attributes:
    get:
      operationId: readAllIntegrationVersionAttributes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationVersionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: Read All Attributes of an Integration Version (SAML only)
      tags:
      - Integration Catalog
  ? /environments/{environmentID}/integrations/{integrationID}/versions/{integrationVersionID}/attributes/{integrationVersionAttributeID}
  : get:
      operationId: readOneIntegrationVersionAttributes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationVersionID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: integrationVersionAttributeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationVersionAttribute'
          description: Successful response
      summary: Read One Attributes of an Integration Version (SAML only)
      tags:
      - Integration Catalog
  /environments/{environmentID}/languages:
    get:
      operationId: readLanguages
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Languages
      tags:
      - Languages
    post:
      operationId: createLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Language'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Language'
          description: Successful response
      summary: CREATE Language
      tags:
      - Languages
  /environments/{environmentID}/languages/{languageID}:
    delete:
      operationId: deleteLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Language
      tags:
      - Languages
    get:
      operationId: readOneLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Language'
          description: Successful response
      summary: READ One Language
      tags:
      - Languages
    put:
      operationId: updateLanguage
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Language'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Language'
          description: Successful response
      summary: UPDATE Language
      tags:
      - Languages
  /environments/{environmentID}/languages/{languageID}/status:
    get:
      operationId: readLanguageLocalizationStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageLocalizationStatus'
          description: Successful response
      summary: READ Language Localization Status
      tags:
      - Language Localization Status
    post:
      operationId: createLanguageLocalizationStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LanguageLocalizationStatus'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageLocalizationStatus'
          description: Successful response
      summary: CREATE Language Localization Status
      tags:
      - Language Localization Status
  /environments/{environmentID}/languages/{languageID}/status/{l10nStatusID}:
    delete:
      operationId: deleteLanguageLocalizationStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: l10nStatusID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Language Localization Status
      tags:
      - Language Localization Status
    get:
      operationId: readOneLanguageLocalizationStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: l10nStatusID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageLocalizationStatus'
          description: Successful response
      summary: READ One Language Localization Status
      tags:
      - Language Localization Status
    put:
      operationId: updateLanguageLocalizationStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: languageID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: l10nStatusID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LanguageLocalizationStatus'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageLocalizationStatus'
          description: Successful response
      summary: UPDATE Language Localization Status
      tags:
      - Language Localization Status
  /environments/{environmentID}/templates:
    get:
      operationId: readAllTemplates
      parameters:
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - example: (createdAt lt "2018-08-30") and (updatedAt gt "2018-07-30")
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - example: -createdAt
        explode: true
        in: query
        name: order
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Templates
      tags:
      - Notifications Templates
  /environments/{environmentID}/templates/{templateName}:
    get:
      operationId: readOneTemplate
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
          description: Successful response
      summary: READ One Template
      tags:
      - Notifications Templates
  /environments/{environmentID}/templates/{templateName}/contents:
    delete:
      operationId: deleteBulkVariantContents
      parameters:
      - example: "variant eq {{variantName}}"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Bulk Variant Contents
      tags:
      - Notifications Templates
    get:
      operationId: readAllTemplateContents
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Contents
      tags:
      - Notifications Templates
    patch:
      operationId: patchBulkVariantContents
      parameters:
      - example: "variant eq {{variantName}}"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateContentBulkVariant'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: PATCH Bulk Variant Contents
      tags:
      - Notifications Templates
    post:
      operationId: createContent
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateContent'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateContent'
          description: Successful response
      summary: CREATE Content
      tags:
      - Notifications Templates
  /environments/{environmentID}/templates/{templateName}/contents/{contentID}:
    delete:
      operationId: deleteContent
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      - explode: false
        in: path
        name: contentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Content
      tags:
      - Notifications Templates
    get:
      operationId: readOneContent
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      - explode: false
        in: path
        name: contentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateContent'
          description: Successful response
      summary: READ One Content
      tags:
      - Notifications Templates
    put:
      operationId: updateContent
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: templateName
        required: true
        schema:
          $ref: '#/components/schemas/EnumTemplateName'
        style: simple
      - explode: false
        in: path
        name: contentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateContent'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateContent'
          description: Successful response
      summary: UPDATE Content
      tags:
      - Notifications Templates
  /environments/{environmentID}/translations/{locale}:
    get:
      operationId: readTranslations
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: locale
        required: true
        schema:
          type: string
        style: simple
      - description: Filter by the UI block the translation belongs to. The block
          field is only applicable for flows translations.
        example: UpdateProfile
        explode: true
        in: query
        name: block
        required: false
        schema:
          type: string
        style: form
      - description: Filter by the UI module the translation belongs to. The module
          field is only applicable for flows translations.
        example: flow-ui
        explode: true
        in: query
        name: module
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: Read Translations by locale
      tags:
      - Translations
    put:
      operationId: updateTranslations
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: locale
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocaleTranslations'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocaleTranslations'
          description: Successful response
      summary: Update Translations by locale
      tags:
      - Translations
  /environments/{environmentID}/notificationsSettings:
    delete:
      operationId: deleteNotificationsSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettings'
          description: Successful response
      summary: DELETE Notifications Settings
      tags:
      - Notifications Settings
    get:
      operationId: readNotificationsSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettings'
          description: Successful response
      summary: READ Notifications Settings
      tags:
      - Notifications Settings
    put:
      operationId: updateNotificationsSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsSettings'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettings'
          description: Successful response
      summary: UPDATE Notifications Settings
      tags:
      - Notifications Settings
  /environments/{environmentID}/notificationsSettings/emailDeliverySettings:
    delete:
      operationId: deleteEmailDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Email Delivery Settings
      tags:
      - Notifications Settings (SMTP)
    get:
      operationId: readEmailNotificationsSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettings'
          description: Successful response
      summary: READ Email Notifications Settings
      tags:
      - Notifications Settings (SMTP)
    put:
      operationId: updateEmailNotificationsSettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettings'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettings'
          description: Successful response
      summary: UPDATE Email Notifications Settings
      tags:
      - Notifications Settings (SMTP)
  /environments/{environmentID}/notificationsSettings/phoneDeliverySettings:
    get:
      operationId: readAllPhoneDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Phone Delivery Settings
      tags:
      - Phone Delivery Settings
    post:
      operationId: createPhoneDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
          description: Successful response
      summary: CREATE Phone Delivery Settings
      tags:
      - Phone Delivery Settings
  /environments/{environmentID}/notificationsSettings/phoneDeliverySettings/{phoneDeliverySettingsID}:
    delete:
      operationId: deletePhoneDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: phoneDeliverySettingsID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Phone Delivery Settings
      tags:
      - Phone Delivery Settings
    get:
      operationId: readOnePhoneDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: phoneDeliverySettingsID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
          description: Successful response
      summary: READ One Phone Delivery Settings
      tags:
      - Phone Delivery Settings
    put:
      operationId: updatePhoneDeliverySettings
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: phoneDeliverySettingsID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
          description: Successful response
      summary: UPDATE Phone Delivery Settings
      tags:
      - Phone Delivery Settings
  /environments/{environmentID}/notificationsPolicies:
    get:
      operationId: readAllNotificationsPolicies
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Notifications Policies
      tags:
      - Notifications Policies
    post:
      operationId: createNotificationsPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsPolicy'
          description: Successful response
      summary: CREATE Notifications Policy
      tags:
      - Notifications Policies
  /environments/{environmentID}/notificationsPolicies/{notificationsPolicyID}:
    delete:
      operationId: deleteNotificationsPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: notificationsPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Notifications Policy
      tags:
      - Notifications Policies
    get:
      operationId: readOneNotificationsPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: notificationsPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsPolicy'
          description: Successful response
      summary: READ One Notifications Policy
      tags:
      - Notifications Policies
    put:
      operationId: updateNotificationsPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: notificationsPolicyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsPolicy'
          description: Successful response
      summary: UPDATE Notifications Policy
      tags:
      - Notifications Policies
  /environments/{environmentID}/passwordPolicies:
    get:
      operationId: readAllPasswordPolicies
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Password Policies
      tags:
      - Password Policies
    post:
      operationId: createPasswordPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordPolicy'
        required: true
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicy'
          description: Successful response
      summary: CREATE Password Policy
      tags:
      - Password Policies
  /environments/{environmentID}/passwordPolicies/{passwordPolicyID}:
    delete:
      operationId: deletePasswordPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: passwordPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Password Policy
      tags:
      - Password Policies
    get:
      operationId: readOnePasswordPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: passwordPolicyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicy'
          description: Successful response
      summary: READ One Password Policy
      tags:
      - Password Policies
    put:
      operationId: updatePasswordPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: passwordPolicyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicy'
          description: Successful response
      summary: UPDATE Password Policy
      tags:
      - Password Policies
  /environments/{environmentID}/populations:
    get:
      operationId: readAllPopulations
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - description: Adding a SCIM filter for a population ID or population name to
          display only those resources associated with the specified population. Only
          the id and name parameters are supported
        example: id eq "60971d3b-cc5a-4601-9c44-2be541f91bf1"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: "Adding a cursor value to retrieve the next page of results,\
          \ used with the `limit` parameter. The cursor value is returned in the `_links.next.href`\
          \ link in the response payload."
        explode: true
        in: query
        name: cursor
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Populations
      tags:
      - Populations
    post:
      operationId: createPopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Population'
        required: true
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Population'
          description: Successful response
      summary: CREATE Population
      tags:
      - Populations
  /environments/{environmentID}/populations/{populationID}:
    delete:
      operationId: deletePopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: populationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Population
      tags:
      - Populations
    get:
      operationId: readOnePopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: populationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Population'
          description: Successful response
      summary: READ One Population
      tags:
      - Populations
    put:
      operationId: updatePopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: populationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Population'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Population'
          description: Successful response
      summary: UPDATE Population
      tags:
      - Populations
  /environments/{environmentID}/populations/{populationID}/defaultIdentityProvider:
    get:
      operationId: readOnePopulationDefaultIdp
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: populationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PopulationDefaultIdp'
          description: Successful response
      summary: READ One Population Default Identity Provider
      tags:
      - Populations
    put:
      operationId: updatePopulationDefaultIdp
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: populationID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PopulationDefaultIdp'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PopulationDefaultIdp'
          description: Successful response
      summary: UPDATE Population Default Identity Provider
      tags:
      - Populations
  /environments/{environmentID}/rateLimitIpConfigs:
    get:
      operationId: readAllRateLimitConfigurations
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Rate Limit Configurations
      tags:
      - Rate Limiting
    post:
      operationId: createRateLimitConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RateLimitConfiguration'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitConfiguration'
          description: Successful response
      summary: CREATE Rate Limit Configuration
      tags:
      - Rate Limiting
  /environments/{environmentID}/rateLimitIpConfigs/{rateLimitConfigurationID}:
    delete:
      operationId: deleteRateLimitConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: rateLimitConfigurationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Rate Limit Configuration
      tags:
      - Rate Limiting
    get:
      operationId: readOneRateLimitConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: rateLimitConfigurationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitConfiguration'
          description: Successful response
      summary: READ One Rate Limit Configuration
      tags:
      - Rate Limiting
  /environments/{environmentID}/recaptchaV2Config:
    delete:
      operationId: deleteRecaptchaConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Recaptcha Configuration
      tags:
      - Recaptcha Configuration
    get:
      operationId: readRecaptchaConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecaptchaConfiguration'
          description: Successful response
      summary: READ Recaptcha Configuration
      tags:
      - Recaptcha Configuration
    put:
      operationId: updateRecaptchaConfiguration
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecaptchaConfiguration'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecaptchaConfiguration'
          description: Successful response
      summary: UPDATE Recaptcha Configuration
      tags:
      - Recaptcha Configuration
  /environments/{environmentID}/resources:
    get:
      operationId: readAllResources
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Resources
      tags:
      - Resources
    post:
      operationId: createResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resource'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
          description: Successful response
      summary: CREATE Resource
      tags:
      - Resources
  /environments/{environmentID}/resources/{resourceID}:
    delete:
      operationId: deleteResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Resource
      tags:
      - Resources
    get:
      operationId: readOneResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
          description: Successful response
      summary: READ One Resource
      tags:
      - Resources
    put:
      operationId: updateResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resource'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
          description: Successful response
      summary: UPDATE Resource
      tags:
      - Resources
  /environments/{environmentID}/resources/{resourceID}/applicationResources:
    get:
      operationId: readAllApplicationResources
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Application Resources
      tags:
      - Application Resources
    post:
      operationId: createApplicationResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceApplicationResource'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceApplicationResource'
          description: Successful response
      summary: CREATE Application Resource
      tags:
      - Application Resources
  /environments/{environmentID}/resources/{resourceID}/applicationResources/{applicationResourceID}:
    delete:
      operationId: deleteApplicationResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationResourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Application Resource
      tags:
      - Application Resources
    get:
      operationId: readOneApplicationResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationResourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceApplicationResource'
          description: Successful response
      summary: READ One Application Resource
      tags:
      - Application Resources
    put:
      operationId: updateApplicationResource
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationResourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceApplicationResource'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceApplicationResource'
          description: Successful response
      summary: UPDATE Application Resource
      tags:
      - Application Resources
  /environments/{environmentID}/resources/{resourceID}/applicationPermissions:
    get:
      operationId: readAllApplicationPermissions
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Application Permissions
      tags:
      - Application Permissions
  /environments/{environmentID}/resources/{resourceID}/attributes:
    get:
      operationId: readAllResourceAttributes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Resource Attributes
      tags:
      - Resource Attributes
    post:
      operationId: createResourceAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAttribute'
          description: Successful response
      summary: CREATE Resource Attribute
      tags:
      - Resource Attributes
  /environments/{environmentID}/resources/{resourceID}/attributes/{resourceAttrID}:
    delete:
      operationId: deleteResourceAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceAttrID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Resource Attribute
      tags:
      - Resource Attributes
    get:
      operationId: readOneResourceAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceAttrID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAttribute'
          description: Successful response
      summary: READ One Resource Attribute
      tags:
      - Resource Attributes
    put:
      operationId: updateResourceAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceAttrID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAttribute'
          description: Successful response
      summary: UPDATE Resource Attribute
      tags:
      - Resource Attributes
  /environments/{environmentID}/resources/{resourceID}/secret:
    delete:
      operationId: deletePreviousResourceSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Previous Resource Secret
      tags:
      - Resource Client Secret
    get:
      operationId: readResourceSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSecret'
          description: Successful response
      summary: READ Resource Secret
      tags:
      - Resource Client Secret
    post:
      operationId: updateResourceSecret
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceSecret'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSecret'
          description: Successful response
      summary: UPDATE Resource Secret
      tags:
      - Resource Client Secret
  /environments/{environmentID}/resources/{resourceID}/scopes:
    get:
      operationId: readAllResourceScopes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Scopes (Resource)
      tags:
      - Resource Scopes
    post:
      operationId: createResourceScope
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceScope'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceScope'
          description: Successful response
      summary: CREATE PingOne access control scope
      tags:
      - Resource Scopes
  /environments/{environmentID}/resources/{resourceID}/scopes/{scopeID}:
    delete:
      operationId: deleteResourceScope
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: scopeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Scope
      tags:
      - Resource Scopes
    get:
      operationId: readOneResourceScope
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: scopeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceScope'
          description: Successful response
      summary: READ One Scope
      tags:
      - Resource Scopes
    put:
      operationId: updateResourceScope
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: resourceID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: scopeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceScope'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceScope'
          description: Successful response
      summary: UPDATE PingOne access control scope
      tags:
      - Resource Scopes
  /environments/{environmentID}/roles:
    get:
      operationId: readAllCustomAdminRoles
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - example: type eq "CUSTOM"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Custom Admin Roles
      tags:
      - Custom Admin Roles
    post:
      operationId: createCustomAdminRole
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAdminRole'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAdminRole'
          description: Successful response
      summary: CREATE Custom Role
      tags:
      - Custom Admin Roles
  /environments/{environmentID}/roles/{customRoleID}:
    delete:
      operationId: deleteCustomAdminRole
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customRoleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Custom Role
      tags:
      - Custom Admin Roles
    get:
      operationId: readOneCustomAdminRole
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customRoleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAdminRole'
          description: Successful response
      summary: READ One Custom Role
      tags:
      - Custom Admin Roles
    put:
      operationId: updateCustomAdminRole
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: customRoleID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAdminRole'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAdminRole'
          description: Successful response
      summary: UPDATE Custom Role
      tags:
      - Custom Admin Roles
  /environments/{environmentID}/schemas:
    get:
      operationId: readAllSchemas
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Schemas
      tags:
      - Schemas
  /environments/{environmentID}/schemas/{schemaID}:
    get:
      operationId: readOneSchema
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schema'
          description: Successful response
      summary: READ One Schema
      tags:
      - Schemas
  /environments/{environmentID}/schemas/{schemaID}/attributes:
    get:
      operationId: readAllSchemaAttributes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All (Schema) Attributes
      tags:
      - Schemas
    post:
      operationId: createAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaAttribute'
          description: Successful response
      summary: CREATE Attribute
      tags:
      - Schemas
  /environments/{environmentID}/schemas/{schemaID}/attributes/{attributeID}:
    delete:
      operationId: deleteAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attributeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Attribute
      tags:
      - Schemas
    get:
      operationId: readOneAttribute
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attributeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaAttribute'
          description: Successful response
      summary: READ One Attribute
      tags:
      - Schemas
    patch:
      operationId: updateAttributePatch
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attributeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaAttributePatch'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaAttribute'
          description: Successful response
      summary: UPDATE Attribute (Patch)
      tags:
      - Schemas
    put:
      operationId: updateAttributePut
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: schemaID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: attributeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaAttribute'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaAttribute'
          description: Successful response
      summary: UPDATE Attribute (Put)
      tags:
      - Schemas
  /environments/{environmentID}/signOnPolicies:
    get:
      operationId: readAllSignOnPolicies
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Sign On Policies
      tags:
      - Sign-On Policies
    post:
      operationId: createSignOnPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicy'
          description: Successful response
      summary: CREATE Sign On Policy
      tags:
      - Sign-On Policies
  /environments/{environmentID}/signOnPolicies/{policyID}:
    delete:
      operationId: deleteSignOnPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Sign On Policy
      tags:
      - Sign-On Policies
    get:
      operationId: readOneSignOnPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicy'
          description: Successful response
      summary: READ One Sign On Policy
      tags:
      - Sign-On Policies
    put:
      operationId: updateSignOnPolicy
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicy'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicy'
          description: Successful response
      summary: UPDATE Sign On Policy
      tags:
      - Sign-On Policies
  /environments/{environmentID}/signOnPolicies/{policyID}/actions:
    get:
      operationId: readAllSignOnPolicyActions
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Sign-On Policy Actions
      tags:
      - Sign-On Policy Actions
    post:
      operationId: createSignOnPolicyAction
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicyAction'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAction'
          description: Successful response
      summary: CREATE Sign-On Policy Action
      tags:
      - Sign-On Policy Actions
  /environments/{environmentID}/signOnPolicies/{policyID}/actions/{actionID}:
    delete:
      operationId: deleteSignOnPolicyAction
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: actionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Sign-On Policy Action
      tags:
      - Sign-On Policy Actions
    get:
      operationId: readOneSignOnPolicyAction
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: actionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAction'
          description: Successful response
      summary: READ One Sign-On Policy Action
      tags:
      - Sign-On Policy Actions
    put:
      operationId: updateSignOnPolicyAction
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: policyID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: actionID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignOnPolicyAction'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignOnPolicyAction'
          description: Successful response
      summary: UPDATE Sign-On Policy Action
      tags:
      - Sign-On Policy Actions
  /environments/{environmentID}/status:
    put:
      operationId: updateEnvironmentStatus
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentStatus'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
          description: Successful response
      summary: Update Environment Status
      tags:
      - Environments
  /environments/{environmentID}/subscriptions:
    get:
      operationId: readAllSubscriptions
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Subscriptions
      tags:
      - Subscriptions (webhooks)
    post:
      operationId: createSubscription
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Successful response
      summary: CREATE Subscription
      tags:
      - Subscriptions (webhooks)
  /environments/{environmentID}/subscriptions/{subscriptionID}:
    delete:
      operationId: deleteSubscription
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Subscription
      tags:
      - Subscriptions (webhooks)
    get:
      operationId: readOneSubscription
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Successful response
      summary: READ One Subscription
      tags:
      - Subscriptions (webhooks)
    put:
      operationId: updateSubscription
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: subscriptionID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Successful response
      summary: UPDATE Subscription
      tags:
      - Subscriptions (webhooks)
  /environments/{environmentID}/themes:
    get:
      operationId: readBrandingThemes
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Branding Themes
      tags:
      - Branding Themes
    post:
      operationId: createBrandingTheme
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingTheme'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingTheme'
          description: Successful response
      summary: CREATE Branding Theme
      tags:
      - Branding Themes
  /environments/{environmentID}/themes/{themeID}:
    delete:
      operationId: deleteBrandingTheme
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: themeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Branding Theme
      tags:
      - Branding Themes
    get:
      operationId: readOneBrandingTheme
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: themeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingTheme'
          description: Successful response
      summary: READ One Branding Theme
      tags:
      - Branding Themes
    put:
      operationId: updateBrandingTheme
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: themeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingTheme'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingTheme'
          description: Successful response
      summary: UPDATE Branding Theme
      tags:
      - Branding Themes
  /environments/{environmentID}/themes/{themeID}/default:
    get:
      operationId: readBrandingThemeDefault
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: themeID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingThemeDefault'
          description: Successful response
      summary: READ Branding Theme Default
      tags:
      - Branding Themes
    put:
      operationId: updateBrandingThemeDefault
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: themeID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingThemeDefault'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingThemeDefault'
          description: Successful response
      summary: UPDATE Branding Theme Default
      tags:
      - Branding Themes
  /environments/{environmentID}/totalIdentities:
    get:
      parameters:
      - example: startDate eq "2019-05-01T19:00:00Z" and endDate eq "2019-05-31T19:00:00Z"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Total Identity Counts
      tags:
      - Total Identities
  /environments/{environmentID}/userActivities:
    get:
      parameters:
      - example: startDate eq "2018-02-17T09:10:12-04:00" and endDate eq "2018-02-23T09:10:12-04:00"
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ User Activities
      tags:
      - User Activities
  /environments/{environmentID}/users:
    get:
      operationId: readAllUsers
      parameters:
      - example: "memberOfGroups[id eq \"{{groupID}}\"] and name.family eq \"demo\""
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          maximum: 1000
          minimum: 1
          type: integer
        style: form
      - description: "Adding a cursor value to retrieve the next page of results,\
          \ used with the `limit` parameter. The cursor value is returned in the `_links.next.href`\
          \ link in the response payload."
        explode: true
        in: query
        name: cursor
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Users
      tags:
      - Users
    post:
      operationId: createUser
      parameters:
      - example: application/vnd.pingidentity.user.import+json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
          application/vnd.pingidentity.user.import+json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
          x-pingone-docs-8830: true
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Successful response
      summary: CREATE User
      tags:
      - Users
  /environments/{environmentID}/users/{userID}:
    delete:
      operationId: deleteUser
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE User
      tags:
      - Users
    get:
      operationId: readUser
      parameters:
      - example: memberOfGroupIDs
        explode: true
        in: query
        name: include
        required: false
        schema:
          $ref: '#/components/schemas/EnumUserRequestInclude'
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Successful response
      summary: READ User
      tags:
      - Users
    patch:
      operationId: updateUserPatch
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Successful response
      summary: UPDATE User (Patch)
      tags:
      - Users
    post:
      operationId: userAccount
      parameters:
      - explode: false
        in: header
        name: content-type
        required: false
        schema:
          $ref: '#/components/schemas/EnumUserAccountContentTypeHeader'
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAccount'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Successful response
      summary: User Account
      tags:
      - User Accounts
    put:
      operationId: updateUserPut
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Successful response
      summary: UPDATE User (Put)
      tags:
      - Users
  /environments/{environmentID}/users/{userID}/applicationRoles:
    get:
      operationId: readUserApplicationRoleAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ User Application Role Assignments
      tags:
      - User Application Role Assignments
    post:
      operationId: createUserApplicationRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserApplicationRoleAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserApplicationRoleAssignment'
          description: Successful response
      summary: CREATE User Application Role Assignment
      tags:
      - User Application Role Assignments
  /environments/{environmentID}/users/{userID}/applicationRoles/{applicationRoleID}:
    delete:
      operationId: deleteUserApplicationRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: applicationRoleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE User Application Role Assignment
      tags:
      - User Application Role Assignments
  /environments/{environmentID}/users/{userID}/identityProvider:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ User Identity Provider
      tags:
      - Users
    put:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                identityProvider:
                  id: "{{idpID}}"
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE User Identity Provider
      tags:
      - Users
  /environments/{environmentID}/users/{userID}/verifyStatus:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ user verification status
      tags:
      - Users
    put:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                verifyStatus: ENABLED
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE user verification status
      tags:
      - Users
  /environments/{environmentID}/users/{userID}/memberOfGroups:
    get:
      operationId: readAllGroupMembershipsForUser
      parameters:
      - example: group
        explode: true
        in: query
        name: expand
        required: false
        schema:
          type: string
        style: form
      - example: "100"
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - description: "Adding a cursor value to retrieve the next page of results,\
          \ used with the `limit` parameter. The cursor value is returned in the `_links.next.href`\
          \ link in the response payload."
        explode: true
        in: query
        name: cursor
        required: false
        schema:
          type: string
        style: form
      - explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Group Memberships for User
      tags:
      - Group Membership
    post:
      operationId: addUserToGroup
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMembership'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembership'
          description: Successful response
      summary: ADD User to Group
      tags:
      - Group Membership
  /environments/{environmentID}/users/{userID}/memberOfGroups/{groupID}:
    delete:
      operationId: removeUserFromGroup
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: REMOVE User from Group
      tags:
      - Group Membership
    get:
      operationId: readOneGroupMembershipForUser
      parameters:
      - example: group
        explode: true
        in: query
        name: expand
        required: false
        schema:
          $ref: '#/components/schemas/EnumUserGroupAssignmentExpandParameter'
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: groupID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembership'
          description: Successful response
      summary: READ One Group Membership for User
      tags:
      - Group Membership
  /environments/{environmentID}/users/{userID}/enabled:
    get:
      operationId: readUserEnabled
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEnabled'
          description: Successful response
      summary: READ User Enabled
      tags:
      - Enable Users
    put:
      operationId: updateUserEnabled
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserEnabled'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEnabled'
          description: Successful response
      summary: UPDATE User Enabled
      tags:
      - Enable Users
  /environments/{environmentID}/users/{userID}/linkedAccounts:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Linked Accounts
      tags:
      - Linked Accounts
  /environments/{environmentID}/users/{userID}/linkedAccounts/{linkedAccountID}:
    delete:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: linkedAccountID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Linked Account
      tags:
      - Linked Accounts
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: linkedAccountID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Linked Account
      tags:
      - Linked Accounts
  /environments/{environmentID}/users/{userID}/pairingKeys/{pairingKeyID}:
    delete:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: pairingKeyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE MFA Pairing Key
      tags:
      - MFA Pairing Keys
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: pairingKeyID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One MFA Pairing Key
      tags:
      - MFA Pairing Keys
  /environments/{environmentID}/users/{userID}/pairingKeys:
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                applications:
                - id: "{{applicationID}}"
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json: {}
          description: Successful response
      summary: CREATE MFA Pairing Key
      tags:
      - MFA Pairing Keys
  /environments/{environmentID}/users/{userID}/population:
    get:
      operationId: readUserPopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPopulation'
          description: Successful response
      summary: READ User Population
      tags:
      - User Populations
    put:
      operationId: updateUserPopulation
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPopulation'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPopulation'
          description: Successful response
      summary: UPDATE User Population
      tags:
      - User Populations
  /environments/{environmentID}/users/{userID}/password:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Password State
      tags:
      - User Passwords
    post:
      parameters:
      - example: application/vnd.pingidentity.password.recover+json
        explode: false
        in: header
        name: content-type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                recoveryCode: <code>
                newPassword: VerySecure123!
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Password Locked Out
      tags:
      - User Passwords
    put:
      parameters:
      - example: application/vnd.pingidentity.password.set+json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                value: "{SSHA512}UkGWfORubNKFpFBWh+Lgy4FrciclzUXneuryV+B+zBDR4Gqd5wvMqAvKRixgQWoZlZUgq8Wh40uMK3s6bWpzWt1/TqQH02hX"
                forceChange: true
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE Password (Set)
      tags:
      - User Passwords
  /environments/{environmentID}/users/{userID}/roleAssignments:
    get:
      operationId: readUserRoleAssignments
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ Role Assignments
      tags:
      - User Role Assignments
    post:
      operationId: createUserRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignment'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: CREATE User Role Assignment
      tags:
      - User Role Assignments
  /environments/{environmentID}/users/{userID}/roleAssignments/{roleAssignmentID}:
    delete:
      operationId: deleteUserRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE User's Role Assignment
      tags:
      - User Role Assignments
    get:
      operationId: readOneUserRoleAssignment
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: roleAssignmentID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
          description: Successful response
      summary: READ One Role Assignment
      tags:
      - User Role Assignments
  /environments/{environmentID}/users/{userID}/verifyTransactions:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ All ID Verification Transaction Records for a User
      tags:
      - User ID Verification
    post:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "201":
          content:
            application/json: {}
          description: Successful response
      summary: CREATE ID Verification Transaction Record for a User
      tags:
      - User ID Verification
  /environments/{environmentID}/users/{userID}/verifyTransactions/{transactionID}:
    delete:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: transactionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE ID Verification Transaction Record for a User
      tags:
      - User ID Verification
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: transactionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ ID Verification Transaction Record for a User
      tags:
      - User ID Verification
    put:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: transactionID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              example:
                transactionStatus:
                  status: APPROVED_NO_REQUEST
              type: object
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: UPDATE ID Verification Transaction Record for a User
      tags:
      - User ID Verification
  /environments/{environmentID}/users/{userID}/agreementConsents:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ All User Agreement Consents
      tags:
      - User Agreement Consents
  /environments/{environmentID}/users/{userID}/agreementConsents/{agreementID}:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One User Agreement Consent
      tags:
      - User Agreement Consents
    post:
      parameters:
      - example: application/vnd.pingidentity.consent.revoke+json
        explode: false
        in: header
        name: Content-Type
        required: false
        schema:
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: agreementID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "405":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: Revoke Agreement
      tags:
      - User Agreement Consents
  /environments/{environmentID}/users/{userID}/sessions:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ All Sessions
      tags:
      - Sessions
  /environments/{environmentID}/users/{userID}/sessions/{sessionID}:
    delete:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: sessionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "204":
          description: Successful response
      summary: DELETE Session
      tags:
      - Sessions
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: environmentID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: userID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: sessionID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ One Session
      tags:
      - Sessions
  /organizations:
    get:
      operationId: readAllOrganizations
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: Adding a paging value to limit the number of resources displayed
          per page
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Organizations
      tags:
      - Organizations
  /organizations/{organizationID}:
    get:
      operationId: readOneOrganization
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: Successful response
      summary: READ One Organization
      tags:
      - Organizations
  /organizations/{organizationID}/capabilities:
    get:
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Organization Capabilities
      tags:
      - Capabilities
  /organizations/{organizationID}/licenses:
    get:
      operationId: readAllLicenses
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      - description: "For organizations with more than one license, you can use a\
          \ filter to return the list of licenses in descending order."
        example: "filter=beginsAt lt \"{{now}}\""
        explode: true
        in: query
        name: filter
        required: false
        schema:
          type: string
        style: form
      - example: order=-beginsAt
        explode: true
        in: query
        name: order
        required: false
        schema:
          type: string
        style: form
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Licenses
      tags:
      - Licenses
  /organizations/{organizationID}/licenses/{licenseID}:
    get:
      operationId: readOneLicense
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: licenseID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
          description: Successful response
      summary: READ One License
      tags:
      - Licenses
  /organizations/{organizationID}/licenses/{licenseID}/name:
    get:
      operationId: readOneLicenseName
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: licenseID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseName'
          description: Successful response
      summary: READ One License Name
      tags:
      - Licenses
    put:
      operationId: updateOneLicenseName
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: licenseID
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseName'
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseName'
          description: Successful response
      summary: Update One License Name
      tags:
      - Licenses
  /organizations/{organizationID}/licenses/{licenseID}/metrics/activeIdentityCounts:
    get:
      operationId: readActiveIdentityCount
      parameters:
      - example: calendarMonth
        explode: true
        in: query
        name: aggregatedBy
        required: false
        schema:
          type: string
        style: form
      - example: "20"
        explode: true
        in: query
        name: limit
        required: false
        schema:
          type: integer
        style: form
      - example: -startDate
        explode: true
        in: query
        name: order
        required: false
        schema:
          type: string
        style: form
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: organizationID
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: licenseID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json: {}
          description: Successful response
      summary: READ Active Identity Counts by License
      tags:
      - Active Identity Counts
  /roles:
    get:
      operationId: readAllRoles
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityArray'
          description: Successful response
      summary: READ All Roles
      tags:
      - Roles
  /roles/{roleID}:
    get:
      operationId: readOneRole
      parameters:
      - description: |
          An ID for telemetry purposes to correlate transactions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Transaction-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - description: |
          An ID for telemetry purposes to correlate sessions with client systems through PingOne products. This may be a user defined value. If a value isn't provided on the API request, a unique value will be generated in the API response. See [External transaction and session IDs](https://apidocs.pingidentity.com/pingone/platform/v1/api/#external-transaction-and-session-ids) for more information.
          Any invalid characters will be converted to underscores. The following characters are allowed:
          Unicode letters, combining marks, numeric characters, dots, underscores, dashes
          `/`, `@`, `=`, `#`, `+`
        explode: false
        in: header
        name: X-Ping-External-Session-ID
        required: false
        schema:
          maxLength: 100
          type: string
        style: simple
      - explode: false
        in: path
        name: roleID
        required: true
        schema:
          type: string
        style: simple
      responses:
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: "Invalid request received.  Malformed JSON, malformed HTTP\
            \ request."
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request failed due to authorization issue.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Not found.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Conflict.
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Request was rate limited
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/P1Error'
          description: Uncaught error occurred.  Platform outage
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Successful response
      summary: READ One Role
      tags:
      - Roles
components:
  responses:
    "400":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: "Invalid request received.  Malformed JSON, malformed HTTP request."
    "401":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Request failed due to authorization issue.
    "403":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Request failed due to authorization issue.
    "404":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Not found.
    "405":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: "Invalid request received.  Malformed JSON, malformed HTTP request."
    "409":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Conflict.
    "429":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Request was rate limited
    "500":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/P1Error'
      description: Uncaught error occurred.  Platform outage
  schemas:
    LinksHATEOAS:
      additionalProperties:
        $ref: '#/components/schemas/LinksHATEOAS_value'
      readOnly: true
      type: object
    EnumAdministratorSecurityAuthenticationMethod:
      default: PINGONE
      description: "Indicates whether to use PingOne MFA, an external IdP, or a combination\
        \ of both for admin sign-on. Possible values are `PINGONE`, `EXTERNAL`, or\
        \ `HYBRID`. The default is `PINGONE`."
      enum:
      - PINGONE
      - EXTERNAL
      - HYBRID
      type: string
    EnumAdministratorSecurityMfaStatus:
      description: This property must be set to `ENFORCE` as MFA is required for administrator
        sign-ons. This property applies only to the specified environment.
      enum:
      - ENFORCE
      type: string
    EnumAgreementRevisionContentType:
      description: "An immutable string that specifies the content type of text. Options\
        \ are text/html and text/plain, as defined by [rfc-6838](https://datatracker.ietf.org/doc/html/rfc6838#section-4.2.1)\
        \ and [Media Types/text](https://www.iana.org/assignments/media-types/media-types.xhtml#text).\
        \ This attribute is supported in POST requests only."
      enum:
      - text/html
      - text/plain
      type: string
    EnumAlertChannelAlertType:
      description: Alert channel alerting types.
      enum:
      - CERTIFICATE_EXPIRED
      - CERTIFICATE_EXPIRING
      - GATEWAY_VERSION_DEPRECATED
      - GATEWAY_VERSION_DEPRECATING
      - KEY_PAIR_EXPIRED
      - KEY_PAIR_EXPIRING
      - LICENSE_90_PERCENT_USER_SOFT_LIMIT
      - LICENSE_EXPIRED
      - LICENSE_EXPIRING
      - LICENSE_ROTATED
      - LICENSE_USER_HARD_LIMIT_EXCEEDED
      - LICENSE_USER_SOFT_LIMIT_EXCEEDED
      - RATE_LIMIT_EXCEEDED
      - RATE_LIMIT_WARNING
      - RISK_CONFIGURATION
      - SUSPICIOUS_TRAFFIC
      type: string
    EnumAlertChannelSeverity:
      description: "Alert channel severity. Possible values are `INFO`, `WARNING`,\
        \ and `ERROR`."
      enum:
      - INFO
      - WARNING
      - ERROR
      type: string
    EnumAlertChannelType:
      description: Alert channel type enumeration. Possible values are `EMAIL`.
      enum:
      - EMAIL
      type: string
    EnumApplicationAccessControlType:
      description: "A string that specifies the user role required to access the application.\
        \ Options are ADMIN_USERS_ONLY. A user is an admin user if the user has one\
        \ or more of the following roles Organization Admin, Environment Admin, Identity\
        \ Data Admin, or Client Application Developer."
      enum:
      - ADMIN_USERS_ONLY
      type: string
    EnumApplicationAccessControlGroupType:
      description: A string that specifies the group type required to access the application.
        Options are `ANY_GROUP` (the actor must belong to at least one group listed
        in the `groups` property) and `ALL_GROUPS` (the actor must belong to all groups
        listed in the `groups` property).
      enum:
      - ANY_GROUP
      - ALL_GROUPS
      type: string
    EnumApplicationCorsSettingsBehavior:
      description: The behavior of CORS for the application. `ALLOWS_NO_ORIGINS` rejects
        all CORS requests.  `ALLOW_SPECIFIC_ORIGINS` rejects all CORS requests except
        those listed in `corsSettings.origins`.
      enum:
      - ALLOW_NO_ORIGINS
      - ALLOW_SPECIFIC_ORIGINS
      type: string
    EnumApplicationNativeGooglePlayVerificationType:
      description: "The type of verification that should be used. The possible values\
        \ are `GOOGLE` and `INTERNAL`. Using internal verification will not count\
        \ against your Google API call quota. The value you select for `verificationType`\
        \ determines what other parameters you must provide. When set to `GOOGLE`,\
        \ you must provide `serviceAccountCredentials`. When set to `INTERNAL`, you\
        \ must provide `decryptionKey` and `verificationKey`."
      enum:
      - GOOGLE
      - INTERNAL
      type: string
    EnumApplicationOIDCGrantType:
      enum:
      - AUTHORIZATION_CODE
      - IMPLICIT
      - REFRESH_TOKEN
      - CLIENT_CREDENTIALS
      - DEVICE_CODE
      - TOKEN_EXCHANGE
      - CIBA
      type: string
    EnumApplicationOIDCPARRequirement:
      default: OPTIONAL
      description: Whether pushed authorization requests (PAR) are required. Options
        are `REQUIRED` and `OPTIONAL`. The default value is `OPTIONAL`.
      enum:
      - REQUIRED
      - OPTIONAL
      type: string
    EnumApplicationOIDCPKCEOption:
      description: A string that specifies how PKCE request parameters are handled
        on the authorize request. Options are OPTIONAL PKCE code_challenge is optional
        and any code challenge method is acceptable. REQUIRED PKCE code_challenge
        is required and any code challenge method is acceptable. S256_REQUIRED PKCE
        code_challege is required and the code_challenge_method must be S256.
      enum:
      - OPTIONAL
      - REQUIRED
      - S256_REQUIRED
      type: string
    EnumApplicationOIDCResponseType:
      description: "The code or token type returned by an authorization request. Options\
        \ are `TOKEN`, `ID_TOKEN`, and `CODE`. For hybrid flows that specify `CODE`\
        \ with `TOKEN` or `ID_TOKEN`, see [Hybrid grant type](https://apidocs.pingidentity.com/pingone/main/v1/api/#hybrid-grant-type)."
      enum:
      - TOKEN
      - ID_TOKEN
      - CODE
      type: string
    EnumApplicationOIDCTokenAuthMethod:
      description: A string that specifies the client authentication methods supported
        by the token endpoint.
      enum:
      - NONE
      - CLIENT_SECRET_BASIC
      - CLIENT_SECRET_POST
      - PRIVATE_KEY_JWT
      - CLIENT_SECRET_JWT
      type: string
    EnumApplicationOIDCRefreshTokenType:
      description: "The format of the refresh token. As opaque tokens are more secure\
        \ and the recommended format, Ping Identity is shifting towards deprecating\
        \ JWT tokens. For more information, refer to [Refresh Tokens](https://developer.pingidentity.com/pingone-api/foundations/authentication-concepts/access-tokens-and-id-tokens.html#refresh-tokens)."
      enum:
      - JSON_WEB_TOKEN
      - OPAQUE_TOKEN
      type: string
    EnumApplicationProtocol:
      description: A string that specifies the protocol for the Application.
      enum:
      - OPENID_CONNECT
      - SAML
      - WS_FED
      - EXTERNAL_LINK
      type: string
    EnumApplicationPushNumberMatchingType:
      description: |
        This option is used to specify the type of number matching that should be used in MFA policies where number matching has been enabled for the application. The possible values are:
         - `SELECT_NUMBER` - Users must select the correct number from a group of three numbers
         - `ENTER_MANUALLY` - Users must enter the number that was shown
      enum:
      - SELECT_NUMBER
      - ENTER_MANUALLY
      type: string
    EnumApplicationSAMLSloBinding:
      default: HTTP_POST
      description: A string that specifies the binding protocol to be used for the
        logout response. Options are HTTP_REDIRECT or HTTP_POST. The default is HTTP_POST;
        existing configurations with no data default to HTTP_POST.
      enum:
      - HTTP_REDIRECT
      - HTTP_POST
      type: string
    EnumApplicationTags:
      enum:
      - PING_FED_CONNECTION_INTEGRATION
      type: string
    EnumApplicationType:
      description: A string that specifies the type associated with the application.
        This is a required property.
      enum:
      - WEB_APP
      - NATIVE_APP
      - SINGLE_PAGE_APP
      - WORKER
      - SERVICE
      - CUSTOM_APP
      - PING_ONE_SELF_SERVICE
      - PING_ONE_ADMIN_CONSOLE
      - PING_ONE_PORTAL
      - TEMPLATE_APP
      - PORTAL_LINK_APP
      type: string
    EnumApplicationWSFEDIDPSigningAlgorithm:
      description: "The signature algorithm to be used for signing. Algorithms supported\
        \ `SHA256withRSA`, `SHA384withRSA`, `SHA512withRSA`, `SHA256withECDSA`, `SHA384withECDSA`,\
        \ and `SHA512withECDSA`."
      enum:
      - SHA256withRSA
      - SHA384withRSA
      - SHA512withRSA
      - SHA256withECDSA
      - SHA384withECDSA
      - SHA512withECDSA
      type: string
    EnumApplicationWSFEDKerberosGatewayType:
      description: The gateway type. This must be "LDAP".
      enum:
      - LDAP
      type: string
    EnumAttributeMappingType:
      description: "A string that specifies the mapping type of the attribute. Options\
        \ are CORE, SCOPE, and CUSTOM. The CORE and SCOPE mapping types are for reserved\
        \ attributes managed by the API and cannot be removed. Attribute values for\
        \ these mapping types can be updated. The CUSTOM mapping type is for user-defined\
        \ attributes. Attributes of this type can be updated and deleted."
      enum:
      - CORE
      - SCOPE
      - CUSTOM
      type: string
    EnumBillOfMaterialsProductTags:
      enum:
      - DAVINCI_MINIMAL
      - AUTHENTICATION_MODE_AGENT
      - AUTHENTICATION_MODE_AGENTLESS
      type: string
    EnumBrandingLogoType:
      description: The type of format used for the image. Options are IMAGE and NONE.
      enum:
      - IMAGE
      - NONE
      type: string
    EnumBrandingThemeBackgroundType:
      description: "The background type for the theme. Options are `NONE`, `COLOR`,\
        \ `IMAGE`, `DEFAULT`."
      enum:
      - NONE
      - COLOR
      - IMAGE
      - DEFAULT
      type: string
    EnumBrandingThemeTemplate:
      description: "The template name of the branding theme associated with the environment.\
        \ Options are default, focus, mural, slate, and split."
      enum:
      - default
      - focus
      - mural
      - slate
      - split
      type: string
    EnumBrandingThemeLocalizedContentType:
      description: The content type for the localized text. Options are `RichText`
        and `HTML`.
      enum:
      - RichText
      - HTML
      type: string
    EnumCertificateKeyAlgorithm:
      description: "Specifies the key algorithm. Options are `RSA`, `EC`, and `UNKNOWN`."
      enum:
      - RSA
      - EC
      - UNKNOWN
      type: string
    EnumCertificateKeyEncryptionAlgorithm:
      description: The algorithm to use when encrypting assertions.
      enum:
      - AES_128
      - AES_256
      - TRIPLEDES
      type: string
    EnumCertificateKeySignagureAlgorithm:
      description: "Specifies the signature algorithm of the key. For RSA keys, options\
        \ are `SHA256withRSA`, `SHA384withRSA` and `SHA512withRSA`. For elliptical\
        \ curve (EC) keys, options are `SHA256withECDSA`, `SHA384withECDSA`, and `SHA512withECDSA`"
      enum:
      - SHA256withRSA
      - SHA384withRSA
      - SHA512withRSA
      - SHA256withECDSA
      - SHA384withECDSA
      - SHA512withECDSA
      type: string
    EnumCertificateKeyStatus:
      description: "Specifies the status of the key. Options are `VALID`, `EXPIRING`,\
        \ `EXPIRED`, `NOT_YET_VALID`, and `REVOKED`."
      enum:
      - VALID
      - EXPIRING
      - EXPIRED
      - NOT_YET_VALID
      - REVOKED
      readOnly: true
      type: string
    EnumCertificateKeyUsageType:
      description: "Specifies how the certificate is used. Options are `ENCRYPTION`,\
        \ `SIGNING`, `SSL/TLS`, `ISSUANCE`, `OUTBOUND_MTLS`.  `ISSUANCE` keys are\
        \ used as part of another key's trust chain, and are used to sign other keys.\
        \ Certificate Revocation Lists (CRL) are published against these keys. `SSL/TLS`\
        \ keys are used to protect internet protocol domains (such as, a [Custom Domain](https://apidocs.pingidentity.com/pingone/platform/v1/api/#custom-domains)\
        \ you've configured in PingOne). `OUTBOUND_MTLS` keys are used to enable mutual\
        \ TLS (mTLS) authentication with a subscription service."
      enum:
      - ENCRYPTION
      - SIGNING
      - SSL/TLS
      - ISSUANCE
      - OUTBOUND_MTLS
      type: string
    EnumCreateCertificateAcceptHeader:
      enum:
      - application/x-pkcs7-certificates
      type: string
    EnumCSRExportHeader:
      enum:
      - application/pkcs10
      - application/x-pem-file
      type: string
    EnumCSRResponseImportHeader:
      enum:
      - application/x-pem-file
      type: string
    EnumCustomAdminRoleApplicableTo:
      description: The scope types to which the role can be applied.
      enum:
      - ORGANIZATION
      - ENVIRONMENT
      - POPULATION
      - APPLICATION
      type: string
    EnumCustomAdminRoleType:
      description: A value that indicates whether the role is a built-in role or a
        custom role. Options are PLATFORM and CUSTOM.
      enum:
      - PLATFORM
      - CUSTOM
      readOnly: true
      type: string
    EnumCustomDomainPostHeader:
      enum:
      - application/vnd.pingidentity.certificate.import+json
      - application/vnd.pingidentity.domainName.verify+json
      type: string
    EnumCustomDomainStatus:
      description: "A string that specifies the status of the custom domain. Options\
        \ are ACTIVE, VERIFICATION_REQUIRED, and SSL_CERTIFICATE_REQUIRED."
      enum:
      - ACTIVE
      - VERIFICATION_REQUIRED
      - SSL_CERTIFICATE_REQUIRED
      type: string
    EnumEmailDomainStatus:
      description: The status of the email domain ownership.
      enum:
      - ACTIVE
      - VERIFICATION_REQUIRED
      type: string
    EnumEnvironmentStatus:
      description: "The status of an environment. (*Required for the Update Environment\
        \ Status request.) This can be null, `ACTIVE` and `DELETE_PENDING` (soft-delete).\
        \ The maximum number of Production environments that can be in the `DELETE_PENDING`\
        \ state is set to 100."
      enum:
      - ACTIVE
      - DELETE_PENDING
      type: string
    EnumEnvironmentType:
      description: A string that specifies the type of environment to use.
      enum:
      - PRODUCTION
      - SANDBOX
      type: string
    EnumFormItemAlignment:
      description: A string that specifies the alignment of the item.
      enum:
      - LEFT
      - CENTER
      - RIGHT
      type: string
    EnumFormItemSize:
      description: A string that specifies the size of the item.
      enum:
      - SMALL
      - MEDIUM
      - LARGE
      type: string
    EnumFormItemIconType:
      description: A string that specifies the icon type.
      enum:
      - NONE
      - AGREEMENT
      - ALERT
      - CALL
      - FAILURE
      - FINGERPRINT
      - LINK
      - MAIL
      - MOBILE_PHONE
      - PASSKEY
      - SUCCESS
      - QR_CODE
      - TEXT_MESSAGE
      - USB_KEY
      type: string
    EnumFormItemIconSize:
      description: A string that specifies the icon size.
      enum:
      - SMALL
      - MEDIUM
      - LARGE
      type: string
    EnumFormAgreementInputType:
      description: A string that specifies the type of field. Value should be set
        to READ_ONLY_TEXT.
      enum:
      - READ_ONLY_TEXT
      type: string
    EnumFormSingleCheckboxInputType:
      description: A string that specifies the type of field. Value should be set
        to BOOLEAN.
      enum:
      - BOOLEAN
      type: string
    EnumFormSingleCheckboxAppearance:
      description: A string that specifies the checkbox appearance. Options are CHECKBOX
        and SWITCH.
      enum:
      - CHECKBOX
      - SWITCH
      type: string
    EnumFormCategory:
      description: A string that specifies the type of form. The `CUSTOM` form type
        allows the form to be built with fields that do not map specifically to the
        PingOne directory attributes.
      enum:
      - CUSTOM
      type: string
    EnumFormAuthenticationDeviceType:
      description: A string that specifies the device type.
      enum:
      - EMAIL
      - FIDO2
      - MAGIC_LINK
      - MOBILE
      - SMS
      - TOTP
      - VOICE
      - WHATSAPP
      type: string
    EnumFormRegistrationDeviceType:
      description: A string that specifies the device type.
      enum:
      - EMAIL
      - FIDO2
      - MOBILE
      - SMS
      - TOTP
      - VOICE
      - WHATSAPP
      type: string
    EnumFormElementLabelMode:
      description: A string that specifies how the field is rendered.
      enum:
      - DEFAULT
      - FLOAT
      type: string
    EnumFormElementLayout:
      description: A string that specifies layout attributes for radio button and
        checkbox fields. This is a required property when the type is `RADIO` or `CHECKBOX`.
      enum:
      - HORIZONTAL
      - VERTICAL
      type: string
    EnumFormElementValidationType:
      description: A string that specifies the validation type. This is a required
        property when the field type is `TEXT`.
      enum:
      - NONE
      - CUSTOM
      type: string
    EnumFormFieldType:
      description: A string that specifies the type of the field.
      enum:
      - TEXT
      - PASSWORD
      - PASSWORD_VERIFY
      - PHONE_NUMBER
      - RADIO
      - CHECKBOX
      - DROPDOWN
      - COMBOBOX
      - DIVIDER
      - EMPTY_FIELD
      - SLATE_TEXTBLOB
      - SUBMIT_BUTTON
      - ERROR_DISPLAY
      - FLOW_LINK
      - FLOW_BUTTON
      - SOCIAL_LOGIN_BUTTON
      - RECAPTCHA_V2
      - QR_CODE
      - DEVICE_ENROLLMENT
      - DEVICE_REGISTRATION
      - DEVICE_AUTHENTICATION
      - POLLING
      - FIDO2
      - SINGLE_CHECKBOX
      - AGREEMENT
      type: string
    EnumFormFieldVisibility:
      description: A string that specifies the visibility behavior for the field.
      enum:
      - ALWAYS_VISIBLE
      - SHOW_BY_DEFAULT
      - HIDE_BY_DEFAULT
      type: string
    EnumFormPollingAppearance:
      description: A string that specifies the polling activity indicator appearance.
      enum:
      - NONE
      - DOTS
      - SPINNER
      type: string
    EnumFormRecaptchaV2Size:
      description: A string that specifies the size of the reCAPTCHA widget.
      enum:
      - NORMAL
      - COMPACT
      type: string
    EnumFormRecaptchaV2Theme:
      description: A string that specifies the theme of the reCAPTCHA widget.
      enum:
      - LIGHT
      - DARK
      type: string
    EnumFormFIDO2Trigger:
      description: A string that specifies the FIDO2 UI trigger type.
      enum:
      - BUTTON
      - AUTOMATIC
      type: string
    EnumFormFIDO2Action:
      description: A string that specifies the FIDO2 action.
      enum:
      - REGISTER
      - AUTHENTICATE
      type: string
    EnumFormSocialLoginIdpType:
      description: A string that specifies the external identity provider type.
      enum:
      - FACEBOOK
      - APPLE
      - GOOGLE
      - AMAZON
      - LINKEDIN
      - LINKEDIN_OIDC
      - MICROSOFT
      - TWITTER
      - YAHOO
      - PAYPAL
      - GITHUB
      - OPENID_CONNECT
      - SAML
      - LDAP
      type: string
    EnumFormStylesWidthUnit:
      enum:
      - PERCENT
      - PIXELS
      type: string
    EnumFormTranslationMethod:
      description: A string that specifies how to translate the text strings in the
        form.
      enum:
      - TRANSLATE
      - DEFAULT_VALUE
      - KEY
      type: string
    EnumFlowPolicyTriggerType:
      description: An enum string that specifies the trigger type associated with
        the flow policy trigger.
      enum:
      - AUTHENTICATION
      type: string
    EnumFormsIncludeParameter:
      enum:
      - components
      type: string
    EnumGatewayTypeLDAPSecurity:
      default: None
      description: "A string that specifies the connection security type. Options\
        \ are None, TLS, and StartTLS. The default value is None."
      enum:
      - None
      - TLS
      - StartTLS
      type: string
    EnumGatewayType:
      description: "A string that specifies the type of gateway resource. Options\
        \ are LDAP, PING_FEDERATE, API_GATEWAY_INTEGRATION, RADIUS and PING_INTELLIGENCE.\
        \ This is a required property."
      enum:
      - LDAP
      - PING_FEDERATE
      - PING_INTELLIGENCE
      - API_GATEWAY_INTEGRATION
      - RADIUS
      type: string
    EnumGatewayPasswordAuthority:
      description: "This can be either `PING_ONE` or `LDAP`. If set to `PING_ONE`,\
        \ PingOne authenticates with the external directory initially, then PingOne\
        \ authenticates all subsequent sign-ons."
      enum:
      - PING_ONE
      - LDAP
      type: string
    EnumGatewayVendor:
      description: "A string that specifies the LDAP vendor. Options are `PingDirectory`,\
        \ `Microsoft Active Directory`, `Oracle Directory Server Enterprise Edition`,\
        \ `Oracle Unified Directory`, `CA Directory`, `OpenDJ Directory Server`, `IBM\
        \ (Tivoli) Security Directory Server`, and `LDAPv3-compliant Directory Server`."
      enum:
      - PingDirectory
      - Microsoft Active Directory
      - Oracle Directory Server Enterprise Edition
      - Oracle Unified Directory
      - CA Directory
      - OpenDJ Directory Server
      - IBM (Tivoli) Security Directory Server
      - LDAPv3-compliant Directory Server
      type: string
    EnumGetKeyAcceptHeader:
      enum:
      - application/json
      - application/x-pkcs7-certificates
      - application/x-x509-ca-cert
      type: string
    EnumGroupSourceType:
      description: "External groups only. Set during user creation/update. Supported\
        \ values are `GATEWAY`, `IDP`"
      enum:
      - GATEWAY
      - IDP
      readOnly: true
      type: string
    EnumHealthStatus:
      description: An enumeration that specifies whether or not the gateway is in
        a healthy state.
      enum:
      - HEALTHY
      - DEGRADED
      - UNHEALTHY
      type: string
    EnumIdentityPropagationPlanStatus:
      description: Status of the propagation plan; defaults to `INACTIVE`
      enum:
      - INACTIVE
      type: string
    EnumIdentityProvider:
      default: PING_ONE
      description: A string that identifies the type of identity provider used to
        authenticate the user. The default value of `PING_ONE` is set when a value
        for identityProvider.id is not provided. The `PING_ONE` value is the default
        for all pre-existing users. There is currently no search filter support for
        this attribute.
      enum:
      - FACEBOOK
      - GOOGLE
      - LINKEDIN
      - LINKEDIN_OIDC
      - APPLE
      - TWITTER
      - AMAZON
      - YAHOO
      - MICROSOFT
      - PAYPAL
      - GITHUB
      - OPENID_CONNECT
      - SAML
      - PING_ONE
      type: string
    EnumIdentityProviderAttributeMappingType:
      description: The mapping type. Options are CORE (This attribute is required
        by the schema and cannot be removed. The name and update properties cannot
        be changed.) or CUSTOM (All user-created attributes are of this type.)
      enum:
      - CORE
      - CUSTOM
      type: string
    EnumIdentityProviderAttributeMappingUpdate:
      description: Indicates whether to update the user attribute in the directory
        with the non-empty mapped value from the IdP. Options are EMPTY_ONLY (only
        update the user attribute if it has an empty value); ALWAYS (always update
        the user attribute value).
      enum:
      - EMPTY_ONLY
      - ALWAYS
      type: string
    EnumIdentityProviderExt:
      description: A string that identifies the type of identity provider used to
        authenticate the user.
      enum:
      - FACEBOOK
      - GOOGLE
      - LINKEDIN
      - LINKEDIN_OIDC
      - APPLE
      - TWITTER
      - AMAZON
      - YAHOO
      - MICROSOFT
      - PAYPAL
      - GITHUB
      - OPENID_CONNECT
      - SAML
      type: string
    EnumIdentityProviderOIDCTokenAuthMethod:
      default: CLIENT_SECRET_BASIC
      description: "A string that specifies the OIDC identity provider's token endpoint\
        \ authentication method. Options are CLIENT_SECRET_BASIC (default), CLIENT_SECRET_POST,\
        \ and NONE. This is a required property."
      enum:
      - CLIENT_SECRET_BASIC
      - CLIENT_SECRET_POST
      - NONE
      type: string
    EnumIdentityProviderPKCEMethod:
      default: NONE
      description: The method for PKCE. Options are `NONE` or `S256`. The default
        is `NONE`. This value auto-populates from a discovery endpoint if the OpenID
        Provider includes `S256` in its `code_challenge_methods_supported` claim.
        The plain method is not currently supported.
      enum:
      - S256
      - NONE
      type: string
    EnumIdentityProviderSAMLSigningAlgorithm:
      description: "The signing key algorithm used by PingOne. Value will depend on\
        \ which key algorithm and signature algorithm you chose when creating your\
        \ signing key. Possible values are `SHA256withRSA`, `SHA384withRSA`, `SHA512withRSA`,\
        \ `SHA256withECDSA`, `SHA384withECDSA`, `SHA512eithEDCSA`."
      enum:
      - SHA256withRSA
      - SHA384withRSA
      - SHA512withRSA
      - SHA256withECDSA
      - SHA384withECDSA
      - SHA512eithEDCSA
      type: string
    EnumIdentityProviderSAMLSSOBinding:
      description: A string that specifies the binding for the authentication request.
        Options are HTTP_POST and HTTP_REDIRECT.
      enum:
      - HTTP_POST
      - HTTP_REDIRECT
      type: string
    EnumIdentityProviderSAMLSLOBinding:
      default: HTTP_POST
      description: The binding protocol to be used for the logout response. Options
        are `HTTP_REDIRECT` or `HTTP_POST`. The default is `HTTP_POST`; existing configurations
        with no data default to `HTTP_POST`. This is an optional property.
      enum:
      - HTTP_POST
      - HTTP_REDIRECT
      type: string
    EnumImageFormat:
      description: "A string that specifies the type of format used for the image.\
        \ Options are jpg, png, and gif."
      enum:
      - png
      - jpg
      - gif
      type: string
    EnumIntegrationPingProductName:
      description: The Ping product associated with the integration.
      enum:
      - PINGID
      - PINGONE_ENTERPRISE
      - PINGONE
      - PINGACCESS
      - PINGFEDERATE
      - PINGDIRECTORY
      - PINGDATAGOVERNANCE
      - PINGINTELLIGENCE_FOR_APIS
      - PINGONE_ADVANCED_SERVICES
      type: string
    EnumIntegrationTag:
      description: "Tag to apply to the integration metadata. Can include `SSO`, `AUTHENTICATION`,\
        \ `MFA`, `INTELLIGENCE`, `GOVERNANCE`, `IDAAS`, `ACCESS`, `DIRECTORY`, or\
        \ `PROVISIONING`."
      enum:
      - SSO
      - AUTHENTICATION
      - MFA
      - INTELLIGENCE
      - GOVERNANCE
      - IDAAS
      - ACCESS
      - DIRECTORY
      - PROVISIONING
      type: string
    EnumIntegrationVersionType:
      description: "The type of integration for this version. Currently, the only\
        \ valid values are PRODUCT_INTEGRATION_KIT and SAML."
      enum:
      - PRODUCT_INTEGRATION_KIT
      - SAML
      type: string
    EnumIntegrationVersionIntegrationKitIntegratedWithName:
      description: "Name of the compatible Ping product with which this version integrates.\
        \ Can include PINGID, PINGONE_ENTERPRISE, PINGONE, PINGACCESS, PINGFEDERATE,\
        \ PINGDIRECTORY, or PINGDATAGOVERNANCE"
      enum:
      - PINGID
      - PINGONE_ENTERPRISE
      - PINGONE
      - PINGACCESS
      - PINGFEDERATE
      - PINGDIRECTORY
      - PINGDATAGOVERNANCE
      type: string
    EnumIntegrationVersionSAMLProtocolVersion:
      description: "The SAML protocol version supported 2.0, 1.1, or 1.0."
      enum:
      - "2.0"
      - "1.1"
      - "1.0"
      type: string
    EnumIntegrationVersionSAMLSLOBinding:
      description: The SLO binding. Must be either HTTP_POST or HTTP_REDIRECT
      enum:
      - HTTP_POST
      - HTTP_REDIRECT
      type: string
    EnumKeyRotationPolicyAlgorithm:
      description: The algorithm this KRP applies to generated `KrpKeys`. `RSA` is
        currently the only supported value.
      enum:
      - RSA
      type: string
    EnumKeyRotationPolicySigAlgorithm:
      description: The signature algorithm this KRP will apply to generated `KrpKeys`.
        `SHA256withRSA` is currently the only supported value.
      enum:
      - SHA256withRSA
      type: string
    EnumKeyRotationPolicyUsageType:
      description: "How the KRP will be used, pertaining to what operations the KRP\
        \ supports. The only valid value for initial release is `SIGNING`."
      enum:
      - SIGNING
      type: string
    EnumLicenseStatus:
      description: "A string that specifies the status of the license. Options are\
        \ `ACTIVE`, `EXPIRED`, `FUTURE` and `TERMINATED`."
      enum:
      - ACTIVE
      - EXPIRED
      - FUTURE
      - TERMINATED
      type: string
    EnumMobileIntegrityDetectionPlatform:
      enum:
      - IOS
      - GOOGLE
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationMethod:
      description: Use the value `BASIC` if your authentication with the email provider
        uses a username and password. Use `BEARER` if your authentication is based
        on the use of a bearer token. Use `OAUTH2` if your authentication is based
        on OAuth 2.0. Use `CUSTOM_HEADER` if your authentication is based on a custom
        header.
      enum:
      - BASIC
      - BEARER
      - OAUTH2
      - CUSTOM_HEADER
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationGrantType:
      default: CLIENT_CREDENTIALS
      description: |
        The grant type used to request the access token from the authorization server. Possible values: `JWT_BEARER`, `CLIENT_CREDENTIALS`. The default value is `CLIENT_CREDENTIALS`.
      enum:
      - JWT_BEARER
      - CLIENT_CREDENTIALS
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationClientAuthenticationMethod:
      description: |
        The method used to send the OAuth 2.0 client credentials to the authorization server. Possible values: `BASIC_AUTH_HEADER`, `BODY`. This is a read-only property.
      enum:
      - BASIC_AUTH_HEADER
      - BODY
      readOnly: true
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsProtocol:
      enum:
      - HTTP
      - SMTP
      - SMTPS
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomProvider:
      description: Must be set to `CUSTOM_PROVIDER`.
      enum:
      - CUSTOM_PROVIDER
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomRequestsDeliveryMethod:
      description: Should be set to EMAIL.
      enum:
      - EMAIL
      type: string
    EnumNotificationsSettingsEmailDeliverySettingsCustomRequestsMethod:
      description: Use method to specify the type of API request the email provider
        requires. Valid values are `GET` and `POST`.
      enum:
      - GET
      - POST
      type: string
    EnumNotificationsPolicyProviderConfigurationConditionsDeliveryMethods:
      enum:
      - VOICE
      - SMS
      type: string
    EnumNotificationsPolicyCooldownConfigurationMethodPeriodTimeUnit:
      description: The time unit for the cooldown period. Options are `SECONDS` and
        `MINUTES`.
      enum:
      - SECONDS
      - MINUTES
      type: string
    EnumNotificationsPolicyCountryLimitDeliveryMethod:
      description: "The delivery method that the defined limitation should be applied\
        \ to.  Options are `SMS`, `Voice`."
      enum:
      - SMS
      - Voice
      type: string
    EnumNotificationsPolicyCountryLimitType:
      description: |
        Determines the kind of limitation being defined. The possible values are:
        `NONE`
        `ALLOWED` - allows SMS/Voice notifications only for the countries specified with `countryLimit.countries`
        `DENIED` - denies SMS/Voice notifications for the countries specified with `countryLimit.countries`
      enum:
      - NONE
      - ALLOWED
      - DENIED
      type: string
    EnumNotificationsPolicyQuotaDeliveryMethods:
      enum:
      - SMS
      - Voice
      - Email
      type: string
    EnumNotificationsPolicyQuotaItemType:
      description: Specifies whether the limit defined is per-user or per environment.
        Value must be either `USER` or `ENVIRONMENT`.
      enum:
      - USER
      - ENVIRONMENT
      type: string
    EnumNotificationsSettingsDeliveryMode:
      enum:
      - ALL
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomDeliveryMethod:
      description: |
        The notification's delivery method. Possible values:
        `SMS`
        `VOICE`
      enum:
      - SMS
      - VOICE
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomRequestMethod:
      description: The type of HTTP request method. Possible values are `GET` and
        `POST`.
      enum:
      - GET
      - POST
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomNumberFormat:
      default: FULL
      description: |
        The phone number format. Possible values:
        `FULL` (default)
        The phone number format with a leading `+` sign, in the E.164 standard format.
        For example: `+14155552671`
        `NUMBER_ONLY`
        The phone number format without a leading `+` sign, in the E.164 standard format.
        For example: `14155552671`
      enum:
      - FULL
      - NUMBER_ONLY
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomNumbersType:
      description: The type of phone number.
      enum:
      - SHORT_CODE
      - TOLL_FREE
      - PHONE_NUMBER
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomNumbersCapability:
      description: The type of phone delivery service capability.
      enum:
      - SMS
      - VOICE
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthMethod:
      description: |
        The custom provider account's authentication method. Possible values: `BASIC`, `BEARER`, `OAUTH2`, `CUSTOM_HEADER`
      enum:
      - BASIC
      - BEARER
      - OAUTH2
      - CUSTOM_HEADER
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthGrantType:
      default: CLIENT_CREDENTIALS
      description: |
        The grant type used to request the access token from the authorization server. Possible values: `JWT_BEARER`, `CLIENT_CREDENTIALS`. The default value is `CLIENT_CREDENTIALS`.
      enum:
      - JWT_BEARER
      - CLIENT_CREDENTIALS
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthClientAuthenticationMethod:
      description: |
        The method used to send the OAuth 2.0 client credentials to the authorization server. Possible values: `BASIC_AUTH_HEADER`, `BODY`. This is a read-only property.
      enum:
      - BASIC_AUTH_HEADER
      - BODY
      readOnly: true
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsTwilioSyniverseNumbersType:
      description: |
        The type of phone number. Possible values: `SHORT_CODE`, `TOLL_FREE`, `PHONE_NUMBER`
      enum:
      - SHORT_CODE
      - TOLL_FREE
      - PHONE_NUMBER
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsTwilioSyniverseNumbersCapability:
      description: |
        The type of phone delivery service capability. Possible values: `VOICE`, `SMS`
      enum:
      - VOICE
      - SMS
      type: string
    EnumNotificationsSettingsPhoneDeliverySettingsProvider:
      description: |
        The ID of the provider of phone delivery service. Possible values:
        `PINGONE_TWILIO`: Specifies that Ping Identity's Twilio account is the SMS/voice provider.
        `CUSTOM_TWILIO`: Specifies that your Twilio account is the SMS/voice provider.
        `CUSTOM_SYNIVERSE`: Specifies that your Syniverse account is the SMS/voice provider.
        `CUSTOM_PROVIDER`: Specifies a custom-defined SMS provider (excluding Twilio and Syniverse).
      enum:
      - CUSTOM_TWILIO
      - CUSTOM_SYNIVERSE
      - CUSTOM_PROVIDER
      type: string
    EnumOrganizationType:
      description: "A string that specifies the organization type. If the organization\
        \ has any paid licenses, the type property value is set to `PAID`. Otherwise,\
        \ the property value is set to `TRIAL`.  Internal organizations have a value\
        \ of `INTERNAL`."
      enum:
      - PAID
      - TRIAL
      - INTERNAL
      type: string
    EnumPasscodeRefreshTimeUnit:
      default: SECONDS
      description: The type of time unit for `mobile.passcodeRefreshDuration.duration`.  Must
        be SECONDS.
      enum:
      - SECONDS
      type: string
    EnumProductType:
      description: "A string that specifies the Ping Identity product type. Options\
        \ for PingOne platform products are PING_ONE_DAVINCI, PING_ONE_MFA, PING_ONE_RISK,\
        \ PING_ONE_VERIFY, PING_ONE_CREDENTIALS, PING_ONE_AUTHORIZE and PING_ONE_BASE.\
        \ The PING_ONE_BASE product represents the default set of services that an\
        \ environment can use on the PingOne platform. Options for other Ping Identity\
        \ products are PING_FEDERATE, PING_ACCESS, PING_DIRECTORY, PING_AUTHORIZE,\
        \ PING_ID, PING_INTELLIGENCE, PING_CENTRAL, PING_ONE_PAM, and IDENTITY_CLOUD"
      enum:
      - PING_ONE_MFA
      - PING_ONE_DAVINCI
      - PING_ONE_ORCHESTRATE
      - PING_ONE_RISK
      - PING_ONE_FRAUD
      - PING_ONE_PROVISIONING
      - PING_DATA_SYNC
      - PING_DATA_GOVERNANCE
      - PING_ONE_FOR_ENTERPRISE
      - PING_ID_SDK
      - PING_ONE_FOR_SAAS
      - PING_ONE_VERIFY
      - PING_ONE_CREDENTIALS
      - PING_ONE_AUTHORIZE
      - PING_ONE_BASE
      - PING_FEDERATE
      - PING_ACCESS
      - PING_DIRECTORY
      - PING_AUTHORIZE
      - PING_ID
      - PING_ONE_ID
      - PING_INTELLIGENCE
      - PING_CENTRAL
      - PING_ONE_PAM
      - IDENTITY_CLOUD
      type: string
    EnumPropagationStoreConnectionStatusContentType:
      enum:
      - application/vnd.pingidentity.connection.check+json
      type: string
    EnumPropagationStoreStatus:
      description: The status of the identity store. The default value is INACTIVE.
      enum:
      - INACTIVE
      type: string
    EnumPropagationStoreSyncState:
      description: The current state of synchronization with a propagation store or
        stores. Options are either SYNCING or FAILED.
      enum:
      - SYNCING
      - FAILED
      readOnly: true
      type: string
    EnumPropagationStoreType:
      description: "The type of the identity store and determines the required and\
        \ acceptable configuration properties. It also determines the acceptable target\
        \ attribute mappings. Options are Aquera, AzureActiveDirectorySAML2, directory,\
        \ LdapGateway, PingOne, Salesforce, SalesforceContacts, scim, Slack, Workday,\
        \ or Zoom."
      enum:
      - Aquera
      - AzureActiveDirectorySAML2
      - directory
      - LdapGateway
      - PingOne
      - Salesforce
      - SalesforceContacts
      - scim
      - Slack
      - Workday
      - Zoom
      type: string
    EnumPropagationStoreTypeRemoveActionDisable:
      description: The action to take when deprovisioning (removing) a user. Must
        be set to Disable.
      enum:
      - Disable
      type: string
    EnumPropagationStoreTypeRemoveActionDisableDelete:
      description: The action to take when deprovisioning (removing) a user. Options
        are either `Disable` or `Delete`.
      enum:
      - Disable
      - Delete
      type: string
    EnumPropagationStoreTypeAqueraAuthenticationMethod:
      description: "The account authentication method. For example, `OAuth Bearer\
        \ Token` or `Basic Auth`."
      enum:
      - OAuth Bearer Token
      - Basic Auth
      type: string
    EnumPropagationStoreTypeAqueraGroupSourceName:
      description: The source to use for the group name. Options are either `Common
        Name` or `Distinguished Name`.
      enum:
      - Common Name
      - Distinguished Name
      type: string
    EnumPropagationStoreTypeLDAPGatewayLDAPType:
      description: Type of LDAP gateway; can be `PingDirectory` or `Microsoft Active
        Directory`.
      enum:
      - PingDirectory
      - Microsoft Active Directory
      type: string
    EnumPropagationStoreTypePingOneDefaultAuthMethod:
      description: "The default authentication method. Options are `Email 1`, `SMS\
        \ 1`, or `Voice 1`."
      enum:
      - Email 1
      - SMS 1
      - Voice 1
      type: string
    EnumPropagationStoreTypePingOneRegion:
      description: A supported region.
      enum:
      - AP
      - AU
      - CA
      - EU
      - NA
      - SG
      type: string
    EnumPropagationStoreTypeSalesforceContactsRecordType:
      description: The type of Salesforce record. Options are either Lead or Contact.
      enum:
      - Lead
      - Contact
      type: string
    EnumPropagationStoreTypeSCIMAuthenticationMethod:
      description: "The account authentication method. Can be `OAuth 2 Client Credentials`,\
        \ `OAuth 2 Bearer Token`, or `Basic Authentication`."
      enum:
      - OAuth 2 Client Credentials
      - OAuth 2 Bearer Token
      - Basic Authentication
      type: string
    EnumPropagationStoreTypeSCIMGroupNameSource:
      description: The source to use for the group name. Options are either `Common
        Name` or `Distinguished Name`.
      enum:
      - Common Name
      - Distinguished Name
      type: string
    EnumPropagationStoreTypeSCIMUniqueUserIdentifier:
      description: Specifies the unique user identifier to use. Options are either
        `userName` or `workEmail`.
      enum:
      - userName
      - workEmail
      type: string
    EnumPropagationStoreTypeSlackUniqueUserIdentifier:
      description: "The unique user identifier, must be either `primaryEmail` or `userName`."
      enum:
      - primaryEmail
      - userName
      type: string
    EnumPropagationStoreTypeZoomAuthenticationMethod:
      default: JWT Bearer Token
      description: Account authentication method. Case sensitive. Can be JWT Bearer
        Token or OAuth Bearer Token. Defaults to JWT Bearer Token.
      enum:
      - JWT Bearer Token
      - OAuth Bearer Token
      type: string
    EnumRateLimitConfigurationType:
      description: "The type of rate limit configuration. Currently, the only type\
        \ supported is \"WHITELIST\", indicating that the IP address in value is to\
        \ be excluded from rate limiting."
      enum:
      - WHITELIST
      type: string
    EnumRegionCode:
      description: A string that specifies the environment region code. The value
        is set when the environment is created and cannot be updated.
      enum:
      - AP
      - AU
      - CA
      - EU
      - NA
      - SG
      type: string
    EnumRegionCodeLicense:
      enum:
      - AP
      - AU
      - CA
      - EU
      - NORTH_AMERICA
      - SG
      type: string
    EnumResourceAttributeType:
      description: |
        A string that specifies the type of resource attribute. Options are:
        CORE: The claim is required and cannot not be removed.
        CUSTOM: The claim is not a CORE attribute. All created attributes are of this type.
        PREDEFINED: A designation for predefined OIDC resource attributes such as given_name. These attributes cannot be removed; however, they can be modified.
      enum:
      - CORE
      - CUSTOM
      - PREDEFINED
      type: string
    EnumResourceApplicationResourceType:
      description: The application resource's parent type. Options are `PING_ONE_RESOURCE`.
      enum:
      - PING_ONE_RESOURCE
      type: string
    EnumResourceIntrospectEndpointAuthMethod:
      description: "The client authentication methods supported by the token endpoint.\
        \ Options are `NONE`, `CLIENT_SECRET_BASIC`, and `CLIENT_SECRET_POST`."
      enum:
      - NONE
      - CLIENT_SECRET_BASIC
      - CLIENT_SECRET_POST
      type: string
    EnumResourceType:
      description: "A string that specifies the type of resource. Options are `OPENID_CONNECT`,\
        \ `PINGONE_API`, and `CUSTOM`. Only the `CUSTOM` resource type can be created.\
        \ `OPENID_CONNECT` specifies the built-in platform resource for OpenID Connect.\
        \ `PINGONE_API` specifies the built-in platform resource for PingOne."
      enum:
      - OPENID_CONNECT
      - PINGONE_API
      - CUSTOM
      type: string
    EnumRoleName:
      description: The name of the role
      enum:
      - Authorize Gateway Policy Evaluator
      - Advanced Identity Cloud Super Admin
      - Advanced Identity Cloud Tenant Admin
      - Application Owner
      - Client Application Developer
      - Configuration Read Only
      - Custom Roles Admin
      - DaVinci Admin Read Only
      - DaVinci Admin
      - Environment Admin
      - Help Desk Admin
      - Identity Data Admin
      - Identity Data Read Only
      - Organization Admin
      - PingFederate Administrator
      - PingFederate Auditor
      - PingFederate Crypto Administrator
      - PingFederate Expression Administrator
      - PingFederate User Administrator
      type: string
    EnumRoleAssignmentScopeType:
      description: A string that specifies the type of resource defining the scope
        of the Role assignment.
      enum:
      - ORGANIZATION
      - ENVIRONMENT
      - POPULATION
      - APPLICATION
      type: string
    EnumSchemaAttributeSchemaType:
      description: "A string that specifies the schema type of the attribute. It may\
        \ be one of CORE, STANDARD or CUSTOM. Core and standard attributes are present\
        \ out-of-the-box. Core attributes may not be updated or deleted. Standard\
        \ attributes may not be deleted, but their mutable properties may be updated.\
        \ Custom attributes may be deleted, and their mutable properties may be updated.\
        \ New attributes are created with a schema type of CUSTOM."
      enum:
      - CORE
      - STANDARD
      - CUSTOM
      type: string
    EnumSchemaAttributeType:
      default: STRING
      description: "A string that specifies the the type of the attribute. It may\
        \ be one of STRING, JSON, BOOLEAN, or COMPLEX. If the type is not provided\
        \ during creation, then it defaults to STRING. Complex and boolean attributes\
        \ may not be created, but standard attributes of those types may be updated.\
        \ JSON attributes are limited by size (total size must not exceed 16KB)."
      enum:
      - STRING
      - JSON
      - BOOLEAN
      - COMPLEX
      type: string
    EnumSignOnPolicyExtraVerification:
      default: disabled
      description: |
        Specifies the level of further verification when deviceAuthorization is enabled. The PingOne platform performs an extra verification check by sending a silent push notification to the customer native application, and receives a confirmation in return.  `extraVerification` can be one of the following levels:
        `disabled` (default): The PingOne platform does not perform the extra verification check.
        `permissive`: The PingOne platform performs the extra verification check. Upon timeout or failure to get a response from the native app, the MFA step is treated as successfully completed.
        `restrictive`: The PingOne platform performs the extra verification check.The PingOne platform performs the extra verification check. Upon timeout or failure to get a response from the native app, the MFA step is treated as failed.
      enum:
      - disabled
      - permissive
      - restrictive
      type: string
    EnumSignOnPolicyNoDeviceMode:
      description: "A string that specifies the device mode for the MFA flow. Options\
        \ are `BYPASS` to allow MFA without a specified device, or `BLOCK` to block\
        \ the MFA flow if no device is specified. To use this configuration option,\
        \ the authorize request must include a signed `login_hint_token` property.\
        \ For more information, see Authorize (Browserless and MFA Only Flows)"
      enum:
      - BYPASS
      - BLOCK
      type: string
    EnumSignOnPolicyType:
      description: "A string that specifies the type of action. Options are `LOGIN`,\
        \ `MULTI_FACTOR_AUTHENTICATION`, `IDENTIFIER_FIRST`, `IDENTITY_PROVIDER` `AGREEMENT`\
        \ and `PROGRESSIVE_PROFILING`.  Workforce environments also include `PINGID_WINLOGIN_PASSWORDLESS_AUTHENTICATION`\
        \ and `PINGID_AUTHENTICATION`"
      enum:
      - LOGIN
      - MULTI_FACTOR_AUTHENTICATION
      - IDENTIFIER_FIRST
      - IDENTITY_PROVIDER
      - PROGRESSIVE_PROFILING
      - AGREEMENT
      - PINGID_WINLOGIN_PASSWORDLESS_AUTHENTICATION
      - PINGID_AUTHENTICATION
      type: string
    EnumSignOnPolicyActionLoginNewUserProvisioningGatewayType:
      description: "A string identifying the type of gateway. Currently, only `LDAP`\
        \ is supported."
      enum:
      - LDAP
      type: string
    EnumSolutionType:
      description: |
        The solution type selected when creating the environment. Ignored on PUT operations. The following values are supported:
        `CIAM_TRIAL`. The Customer trial experience. Indicates the Customer solution type, and the Solution Designer was selected.
        `WF_TRIAL`. The Workforce trial experience. Indicates the Workforce solution type, and the Solution Designer was selected.
        `CUSTOMER`. Indicates the Customer solution type was selected. This solution type uses PingOne MFA, rather than PingID.
        `WORKFORCE`. Indicates the Workforce solution type was selected. This solution type uses PingID, rather than PingOne MFA.
      enum:
      - WORKFORCE
      - CUSTOMER
      - CIAM_TRIAL
      - WF_TRIAL
      type: string
    EnumSubscriptionFilterIncludedTags:
      description: "A tags that events must have to be monitored by a subscription.\
        \ Currently, the available tags are `adminIdentityEvent`. Identifies the event\
        \ as the action of an administrator on other administrators."
      enum:
      - adminIdentityEvent
      type: string
    EnumSubscriptionFormat:
      description: "A string that specifies one of the supported subscription formats.\
        \ Options are ACTIVITY, SPLUNK, and NEWRELIC. This is a required property."
      enum:
      - ACTIVITY
      - SPLUNK
      - NEWRELIC
      type: string
    EnumSubscriptionPayloadOptionsMaximumPayloadLimitType:
      description: The type of payload to use for limiting subscriptions.
      enum:
      - EVENTS_PER_PAYLOAD
      - KB_PER_PAYLOAD
      type: string
    EnumSubscriptionPayloadFormatHttpsFormat:
      description: The payload format for HTTPS connections.
      enum:
      - JSON_ARRAY
      - ND_JSON
      type: string
    EnumSubscriptionPayloadFormatTcpFormat:
      description: The payload format for TCP connections.
      enum:
      - JSON_DOC
      - RFC_LOGLINE
      type: string
    EnumSubscriptionProtocol:
      description: A string that specifies the protocol to use for the subscription.
      enum:
      - HTTPS
      - TCP_IP
      type: string
    EnumTemplateContentDeliveryMethod:
      description: "The content's delivery method. Possible values are `Email`, `SMS`,\
        \ `Voice` or `Push`. Cannot be changed after it is initially set in `POST\
        \ /environments/{{envID}}/templates/{{templateName}}/contents`."
      enum:
      - Email
      - SMS
      - Voice
      - Push
      type: string
    EnumTemplateContentPushCategory:
      default: BANNER_BUTTONS
      description: |
        For Push content, you can specify what type of banner should be displayed to the user. The available options are:
        * `BANNER_BUTTONS` - the banner contains both Approve and Deny buttons
        * `WITHOUT_BANNER_BUTTONS` - when the user clicks the banner, they are taken to an application that contains the necessary approval controls.
        * `APPROVE_AND_OPEN_APP` - when the Approve button is clicked, authentication is completed and the user is taken to the relevant application.

        If this parameter is not provided, the default is `BANNER_BUTTONS`. Note that to use the non-default push banners, you must implement them in your application code, using the PingOne SDK. For details, see the [README for iOS](https://github.com/pingidentity/pingone-mobile-sdk-ios/#171-push-notifications-categories) and the [README for Android](https://github.com/pingidentity/pingone-mobile-sdk-android).
      enum:
      - BANNER_BUTTONS
      - WITHOUT_BANNER_BUTTONS
      - APPROVE_AND_OPEN_APP
      type: string
    EnumTemplateName:
      description: The name of the template
      enum:
      - account_created
      - account_updated
      - credential_issued
      - credential_revoked
      - credential_updated
      - credential_verification
      - device_pairing
      - digital_wallet_pairing
      - email_verification_admin
      - email_verification_user
      - email_phone_verification
      - general
      - id_verification
      - new_device_paired
      - password_change_admin
      - password_change_user
      - recovery_code_template
      - password_recovery_new
      - strong_authentication
      - transaction
      - verification_code_template
      - verification_code_new
      type: string
    EnumTrustedEmailStatus:
      description: A string that specifies the status of the trusted email address.
      enum:
      - ACTIVE
      - VERIFICATION_REQUIRED
      readOnly: true
      type: string
    EnumEnabledStatus:
      description: "A string that specifies whether device integrity detection takes\
        \ place on mobile devices, for the application's enrollment and authentication\
        \ events ENABLED, DISABLED"
      enum:
      - ENABLED
      - DISABLED
      type: string
    EnumDurationUnitMinsHours:
      enum:
      - MINUTES
      - HOURS
      type: string
    EnumUpdateStatus:
      description: "An enumeration that specifies one of the following values: AT_LATEST:\
        \ The gateway instance's version is at or after the supported version marked\
        \ latest. UPGRADE_AVAILABLE: The gateway instance's version is at the supported\
        \ version that is marked recommended but there is a later supported version\
        \ marked recommended. UPGRADE_RECOMMENDED: The gateway instance's version\
        \ is at a known version but the version is not marked as recommended or latest.\
        \ The version has greater than 30 days support. UPGRADE_REQUIRED: The gateway\
        \ instance's version is at a known version but the version is not marked as\
        \ recommended or latest. The version has support ending within the next month.\
        \ NOT_SUPPORTED: The gateway instance's version is not known or supported."
      enum:
      - AT_LATEST
      - UPGRADE_AVAILABLE
      - UPGRADE_RECOMMENDED
      - UPGRADE_REQUIRED
      - NOT_SUPPORTED
      type: string
    EnumUserLifecycleStatus:
      description: "A string that specifies information about the account lifecycle.\
        \ Options for status are `ACCOUNT_OK` and `VERIFICATION_REQUIRED`. This property\
        \ value is only allowed to be set when importing a user to set the initial\
        \ account status. If the initial status is set to `VERIFICATION_REQUIRED`\
        \ and an email address is provided, a verification email is sent."
      enum:
      - ACCOUNT_OK
      - VERIFICATION_REQUIRED
      type: string
    EnumUserAccountContentTypeHeader:
      enum:
      - application/vnd.pingidentity.account.unlock+json
      - application/vnd.pingidentity.account.lock+json
      type: string
    EnumGroupMembershipType:
      description: A string that defines the relationship of group membership
      enum:
      - DIRECT
      - INDIRECT
      type: string
    EnumUserGroupAssignmentExpandParameter:
      description: "When this parameter is appended to the request, the results are\
        \ expanded to include additional information about each group."
      enum:
      - group
      type: string
    EnumUserRequestInclude:
      enum:
      - memberOfGroupIDs
      - memberOfGroupNames
      type: string
    EnumUserStatus:
      description: A string that specifies the account locked state.
      enum:
      - LOCKED
      - OK
      type: string
    EnumUserVerifyStatus:
      description: "Indicates whether ID verification can be done for the user. This\
        \ value can be NOT_INITIATED (the initial value), ENABLED, or DISABLED. If\
        \ the user verification status is DISABLED, a new verification status cannot\
        \ be created for that user until the status is changed to ENABLED."
      enum:
      - NOT_INITIATED
      - ENABLED
      - DISABLED
      type: string
    EnumApplicationWSFEDSubjectNameIdentifierFormat:
      description: The format to use for the SubjectNameIdentifier element.
      enum:
      - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
      - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
      type: string
    AdministratorSecurity:
      example:
        mfaStatus: null
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        hasFido2Capabilities: true
        _links:
          key:
            href: https://openapi-generator.tech
        authenticationMethod: null
        provider:
          id: id
        allowedMethods:
          TOTP: TOTP
          FIDO2: FIDO2
          EMAIL: EMAIL
        recovery: true
        isPingIDInBOM: true
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        allowedMethods:
          $ref: '#/components/schemas/AdministratorSecurity_allowedMethods'
        authenticationMethod:
          $ref: '#/components/schemas/EnumAdministratorSecurityAuthenticationMethod'
        createdAt:
          description: The timestamp the resource was created.
          format: date-time
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        hasFido2Capabilities:
          description: Indicates whether the environment supports FIDO2 passkeys for
            MFA.
          readOnly: true
          type: boolean
        isPingIDInBOM:
          description: Indicates whether the environment supports PingID for MFA.
          readOnly: true
          type: boolean
        mfaStatus:
          $ref: '#/components/schemas/EnumAdministratorSecurityMfaStatus'
        provider:
          $ref: '#/components/schemas/AdministratorSecurity_provider'
        recovery:
          description: Indicates whether to allow account recovery within the admin
            policy.
          type: boolean
        updatedAt:
          description: The timestamp the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - authenticationMethod
      - mfaStatus
      - recovery
      type: object
    Agreement:
      example:
        environment:
          id: id
        totalExpiredConsents: 0
        _links:
          key:
            href: https://openapi-generator.tech
        consentsAggregatedAt: 2000-01-23T04:56:07.000+00:00
        name: name
        description: description
        totalConsents: 1
        id: id
        enabled: true
        reconsentPeriodDays: 6.0274563
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        consentsAggregatedAt:
          description: The time the consent count metric was last updated. This value
            is typically updated once every 24 hours.
          format: date-time
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of the agreement.
          type: string
        enabled:
          description: "A boolean that specifies the current enabled state of the\
            \ agreement. This is a required property. The agreement must support the\
            \ default language to be enabled. It cannot be disabled if it is referenced\
            \ by a sign-on action. When an agreement is disabled, it is not used anywhere\
            \ it is configured across PingOne."
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        totalExpiredConsents:
          description: "An integer that identifies the number of users who have consented\
            \ to the agreement, but their consent has expired. This value is last\
            \ calculated at the consentCountsUpdatedAt time."
          readOnly: true
          type: integer
        id:
          description: A string that specifies the agreement ID.
          readOnly: true
          type: string
        name:
          description: A string that specifies the name of the agreement resource.
            This is a required property.
          type: string
        reconsentPeriodDays:
          description: A number that represents the number of days until a consent
            to this agreement expires.
          format: float
          type: number
        totalConsents:
          description: An integer that identifies the total number of users who have
            consented to the agreement. This value is last calculated at the consentCountsUpdatedAt
            time.
          readOnly: true
          type: integer
      required:
      - enabled
      - name
      type: object
    AgreementLanguage:
      example:
        currentRevision:
          id: id
        agreement:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        displayName: displayName
        userExperience:
          acceptCheckboxText: acceptCheckboxText
          declineButtonText: declineButtonText
          continueButtonText: continueButtonText
        id: id
        locale: locale
        enabled: true
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        agreement:
          $ref: '#/components/schemas/AgreementLanguage_agreement'
        currentRevision:
          $ref: '#/components/schemas/AgreementLanguage_currentRevision'
        displayName:
          description: A string that is used as the title of the agreement for the
            language presented to the user. This is a required property.
          type: string
        enabled:
          description: A boolean that maps directly with a language being enabled
            or displayed for the environment within the platform. This is a required
            property.
          type: boolean
        id:
          description: A string that specifies the language ID.
          readOnly: true
          type: string
        locale:
          description: "A string that specifies the tag for identifying the language\
            \ resource associated with this agreement consent (for example, en-US).\
            \ This is a required property. For more information about language tags,\
            \ see Tags for Identifying Languages."
          type: string
        userExperience:
          $ref: '#/components/schemas/AgreementLanguage_userExperience'
      required:
      - displayName
      - enabled
      - locale
      type: object
    AgreementLanguageRevision:
      example:
        agreement:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        requireReconsent: true
        notValidAfter: 2000-01-23T04:56:07.000+00:00
        effectiveAt: 2000-01-23T04:56:07.000+00:00
        language:
          id: id
        id: id
        text: text
        contentType: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        agreement:
          $ref: '#/components/schemas/AgreementLanguage_agreement'
        contentType:
          $ref: '#/components/schemas/EnumAgreementRevisionContentType'
        effectiveAt:
          description: "A date that specifies the start date that the revision is\
            \ presented to users. This property value can be modified only if the\
            \ current value is a date that has not already passed. The effective date\
            \ must be unique for each language agreement, and the property value can\
            \ be the present date or a future date only."
          format: date-time
          type: string
        id:
          description: A read-only string that specifies the revision ID.
          readOnly: true
          type: string
        language:
          $ref: '#/components/schemas/AgreementLanguageRevision_language'
        notValidAfter:
          description: "A date that specifies whether the revision is still valid\
            \ in the context of all revisions for a language. This property is calculated\
            \ dynamically at read time, taking into consideration the agreement language,\
            \ the language enabled property, and the agreement enabled property. When\
            \ a new revision is added, the notValidAfter property values for all other\
            \ previous revisions might be impacted. For example, if a new revision\
            \ becomes effective and it forces reconsent, then all older revisions\
            \ are no longer valid."
          format: date-time
          readOnly: true
          type: string
        requireReconsent:
          description: A boolean that specifies whether the user is required to provide
            consent to the language revision after it becomes effective.
          type: boolean
        text:
          description: "An immutable string that specifies text or HTML for the revision.\
            \ This attribute is supported in POST requests only. For more information,\
            \ see contentType."
          type: string
      required:
      - contentType
      - effectiveAt
      - requireReconsent
      - text
      type: object
    AgreementRevisionText:
      properties:
        resourcePath:
          type: string
        data:
          type: string
        dataType:
          type: string
      type: object
    AlertChannel:
      example:
        environment:
          id: id
        addresses:
        - addresses
        - addresses
        includeAlertTypes:
        - null
        - null
        _links:
          key:
            href: https://openapi-generator.tech
        alertName: alertName
        includeSeverities:
        - null
        - null
        channelType: null
        excludeAlertTypes:
        - null
        - null
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: Unique ID of the alert channel.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        alertName:
          description: The name to assign to the alert channel.
          type: string
        channelType:
          $ref: '#/components/schemas/EnumAlertChannelType'
        addresses:
          description: The email addresses to send the alert to.
          items:
            format: email
            type: string
          type: array
        includeSeverities:
          description: "Filters alerts by severity. If empty, all severities are included.\
            \ Possible values are `INFO`, `WARNING`, and `ERROR``."
          items:
            $ref: '#/components/schemas/EnumAlertChannelSeverity'
          type: array
        includeAlertTypes:
          description: "Filters alerts by alert type. If empty, all alert types are\
            \ included. Possible values are CERTIFICATE_EXPIRED, CERTIFICATE_EXPIRING,\
            \ KEY_PAIR_EXPIRED, GATEWAY_VERSION_DEPRECATED, KEY_PAIR_EXPIRING, and\
            \ GATEWAY_VERSION_DEPRECATING."
          items:
            $ref: '#/components/schemas/EnumAlertChannelAlertType'
          type: array
        excludeAlertTypes:
          description: "Administrators will not be emailed alerts of these types.\
            \ If empty, no alert types are excluded. Possible values are CERTIFICATE_EXPIRED,\
            \ CERTIFICATE_EXPIRING, KEY_PAIR_EXPIRED, GATEWAY_VERSION_DEPRECATED,\
            \ KEY_PAIR_EXPIRING, and GATEWAY_VERSION_DEPRECATING."
          items:
            $ref: '#/components/schemas/EnumAlertChannelAlertType'
          type: array
      required:
      - addresses
      - channelType
      type: object
    Application:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        accessControl:
          $ref: '#/components/schemas/Application_accessControl'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of the application.
          type: string
        enabled:
          description: A string that specifies the current enabled state of the application.
            Options are ENABLED or DISABLED.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        hiddenFromAppPortal:
          description: A boolean to specify whether the application is hidden in the
            application portal despite the configured group access policy.
          type: boolean
        icon:
          $ref: '#/components/schemas/Application_icon'
        id:
          description: A string that specifies the application ID.
          readOnly: true
          type: string
        loginPageUrl:
          description: "A string that specifies the custom login page URL for the\
            \ application. If you set the loginPageUrl property for applications in\
            \ an environment that sets a custom domain, the URL should include the\
            \ top-level domain and at least one additional domain level. Warning To\
            \ avoid issues with third-party cookies in some browsers, a custom domain\
            \ must be used, giving your PingOne environment the same parent domain\
            \ as your authentication application. For more information about custom\
            \ domains, see Custom domains."
          type: string
        name:
          description: A string that specifies the name of the application. This is
            a required property.
          type: string
        protocol:
          $ref: '#/components/schemas/EnumApplicationProtocol'
        type:
          $ref: '#/components/schemas/EnumApplicationType'
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - enabled
      - name
      - protocol
      - type
      type: object
    ApplicationCorsSettings:
      description: "Allows customization of how the Authorization and Authentication\
        \ APIs interact with CORS requests that reference the application.  If omitted,\
        \ the application allows CORS requests from any origin except for operations\
        \ that expose sensitive information (e.g. `/as/authorize` and `/as/token`).\
        \  This is legacy behavior, and it is recommended that applications migrate\
        \ to include specific `corsSettings`."
      properties:
        behavior:
          $ref: '#/components/schemas/EnumApplicationCorsSettingsBehavior'
        origins:
          description: "Must be non-empty when `corsSettings.behavior` is `ALLOW_SPECIFIC_ORIGINS`\
            \ and must be omitted or empty when `corsSettings.behavior` is `ALLOW_NO_ORIGINS`.\
            \  Limited to 20 values.  Values are the origins from which CORS requests\
            \ to the Authorization and Authentication APIs are allowed.  Each value\
            \ is an `http` or `https` URL without a path.  The host may be a domain\
            \ name (including `localhost`), or an IPv4 address.  Subdomains may use\
            \ the wildcard (*) to match any string."
          items:
            type: string
          maxItems: 20
          type: array
      required:
      - behavior
      type: object
    ApplicationExternalLink:
      allOf:
      - $ref: '#/components/schemas/Application'
      - properties:
          homePageUrl:
            description: A string that specifies the custom home page URL for the
              application.
            type: string
          externalId:
            description: "For applications whose type is `PORTAL_LINK_APP`, you can\
              \ use this field to specify an external ID that should be used for the\
              \ application in contexts such as targeted risk policies. Note that\
              \ `PORTAL_LINK_APP` applications that do not have an external ID specified\
              \ are not displayed in the list of applications when defining a targeted\
              \ risk policy in the UI."
            type: string
        required:
        - homePageUrl
        type: object
    ApplicationMetadata:
      example:
        metadata:
          key: ""
        environmentId: environmentId
        _links:
          key:
            href: https://openapi-generator.tech
        applicationId: applicationId
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        applicationId:
          description: A string that specifies the ID of the application.
          readOnly: true
          type: string
        environmentId:
          description: A string that specifies the ID of the environment.
          readOnly: true
          type: string
        metadata:
          additionalProperties: true
          description: "User-defined custom metadata for the application. The metadata\
            \ must be a JSON object and can include any custom properties. If metadata\
            \ is not included in the request body, the existing application metadata\
            \ will be removed from the application resource."
          type: object
      type: object
    ApplicationSAML:
      allOf:
      - $ref: '#/components/schemas/Application'
      - properties:
          homePageUrl:
            description: A string that specifies the custom home page URL for the
              application.
            type: string
          acsUrls:
            description: A string that specifies the Assertion Consumer Service URLs.
              The first URL in the list is used as default (there must be at least
              one URL). This is a required property.
            items:
              type: string
            type: array
          assertionDuration:
            description: An integer that specifies the assertion validity duration
              in seconds. This is a required property.
            type: integer
          assertionSigned:
            default: true
            description: A boolean that specifies whether the SAML assertion itself
              should be signed. The default value is `true`.
            type: boolean
          corsSettings:
            $ref: '#/components/schemas/ApplicationCorsSettings'
          defaultTargetUrl:
            description: "This is used as the RelayState parameter by the IdP to deep\
              \ link into the application after authentication. This value can be\
              \ overridden by the applicationUrl query parameter for GET Identity\
              \ Provider Initiated SSO. Although both of these parameters are generally\
              \ URLs, because they are used as deep links, this is not enforced. If\
              \ neither defaultTargetUrl nor applicationUrl is specified during a\
              \ SAML authentication flow, no RelayState value is supplied to the application.\
              \ The defaultTargetUrl (or the applicationUrl) value is passed to the\
              \ SAML application's ACS URL as a separate RelayState key value (not\
              \ within the SAMLResponse key value)."
            type: string
          enableRequestedAuthnContext:
            description: Indicates whether `requestedAuthnContext` is taken into account
              in policy decision-making during authentication.
            type: boolean
          enableAlwaysAcceptAcsUrlInSignedAuthnRequest:
            description: "If enabled (true), this indicates that when a service provider\
              \ (SP) specifies an ACS URL in its AuthnRequest, and signs the AuthnRequest,\
              \ then assuming the identity provider (IdP) can validate the signature,\
              \ the IdP can accept the ACS URL as valid. This is so, regardless of\
              \ whether the ACS URL is specified in acsUrls as an allowable ACS URL\
              \ (refer to [Applications SAML metadata settings data model](https://developer.pingidentity.com/pingone-api/platform/applications/applications-1.html#applications-saml-settings-metadata-model)).\
              \ Enabling this setting is useful when an SP generates ACS URLs dynamically."
            type: boolean
          idpSigning:
            $ref: '#/components/schemas/ApplicationSAML_allOf_idpSigning'
          nameIdFormat:
            description: A string that specifies the format of the Subject NameID
              attibute in the SAML assertion
            type: string
          responseSigned:
            default: false
            description: A boolean that specifies whether the SAML assertion response
              itself should be signed. The default value is `false`.
            type: boolean
          sessionNotOnOrAfterDuration:
            description: Update this value if the SAML application requires a different
              `SessionNotOnOrAfter` attribute value within the `AuthnStatement` element
              than the `NotOnOrAfter` value set by the `assertionDuration` property.
            type: integer
          sloBinding:
            $ref: '#/components/schemas/EnumApplicationSAMLSloBinding'
          sloEndpoint:
            description: "A string that specifies the logout endpoint URL. This is\
              \ an optional property. However, if a sloEndpoint logout endpoint URL\
              \ is not defined, logout actions result in an error."
            type: string
          sloResponseEndpoint:
            description: "A string that specifies the endpoint URL to submit the logout\
              \ response. If a value is not provided, the sloEndpoint property value\
              \ is used to submit SLO response."
            type: string
          sloWindow:
            description: "Defines how long PingOne can exchange logout messages with\
              \ the application, specifically a `LogoutRequest` from the application,\
              \ since the initial request. PingOne can also send a `LogoutRequest`\
              \ to the application when a single logout is initiated by the user from\
              \ other session participants, such as an application or identity provider.\
              \ This setting is per application. The SLO logout is separate from the\
              \ user session logout that revokes all tokens."
            type: integer
          spEncryption:
            $ref: '#/components/schemas/ApplicationSAML_allOf_spEncryption'
          spEntityId:
            description: A string that specifies the service provider entity ID used
              to lookup the application. This is a required property and is unique
              within the environment.
            type: string
          spVerification:
            $ref: '#/components/schemas/ApplicationSAML_allOf_spVerification'
          template:
            $ref: '#/components/schemas/ApplicationTemplate'
          virtualServerIdSettings:
            $ref: '#/components/schemas/ApplicationSAML_allOf_virtualServerIdSettings'
        required:
        - acsUrls
        - assertionDuration
        - spEntityId
        type: object
    ApplicationOIDC:
      allOf:
      - $ref: '#/components/schemas/Application'
      - properties:
          additionalRefreshTokenReplayProtectionEnabled:
            default: true
            description: "When set to `true` (the default), if you attempt to reuse\
              \ the refresh token, the authorization server immediately revokes the\
              \ reused refresh token, as well as all descendant tokens. Setting this\
              \ to null equates to a `false` setting."
            type: boolean
          allowWildcardInRedirectUris:
            description: "A boolean to specify whether wildcards are allowed in redirect\
              \ URIs. For more information, see [Wildcards in Redirect URIs](https://docs.pingidentity.com/csh?context=p1_c_wildcard_redirect_uri)."
            type: boolean
          assignActorRoles:
            description: A boolean that specifies whether the permissions service
              should assign default roles to the application. This property is set
              only on the POST request. The property is ignored when included in a
              PUT request.
            type: boolean
          clientId:
            description: "(Required when `clientSecret` is specified.) Supported only\
              \ for `POST` operations. To modify the value of this field, the environment\
              \ must be enabled with the feature flag to allow importing applications\
              \ with administrator defined client ID and client secret values. This\
              \ is the unique ID of an external application that is being migrated\
              \ to PingOne. The ID must be a minimum of 8 alpha-numeric characters,\
              \ and must be globally unique in PingOne."
            minLength: 8
            type: string
          clientSecret:
            description: "(Required when `clientId` is specified.) Supported only\
              \ for `POST` operations. To modify the value of this field, the environment\
              \ must be enabled with the feature flag to allow importing applications\
              \ with administrator defined client ID and client secret values. This\
              \ is the client secret associated with `clientId` for an external application\
              \ that is being migrated to PingOne. This must be a minimum of 8 alpha-numeric\
              \ characters."
            format: password
            minLength: 8
            readOnly: true
            type: string
          corsSettings:
            $ref: '#/components/schemas/ApplicationCorsSettings'
          devicePathId:
            description: "A string that specifies a unique identifier within an environment\
              \ for a device authorization grant flow to provide a short identifier\
              \ to the application. This property is ignored when the `deviceCustomVerificationUri`\
              \ property is configured. The string can contain any letters, numbers,\
              \ and some special characters (regex `a-zA-Z0-9_-`). It can have a length\
              \ of no more than 50 characters (`min`/`max`=`1`/`50`)."
            pattern: "^[a-zA-Z0-9_-]{1,50}$"
            type: string
          deviceCustomVerificationUri:
            description: A string that specifies an optional custom verification URI
              that is returned for the `/device_authorization` endpoint.
            type: string
          deviceTimeout:
            default: 600
            description: An integer that specifies the length of time (in seconds)
              that the `userCode` and `deviceCode` returned by the `/device_authorization`
              endpoint are valid. This property is required only for applications
              in which the `grantTypes` property is set to `device_code`. The default
              value is `600` seconds. It can have a value of no more than `3600` seconds
              (`min`/`max`=`1`/`3600`).
            maximum: 3600
            minimum: 1
            type: integer
          devicePollingInterval:
            default: 5
            description: An integer that specifies the frequency (in seconds) for
              the client to poll the `/as/token` endpoint. This property is required
              only for applications in which the `grantTypes` property is set to `device_code`.
              The default value is `5` seconds. It can have a value of no more than
              `60` seconds (`min`/`max`=`1`/`60`).
            maximum: 60
            minimum: 1
            type: integer
          idpSignoff:
            description: Set this to true to allow an application to request to terminate
              a user session using only the ID token. The application is not required
              to have access to the session token cookie.
            type: boolean
          includeX5t:
            description: "Specifies whether tokens signed for this application include\
              \ the `x5t`` signature header in the signed JWT. Refer to [JSON Web\
              \ Signature (JWS), section \"x5t\" (X.509 Certificate SHA-1 Thumbprint)\
              \ Header Parameter](https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1.7)."
            type: boolean
          jwks:
            description: "A JWKS string that validates the signature of signed JWTs\
              \ for applications that use the `PRIVATE_KEY_JWT` option for the `tokenEndpointAuthMethod`.\
              \ This property is required when `tokenEndpointAuthMethod` is `PRIVATE_KEY_JWT`\
              \ and the `jwksUrl` property is empty. For more information, see [Create\
              \ a private_key_jwt JWKS string](https://apidocs.pingidentity.com/pingone/platform/v1/api/#create-a-private_key_jwt-jwks-string).\
              \ This property is also required if the optional `request` property\
              \ JWT on the authorize endpoint is signed using the RS256 (or RS384,\
              \ RS512) signing algorithm and the `jwksUrl` property is empty. For\
              \ more infornmation about signing the request property JWT, see [Create\
              \ a request property JWT](https://apidocs.pingidentity.com/pingone/platform/v1/api/#create-a-request-property-jwt)."
            type: string
          jwksUrl:
            description: "A URL (supports `https://` only) that provides access to\
              \ a JWKS string that validates the signature of signed JWTs for applications\
              \ that use the `PRIVATE_KEY_JWT` option for the `tokenEndpointAuthMethod`.\
              \ This property is required when `tokenEndpointAuthMethod` is `PRIVATE_KEY_JWT`\
              \ and the `jwks` property is empty. For more information, see [Create\
              \ a private_key_jwt JWKS string](https://apidocs.pingidentity.com/pingone/platform/v1/api/#create-a-private_key_jwt-jwks-string).\
              \ This property is also required if the optional `request` property\
              \ JWT on the authorize endpoint is signed using the RS256 (or RS384,\
              \ RS512) signing algorithm and the `jwks` property is empty. For more\
              \ infornmation about signing the request property JWT, see [Create a\
              \ request property JWT](https://apidocs.pingidentity.com/pingone/platform/v1/api/#create-a-request-property-jwt)."
            type: string
          mobile:
            $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile'
          kerberos:
            $ref: '#/components/schemas/ApplicationOIDC_allOf_kerberos'
          grantTypes:
            description: "A string that specifies the grant type for the authorization\
              \ request. Options are AUTHORIZATION_CODE, IMPLICIT, REFRESH_TOKEN,\
              \ CLIENT_CREDENTIALS."
            items:
              $ref: '#/components/schemas/EnumApplicationOIDCGrantType'
            type: array
          homePageUrl:
            description: A string that specifies the custom home page URL for the
              application.
            type: string
          initiateLoginUri:
            description: "A string that specifies the URI to use for third-parties\
              \ to begin the sign-on process for the application. If specified, PingOne\
              \ redirects users to this URI to initiate SSO to PingOne. The application\
              \ is responsible for implementing the relevant OIDC flow when the initiate\
              \ login URI is requested. This property is required if you want the\
              \ application to appear in the PingOne Application Portal. See the OIDC\
              \ specification section of [Initiating Login from a Third Party](https://openid.net/specs/openid-connect-core-1_0.html#ThirdPartyInitiatedLogin)\
              \ for more information."
            type: string
          opSessionCheckEnabled:
            default: false
            description: "When enabled, PingOne includes the `session_state` parameter\
              \ in the authentication response, per spec with [OpenID Connect Session\
              \ Management 1.0](https://openid.net/specs/openid-connect-session-1_0.html).\
              \ Refer to [OIDC Session Management](https://apidocs.pingidentity.com/pingone/main/v1/api/#oidc-session-management)\
              \ in the Developer's Foundations for more information. This property\
              \ is disabled by default."
            type: boolean
          parRequirement:
            $ref: '#/components/schemas/EnumApplicationOIDCPARRequirement'
          parTimeout:
            default: 60
            description: PAR timeout in seconds. Must be between `1` and `600`. The
              default value is `60`.
            maximum: 600
            minimum: 1
            type: integer
          pkceEnforcement:
            $ref: '#/components/schemas/EnumApplicationOIDCPKCEOption'
          postLogoutRedirectUris:
            description: A string that specifies the URLs that the browser can be
              redirected to after logout.
            items:
              type: string
            type: array
          redirectUris:
            description: A string that specifies the callback URI for the authentication
              response.
            items:
              type: string
            type: array
          refreshTokenDuration:
            default: 2592000
            description: "An integer that specifies the lifetime in seconds of the\
              \ refresh token. If a value is not provided, the default value is 2592000,\
              \ or 30 days. Valid values are between 60 and 2147483647. If the `refreshTokenRollingDuration`\
              \ property is specified for the application, then this property must\
              \ be less than or equal to the value of `refreshTokenRollingDuration`.\
              \ After this property is set, the value cannot be nullified. This value\
              \ is used to generate the value for the exp claim when minting a new\
              \ refresh token."
            maximum: 2147483647
            minimum: 60
            type: integer
          refreshTokenRollingDuration:
            description: "An integer that specifies the number of seconds a refresh\
              \ token can be exchanged before re-authentication is required. If a\
              \ value is not provided, the refresh token is valid forever. Valid values\
              \ are between 60 and 2147483647. After this property is set, the value\
              \ cannot be nullified. This value is used to generate the value for\
              \ the exp claim when minting a new refresh token."
            maximum: 2147483647
            type: integer
          refreshTokenRollingGracePeriodDuration:
            description: The number of seconds that a refresh token may be reused
              after having been exchanged for a new set of tokens. This is useful
              in the case of network errors on the client. Valid values are between
              0 and 86400 seconds. Null is treated the same as 0.
            maximum: 86400
            type: integer
          refreshTokenType:
            $ref: '#/components/schemas/EnumApplicationOIDCRefreshTokenType'
          requestScopesForMultipleResourcesEnabled:
            default: false
            description: "Specifies whether the application can request scopes from\
              \ multiple custom resources. The default value is `false`. For more\
              \ information about scopes and access tokens, refer to [Resource Scopes](https://apidocs.pingidentity.com/pingone/platform/v1/api/#resource-scopes)."
            type: boolean
          requireSignedRequestObject:
            description: "Indicates that the Java Web Token (JWT) for the [request\
              \ query](https://openid.net/specs/openid-connect-core-1_0.html#RequestObject)\
              \ parameter is required to be signed. If `false` or null (default),\
              \ a signed request object is not required. Both `supportUnsignedRequestObject`\
              \ and this property cannot be set to `true`."
            type: boolean
          responseTypes:
            description: "The code or token type returned by an authorization request.\
              \ Options are `TOKEN`, `ID_TOKEN`, and `CODE`. For hybrid flows that\
              \ specify `CODE` with `TOKEN` or `ID_TOKEN`, see [Hybrid grant type](https://apidocs.pingidentity.com/pingone/main/v1/api/#hybrid-grant-type)."
            items:
              $ref: '#/components/schemas/EnumApplicationOIDCResponseType'
            type: array
          signing:
            $ref: '#/components/schemas/ApplicationOIDC_allOf_signing'
          supportUnsignedRequestObject:
            description: "A boolean that specifies whether the [request query](https://openid.net/specs/openid-connect-core-1_0.html#RequestObject)\
              \ parameter JWT is allowed to be unsigned. If false or null (default),\
              \ an unsigned request object is not allowed."
            type: boolean
          tags:
            description: An array that specifies the list of labels associated with
              the application. Options are `PING_FED_CONNECTION_INTEGRATION`.  Only
              applicable for creating worker applications.
            items:
              $ref: '#/components/schemas/EnumApplicationTags'
            type: array
          targetLinkUri:
            description: "The URI for the application. If specified, PingOne will\
              \ redirect application users to this URI after a user is authenticated.\
              \ In the PingOne admin console, this becomes the value of the `target_link_uri`\
              \ parameter used for the Initiate Single Sign-On URL field."
            type: string
          template:
            $ref: '#/components/schemas/ApplicationTemplate'
          tokenEndpointAuthMethod:
            $ref: '#/components/schemas/EnumApplicationOIDCTokenAuthMethod'
        required:
        - tokenEndpointAuthMethod
        type: object
    ApplicationOIDCInternal:
      allOf:
      - $ref: '#/components/schemas/Application'
      - properties:
          pkceEnforcement:
            $ref: '#/components/schemas/EnumApplicationOIDCPKCEOption'
          tokenEndpointAuthMethod:
            $ref: '#/components/schemas/EnumApplicationOIDCTokenAuthMethod'
        required:
        - tokenEndpointAuthMethod
        type: object
    ApplicationPingOneAdminConsole:
      properties:
        pkceEnforcement:
          $ref: '#/components/schemas/EnumApplicationOIDCPKCEOption'
        tokenEndpointAuthMethod:
          $ref: '#/components/schemas/EnumApplicationOIDCTokenAuthMethod'
      type: object
    ApplicationPingOnePortal:
      allOf:
      - $ref: '#/components/schemas/ApplicationOIDCInternal'
      - properties:
          applyDefaultTheme:
            description: "If `true`, applies the default theme to the app portal application."
            type: boolean
        required:
        - applyDefaultTheme
        type: object
    ApplicationPingOneSelfService:
      allOf:
      - $ref: '#/components/schemas/ApplicationOIDCInternal'
      - properties:
          enableDefaultThemeFooter:
            description: "If `true`, shows the default theme footer on the self service\
              \ application. Applies only if `applyDefaultTheme` is also `true`."
            type: boolean
          applyDefaultTheme:
            description: "If `true`, applies the default theme to the self service\
              \ application."
            type: boolean
        required:
        - applyDefaultTheme
        type: object
    ApplicationAttributeMapping:
      example:
        userInfo: true
        _links:
          key:
            href: https://openapi-generator.tech
        oidcScopes:
        - oidcScopes
        - oidcScopes
        required: true
        createdAt: 2000-01-23T04:56:07.000+00:00
        application:
          id: id
        nameFormat: nameFormat
        mappingType: null
        name: name
        idToken: true
        id: id
        value: value
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the application ID.
          readOnly: true
          type: string
        application:
          $ref: '#/components/schemas/ApplicationAttributeMapping_application'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        mappingType:
          $ref: '#/components/schemas/EnumAttributeMappingType'
        name:
          description: "A string that specifies the name of attribute and must be\
            \ unique within an application. For SAML applications, the samlAssertion.subject\
            \ name is a reserved case-insensitive name which indicates the mapping\
            \ to be used for the subject in an assertion. For OpenID Connect applications,\
            \ the following names are reserved and cannot be used acr, amr, at_hash,\
            \ aud, auth_time, azp, client_id, exp, iat, iss, jti, nbf, nonce, org,\
            \ scope, sid, sub  This is a required property."
          type: string
        required:
          description: "A boolean to specify whether a mapping value is required for\
            \ this attribute. If true, a value must be set and a non-empty value must\
            \ be available in the SAML assertion or ID token."
          type: boolean
        updatedAt:
          description: The time the resource was updated.
          format: date-time
          readOnly: true
          type: string
        value:
          description: "A string that specifies the string constants or expression\
            \ for mapping the attribute path against a specific source. The expression\
            \ format is ${<source>.<attribute_path>}. The only supported source is\
            \ user (for example, ${user.id}). This is a required property."
          type: string
        nameFormat:
          description: A URI reference representing the classification of the attribute.
            Helps the service provider interpret the attribute format.
          type: string
        idToken:
          default: true
          description: "Whether the attribute mapping should be available in the ID\
            \ Token. This property is applicable only when the application's `protocol`\
            \ property is `OPENID_CONNECT`. If omitted, the default is `true`. Note\
            \ that the `idToken` and `userInfo` properties cannot both be set to `false`.\
            \ At least one of these properties must have a value of true."
          type: boolean
        userInfo:
          default: true
          description: "Whether the attribute mapping should be available through\
            \ the `/as/userinfo` endpoint. This property is applicable only when the\
            \ application's protocol property is `OPENID_CONNECT`. If omitted, the\
            \ default is `true`. Note that the `idToken` and `userInfo` properties\
            \ cannot both be set to `false`. At least one of these properties must\
            \ have a value of `true`."
          type: boolean
        oidcScopes:
          description: "OIDC resource scope IDs that this attribute mapping is available\
            \ for exclusively. This setting overrides any global OIDC resource scopes\
            \ that contain an attribute mapping with the same name. The list can contain\
            \ only scope IDs that have been granted for the application through the\
            \ `/grants` endpoint. A null value is accepted for backwards compatibility.\
            \ However, an empty set is invalid, and one scope ID is expected. If null,\
            \ the response includes this mapping in the `openid` scope."
          items:
            type: string
          type: array
      required:
      - name
      - required
      - value
      type: object
    ApplicationResourceGrant:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        application:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        resource:
          id: id
        id: id
        scopes:
        - id: id
        - id: id
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        application:
          $ref: '#/components/schemas/ApplicationResourceGrant_application'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        id:
          description: A string that specifies the application resource grant ID.
          readOnly: true
          type: string
        resource:
          $ref: '#/components/schemas/ApplicationResourceGrant_resource'
        scopes:
          items:
            $ref: '#/components/schemas/ApplicationResourceGrant_scopes_inner'
          type: array
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - resource
      - scopes
      type: object
    ApplicationSecret:
      example:
        environment:
          id: id
        previous:
          lastUsed: 2000-01-23T04:56:07.000+00:00
          secret: secret
          expiresAt: 2000-01-23T04:56:07.000+00:00
        _links:
          key:
            href: https://openapi-generator.tech
        secret: secret
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        secret:
          description: A string that specifies the application secret ID used to authenticate
            to the authorization server.
          format: password
          readOnly: true
          type: string
        previous:
          $ref: '#/components/schemas/ApplicationSecret_previous'
      type: object
    ApplicationTemplate:
      properties:
        configuration:
          additionalProperties:
            type: string
          description: Contains a key/value map of the parameters required by the
            integration in Integration Catalog.
          type: object
        integration:
          $ref: '#/components/schemas/ApplicationTemplate_integration'
        version:
          $ref: '#/components/schemas/ApplicationTemplate_version'
      required:
      - configuration
      - integration
      - version
      type: object
    ApplicationWSFED:
      allOf:
      - $ref: '#/components/schemas/Application'
      - properties:
          assertionDuration:
            default: 300
            description: The assertion validity duration in seconds. The default value
              is 300 seconds (5 minutes). Valid values are between 300 and 3932100.
            maximum: 3932100
            minimum: 300
            type: integer
          audienceRestriction:
            default: urn:federation:MicrosoftOnline
            description: The service provider ID. Defaults to `urn:federation:MicrosoftOnline`.
            type: string
          corsSettings:
            $ref: '#/components/schemas/ApplicationCorsSettings'
          domainName:
            description: "The federated domain name (for example, the Azure custom\
              \ domain)."
            type: string
          idpSigning:
            $ref: '#/components/schemas/ApplicationWSFED_allOf_idpSigning'
          kerberos:
            $ref: '#/components/schemas/ApplicationWSFED_allOf_kerberos'
          replyUrl:
            description: "The URL that the replying party (such as, Office365) uses\
              \ to accept submissions of RequestSecurityTokenResponse messages that\
              \ are a result of SSO requests."
            type: string
          sloEndpoint:
            description: The single logout endpoint URL.
            type: string
          subjectNameIdentifierFormat:
            $ref: '#/components/schemas/EnumApplicationWSFEDSubjectNameIdentifierFormat'
          wsTrustVersion:
            description: The WS-Trust (Web Services Trust) version to use. Valid values
              are `1.2` and `1.3`.
            pattern: ^(1\.2|1\.3)$
            type: string
        required:
        - domainName
        - idpSigning
        - replyUrl
        type: object
    BillOfMaterials:
      example:
        createdAt: createdAt
        _links:
          key:
            href: https://openapi-generator.tech
        solutionType: null
        updatedAt: updatedAt
        products:
        - bookmarks:
          - name: name
            href: href
          - name: name
            href: href
          console:
            href: href
          description: description
          id: id
          type: null
          tags:
          - null
          - null
          deployment:
            id: id
        - bookmarks:
          - name: name
            href: href
          - name: name
            href: href
          console:
            href: href
          description: description
          id: id
          type: null
          tags:
          - null
          - null
          deployment:
            id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        solutionType:
          $ref: '#/components/schemas/EnumSolutionType'
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
        products:
          description: An array that specifies the products associated with this bill
            of materials
          items:
            $ref: '#/components/schemas/BillOfMaterials_products_inner'
          type: array
      required:
      - products
      type: object
    BrandingSettings:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        companyName: companyName
        logo:
          href: href
          id: id
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: Specifies the resource’s unique identifier.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        companyName:
          description: The company name associated with the specified environment.
          type: string
        logo:
          $ref: '#/components/schemas/BrandingSettings_logo'
      type: object
    BrandingThemeConfigurationLocalizedText:
      description: The localization object to specify language translations for the
        form header or footer.
      example:
        defaultLanguage: defaultLanguage
        contentType: null
        enabled: true
        content:
          key:
            inputText: inputText
            contentType: null
      properties:
        enabled:
          description: Specifies whether localization is enabled for the header or
            footer.
          type: boolean
        defaultLanguage:
          description: "The localization language code for the header or footer's\
            \ default language (for example, \"defaultLanguage\" set to \"en\")."
          type: string
        contentType:
          $ref: '#/components/schemas/EnumBrandingThemeLocalizedContentType'
        content:
          additionalProperties:
            $ref: '#/components/schemas/BrandingThemeConfigurationLocalizedTextContent'
          description: The localization language object that specifies the localized
            text and content type for the language options.
          type: object
      type: object
    BrandingThemeConfigurationLocalizedTextContent:
      description: The localization language object that specifies the localized text
        and content type for a specific language.
      example:
        inputText: inputText
        contentType: null
      properties:
        inputText:
          description: The header or footer text in the specified language.
          type: string
        contentType:
          $ref: '#/components/schemas/EnumBrandingThemeLocalizedContentType'
      type: object
    BrandingTheme:
      example:
        template: null
        default: true
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        configuration:
          logoHeight: logoHeight
          titleTextColor: titleTextColor
          linkTextSize: linkTextSize
          inputBoxBorderColor: inputBoxBorderColor
          buttonTextSize: buttonTextSize
          buttonCornerRadius: buttonCornerRadius
          headingTextColor: headingTextColor
          inputCornerRadius: inputCornerRadius
          logo:
            href: href
            id: id
          titleTextSize: titleTextSize
          buttonHoverStateBorderColor: buttonHoverStateBorderColor
          backgroundType: null
          buttonTextWeight: buttonTextWeight
          cardLogoAlignment: cardLogoAlignment
          bodyTextWeight: bodyTextWeight
          buttonHoverStateFillColor: buttonHoverStateFillColor
          bodyTextSize: bodyTextSize
          headerLocalized:
            defaultLanguage: defaultLanguage
            contentType: null
            enabled: true
            content:
              key:
                inputText: inputText
                contentType: null
          subTitleTextWeight: subTitleTextWeight
          inputValueTextColor: inputValueTextColor
          inputLabelTextSize: inputLabelTextSize
          inputLabelTextColor: inputLabelTextColor
          name: name
          header: header
          buttonBorderWidth: buttonBorderWidth
          cardHorizontalAlignment: cardHorizontalAlignment
          cardShadow: cardShadow
          headerBackgroundColor: headerBackgroundColor
          buttonColor: buttonColor
          buttonBorderColor: buttonBorderColor
          footer: footer
          backgroundImage:
            href: href
            id: id
          cardBorderColor: cardBorderColor
          inputBorderWidth: inputBorderWidth
          cardVerticalAlignment: cardVerticalAlignment
          subTitleTextSize: subTitleTextSize
          inputLabelTextWeight: inputLabelTextWeight
          footerLocalized:
            defaultLanguage: defaultLanguage
            contentType: null
            enabled: true
            content:
              key:
                inputText: inputText
                contentType: null
          buttonTextColor: buttonTextColor
          globalFont: globalFont
          logoType: null
          backgroundOutlineColor: backgroundOutlineColor
          inputLabelPosition: inputLabelPosition
          backgroundColor: backgroundColor
          foregroundMainColor: foregroundMainColor
          subTitleTextColor: subTitleTextColor
          schemaVersion: 0
          titleTextWeight: titleTextWeight
          cardCornerRadius: cardCornerRadius
          inputValueTextSize: inputValueTextSize
          inputValueTextWeight: inputValueTextWeight
          cardColor: cardColor
          applicationBackgroundColor: applicationBackgroundColor
          buttonHoverStateTextColor: buttonHoverStateTextColor
          linkTextWeight: linkTextWeight
          linkTextHoverColor: linkTextHoverColor
          linkTextColor: linkTextColor
          bodyTextColor: bodyTextColor
          foregroundHighlightColor: foregroundHighlightColor
          cardBorderWidth: cardBorderWidth
          focusRectangleColor: focusRectangleColor
        modified: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        configuration:
          $ref: '#/components/schemas/BrandingTheme_configuration'
        default:
          description: Specifies whether this theme is the environment's default branding
            configuration.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: Specifies the resource’s unique identifier.
          readOnly: true
          type: string
        modified:
          description: The time the resource was last modified.
          format: date-time
          readOnly: true
          type: string
        template:
          $ref: '#/components/schemas/EnumBrandingThemeTemplate'
      required:
      - configuration
      - default
      - template
      type: object
    BrandingThemeDefault:
      example:
        default: true
        _links:
          key:
            href: https://openapi-generator.tech
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        default:
          description: A boolean to specify whether the theme is the default in the
            environment
          type: boolean
      required:
      - default
      type: object
    Certificate:
      example:
        customCRL: customCRL
        serialNumber: 5
        _links:
          key:
            href: https://openapi-generator.tech
        issuerDN: issuerDN
        expiresAt: 2000-01-23T04:56:07.000+00:00
        signatureAlgorithm: null
        validityPeriod: 1
        createdAt: 2000-01-23T04:56:07.000+00:00
        default: true
        environment:
          id: id
        keyLength: 5
        organization:
          id: id
        name: name
        startsAt: 2000-01-23T04:56:07.000+00:00
        id: id
        algorithm: null
        status: null
        subjectDN: subjectDN
        usageType: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        algorithm:
          $ref: '#/components/schemas/EnumCertificateKeyAlgorithm'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        default:
          description: Specifies whether this is the default key for the specified
            environment.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        expiresAt:
          description: The time the key resource expires.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Specifies the resource’s unique identifier.
          readOnly: true
          type: string
        issuerDN:
          description: Specifies the distinguished name of the certificate issuer.
          type: string
        keyLength:
          description: "The key length. For RSA keys, options are `2048`, `3072`,\
            \ `4096`, and `7680`. For elliptical curve (EC) keys, options are `224`,\
            \ `256`, `384`, and `521`."
          type: integer
        name:
          description: Specifies the resource name.
          type: string
        organization:
          $ref: '#/components/schemas/ObjectOrganization'
        serialNumber:
          description: Specifies the serial number of the key or certificate.
          format: int64
          type: integer
        signatureAlgorithm:
          $ref: '#/components/schemas/EnumCertificateKeySignagureAlgorithm'
        startsAt:
          description: The time the validity period starts.
          format: date-time
          readOnly: true
          type: string
        status:
          $ref: '#/components/schemas/EnumCertificateKeyStatus'
        subjectDN:
          description: Specifies the distinguished name of the subject being secured.
          type: string
        usageType:
          $ref: '#/components/schemas/EnumCertificateKeyUsageType'
        validityPeriod:
          description: Specifies the number of days the key is valid.
          minimum: 1
          type: integer
        customCRL:
          description: A URL string of a custom Certificate Revokation List endpoint.  Used
            for certificates of type `ISSUANCE`.
          pattern: "^http:\\/\\/[a-zA-Z0-9.-\\/]*$"
          type: string
      required:
      - algorithm
      - keyLength
      - name
      - signatureAlgorithm
      - subjectDN
      - usageType
      - validityPeriod
      type: object
    CertificateKeyUpdate:
      example:
        default: true
        issuerDN: issuerDN
        usageType: null
      properties:
        default:
          description: Specifies whether this is the default key for the specified
            environment.
          type: boolean
        usageType:
          $ref: '#/components/schemas/EnumCertificateKeyUsageType'
        issuerDN:
          description: Specifies the distinguished name of the certificate issuer.
          type: string
      required:
      - default
      - usageType
      type: object
    CustomAdminRole:
      example:
        environment:
          id: id
        canAssign:
        - id: id
        - id: id
        _links:
          key:
            href: https://openapi-generator.tech
        permissions:
        - id: id
        - id: id
        name: name
        canBeAssignedBy:
        - id: id
        - id: id
        description: description
        applicableTo:
        - null
        - null
        id: id
        type: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        applicableTo:
          description: The scope types to which the role can be applied.
          items:
            $ref: '#/components/schemas/EnumCustomAdminRoleApplicableTo'
          type: array
        canAssign:
          description: "A relationship that specifies if an actor is assigned the\
            \ current custom role for a jurisdiction, then the actor can assign any\
            \ of this set of roles to another actor for the same jurisdiction or sub-jurisdiction.\
            \ This capability is dreived from the canBeAssignedBy property."
          items:
            $ref: '#/components/schemas/CustomAdminRole_canAssign_inner'
          readOnly: true
          type: array
        canBeAssignedBy:
          description: A relationship that determines whether a user assigned to one
            of this set of roles for a jurisdiction can assign the current custom
            role to another user for the same jurisdiction or sub-jurisdiction.
          items:
            $ref: '#/components/schemas/CustomAdminRole_canAssign_inner'
          type: array
        description:
          description: The description of the role.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: The role name.
          type: string
        permissions:
          description: The set of permissions assigned to the role.
          items:
            $ref: '#/components/schemas/CustomAdminRole_permissions_inner'
          type: array
        type:
          $ref: '#/components/schemas/EnumCustomAdminRoleType'
      required:
      - canBeAssignedBy
      - name
      - permissions
      type: object
    CustomDomain:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        domainName: domainName
        certificate:
          expiresAt: 2000-01-23T04:56:07.000+00:00
        id: id
        canonicalName: canonicalName
        status: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        certificate:
          $ref: '#/components/schemas/CustomDomain_certificate'
        canonicalName:
          description: A string that specifies the domain name that should be used
            as the value of the CNAME record in the customer’s DNS.
          readOnly: true
          type: string
        domainName:
          description: "A string that specifies the resource name, which must be provided\
            \ and must be unique within an environment (for example, auth.shopco.com).\
            \ This is a required property."
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        status:
          $ref: '#/components/schemas/EnumCustomDomainStatus'
      required:
      - domainName
      type: object
    CustomDomainCertificateRequest:
      example:
        privateKey: privateKey
        intermediateCertificates: intermediateCertificates
        certificate: certificate
      properties:
        certificate:
          description: |
            A string that specifies the PEM-encoded certificate to import. This is a required property. The following validation is performed on the certificate: \
            It must not be expired. \
            It MUST not be self signed. \
            The custom domain name MUST match one of the subject alternative name (SAN) values on the certificate.
          type: string
        intermediateCertificates:
          description: A string that specifies the PEM-encoded certificate chain.
          type: string
        privateKey:
          description: "A string that specifies the PEM-encoded, unencrypted private\
            \ key that matches the certificate's public key. This is a required property."
          format: password
          type: string
      required:
      - certificate
      - privateKey
      type: object
    EmailDomain:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        domainName: domainName
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the auto-generated ID of the email
            domain.
          readOnly: true
          type: string
        domainName:
          description: "A string that specifies the resource name, which must be provided\
            \ and must be unique within an environment (for example, auth.shopco.com).\
            \ This is a required property. Wildcards are NOT supported."
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
      required:
      - domainName
      type: object
    EmailDomainDKIMStatus:
      example:
        regions:
        - name: name
          tokens:
          - value: value
            key: key
          - value: value
            key: key
          status: null
        - name: name
          tokens:
          - value: value
            key: key
          - value: value
            key: key
          status: null
        type: type
      properties:
        type:
          description: "A string that specifies the type of DNS record, with the value\
            \ \"CNAME\"."
          readOnly: true
          type: string
        regions:
          description: "The regions collection specifies the properties for the 4\
            \ AWS SES regions that are used for sending email for the environment.\
            \ The regions are determined by the geography where this environment was\
            \ provisioned (North America, Canada, Europe & Asia-Pacific)."
          items:
            $ref: '#/components/schemas/EmailDomainDKIMStatus_regions_inner'
          readOnly: true
          type: array
      type: object
    EmailDomainOwnershipStatus:
      example:
        regions:
        - name: name
          value: value
          key: key
          status: null
        - name: name
          value: value
          key: key
          status: null
        environmentDnsRecord:
          value: value
          key: key
          status: null
        type: type
      properties:
        type:
          description: "A string that specifies the type of DNS record, with the value\
            \ \"TXT\"."
          readOnly: true
          type: string
        regions:
          description: "The regions collection specifies the properties for the 4\
            \ AWS SES regions that are used for sending email for the environment.\
            \ The regions are determined by the geography where this environment was\
            \ provisioned (North America, Canada, Europe & Asia-Pacific)."
          items:
            $ref: '#/components/schemas/EmailDomainOwnershipStatus_regions_inner'
          readOnly: true
          type: array
        environmentDnsRecord:
          $ref: '#/components/schemas/EmailDomainOwnershipStatus_environmentDnsRecord'
      type: object
    EmailDomainSPFStatus:
      example:
        type: type
        value: value
        key: key
        status: null
      properties:
        type:
          description: "A string that specifies the type of DNS record, with the value\
            \ \"TXT\"."
          readOnly: true
          type: string
        status:
          $ref: '#/components/schemas/EnumEmailDomainStatus'
        key:
          description: Record name.
          type: string
        value:
          description: Record value.
          type: string
      type: object
    EmailDomainTrustedEmail:
      example:
        environment:
          id: id
        emailAddress: emailAddress
        domain:
          id: id
        id: id
        domainId: domainId
        status: null
      properties:
        id:
          description: A string that specifies the auto generated ID of the trusted
            email address.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        domain:
          $ref: '#/components/schemas/EmailDomainTrustedEmail_domain'
        emailAddress:
          description: "A string that specifies the trusted email address, for example\
            \ john.smith@shopco.com."
          type: string
        status:
          $ref: '#/components/schemas/EnumTrustedEmailStatus'
        domainId:
          description: A string that specifies the trusted email domain resource’s
            unique identifier associated with the resource.
          readOnly: true
          type: string
      required:
      - emailAddress
      type: object
    EntityArray:
      example:
        size: 1.041444916118296
        _links:
          key:
            href: https://openapi-generator.tech
        _embedded:
          flowPolicies:
          - environment:
              id: id
            application:
              name: name
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            id: id
            trigger:
              type: null
            enabled: true
          - environment:
              id: id
            application:
              name: name
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            id: id
            trigger:
              type: null
            enabled: true
          subscriptions:
          - _links:
              key:
                href: https://openapi-generator.tech
            format: null
            tlsClientAuthKeyPair:
              id: id
            payloadOptions:
              maximumPayloadLimit:
                size: 4
                type: null
              payloadFormat:
                tcp:
                  format: null
                  additionalAttributes:
                    key: additionalAttributes
                https:
                  prettyPrint: true
                  format: null
            connectionDetails:
              headers:
                key: headers
              url: url
            enabled: true
            verifyTlsCertificates: true
            createdAt: 2000-01-23T04:56:07.000+00:00
            environment:
              id: id
            protocol: null
            httpEndpoint:
              headers:
                key: headers
              url: url
            name: name
            id: id
            filterOptions:
              includedActionTypes:
              - includedActionTypes
              - includedActionTypes
              includedTags:
              - null
              - null
              userAgentExposed: false
              includedPopulations:
              - id: id
              - id: id
              ipAddressExposed: false
              includedApplications:
              - id: id
              - id: id
            updatedAt: 2000-01-23T04:56:07.000+00:00
          - _links:
              key:
                href: https://openapi-generator.tech
            format: null
            tlsClientAuthKeyPair:
              id: id
            payloadOptions:
              maximumPayloadLimit:
                size: 4
                type: null
              payloadFormat:
                tcp:
                  format: null
                  additionalAttributes:
                    key: additionalAttributes
                https:
                  prettyPrint: true
                  format: null
            connectionDetails:
              headers:
                key: headers
              url: url
            enabled: true
            verifyTlsCertificates: true
            createdAt: 2000-01-23T04:56:07.000+00:00
            environment:
              id: id
            protocol: null
            httpEndpoint:
              headers:
                key: headers
              url: url
            name: name
            id: id
            filterOptions:
              includedActionTypes:
              - includedActionTypes
              - includedActionTypes
              includedTags:
              - null
              - null
              userAgentExposed: false
              includedPopulations:
              - id: id
              - id: id
              ipAddressExposed: false
              includedApplications:
              - id: id
              - id: id
            updatedAt: 2000-01-23T04:56:07.000+00:00
          credentials:
          - createdAt: 2000-01-23T04:56:07.000+00:00
            credential: credential
            lastUsedAt: 2000-01-23T04:56:07.000+00:00
            id: id
          - createdAt: 2000-01-23T04:56:07.000+00:00
            credential: credential
            lastUsedAt: 2000-01-23T04:56:07.000+00:00
            id: id
          environments:
          - name: New-Env
            description: New environment description
            type: SANDBOX
            region: EU
            billOfMaterials:
              products:
                type: PING_ONE_BASE
                description: New environment product description
                console:
                  href: https://example.com
            license:
              id: 34f0efac-21d9-4a17-8a35-196bb3362983
          - name: New-Env
            description: New environment description
            type: SANDBOX
            region: EU
            billOfMaterials:
              products:
                type: PING_ONE_BASE
                description: New environment product description
                console:
                  href: https://example.com
            license:
              id: 34f0efac-21d9-4a17-8a35-196bb3362983
          keys:
          - customCRL: customCRL
            serialNumber: 5
            _links:
              key:
                href: https://openapi-generator.tech
            issuerDN: issuerDN
            expiresAt: 2000-01-23T04:56:07.000+00:00
            signatureAlgorithm: null
            validityPeriod: 1
            createdAt: 2000-01-23T04:56:07.000+00:00
            default: true
            environment:
              id: id
            keyLength: 5
            organization:
              id: id
            name: name
            startsAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            status: null
            subjectDN: subjectDN
            usageType: null
          - customCRL: customCRL
            serialNumber: 5
            _links:
              key:
                href: https://openapi-generator.tech
            issuerDN: issuerDN
            expiresAt: 2000-01-23T04:56:07.000+00:00
            signatureAlgorithm: null
            validityPeriod: 1
            createdAt: 2000-01-23T04:56:07.000+00:00
            default: true
            environment:
              id: id
            keyLength: 5
            organization:
              id: id
            name: name
            startsAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            status: null
            subjectDN: subjectDN
            usageType: null
          roles:
          - null
          - null
          alertChannels:
          - environment:
              id: id
            addresses:
            - addresses
            - addresses
            includeAlertTypes:
            - null
            - null
            _links:
              key:
                href: https://openapi-generator.tech
            alertName: alertName
            includeSeverities:
            - null
            - null
            channelType: null
            excludeAlertTypes:
            - null
            - null
            id: id
          - environment:
              id: id
            addresses:
            - addresses
            - addresses
            includeAlertTypes:
            - null
            - null
            _links:
              key:
                href: https://openapi-generator.tech
            alertName: alertName
            includeSeverities:
            - null
            - null
            channelType: null
            excludeAlertTypes:
            - null
            - null
            id: id
          signOnPolicies:
          - createdAt: createdAt
            default: false
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            description: description
            id: id
            updatedAt: updatedAt
          - createdAt: createdAt
            default: false
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            description: description
            id: id
            updatedAt: updatedAt
          themes:
          - template: null
            default: true
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            configuration:
              logoHeight: logoHeight
              titleTextColor: titleTextColor
              linkTextSize: linkTextSize
              inputBoxBorderColor: inputBoxBorderColor
              buttonTextSize: buttonTextSize
              buttonCornerRadius: buttonCornerRadius
              headingTextColor: headingTextColor
              inputCornerRadius: inputCornerRadius
              logo:
                href: href
                id: id
              titleTextSize: titleTextSize
              buttonHoverStateBorderColor: buttonHoverStateBorderColor
              backgroundType: null
              buttonTextWeight: buttonTextWeight
              cardLogoAlignment: cardLogoAlignment
              bodyTextWeight: bodyTextWeight
              buttonHoverStateFillColor: buttonHoverStateFillColor
              bodyTextSize: bodyTextSize
              headerLocalized:
                defaultLanguage: defaultLanguage
                contentType: null
                enabled: true
                content:
                  key:
                    inputText: inputText
                    contentType: null
              subTitleTextWeight: subTitleTextWeight
              inputValueTextColor: inputValueTextColor
              inputLabelTextSize: inputLabelTextSize
              inputLabelTextColor: inputLabelTextColor
              name: name
              header: header
              buttonBorderWidth: buttonBorderWidth
              cardHorizontalAlignment: cardHorizontalAlignment
              cardShadow: cardShadow
              headerBackgroundColor: headerBackgroundColor
              buttonColor: buttonColor
              buttonBorderColor: buttonBorderColor
              footer: footer
              backgroundImage:
                href: href
                id: id
              cardBorderColor: cardBorderColor
              inputBorderWidth: inputBorderWidth
              cardVerticalAlignment: cardVerticalAlignment
              subTitleTextSize: subTitleTextSize
              inputLabelTextWeight: inputLabelTextWeight
              footerLocalized:
                defaultLanguage: defaultLanguage
                contentType: null
                enabled: true
                content:
                  key:
                    inputText: inputText
                    contentType: null
              buttonTextColor: buttonTextColor
              globalFont: globalFont
              logoType: null
              backgroundOutlineColor: backgroundOutlineColor
              inputLabelPosition: inputLabelPosition
              backgroundColor: backgroundColor
              foregroundMainColor: foregroundMainColor
              subTitleTextColor: subTitleTextColor
              schemaVersion: 0
              titleTextWeight: titleTextWeight
              cardCornerRadius: cardCornerRadius
              inputValueTextSize: inputValueTextSize
              inputValueTextWeight: inputValueTextWeight
              cardColor: cardColor
              applicationBackgroundColor: applicationBackgroundColor
              buttonHoverStateTextColor: buttonHoverStateTextColor
              linkTextWeight: linkTextWeight
              linkTextHoverColor: linkTextHoverColor
              linkTextColor: linkTextColor
              bodyTextColor: bodyTextColor
              foregroundHighlightColor: foregroundHighlightColor
              cardBorderWidth: cardBorderWidth
              focusRectangleColor: focusRectangleColor
            modified: 2000-01-23T04:56:07.000+00:00
            id: id
          - template: null
            default: true
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            configuration:
              logoHeight: logoHeight
              titleTextColor: titleTextColor
              linkTextSize: linkTextSize
              inputBoxBorderColor: inputBoxBorderColor
              buttonTextSize: buttonTextSize
              buttonCornerRadius: buttonCornerRadius
              headingTextColor: headingTextColor
              inputCornerRadius: inputCornerRadius
              logo:
                href: href
                id: id
              titleTextSize: titleTextSize
              buttonHoverStateBorderColor: buttonHoverStateBorderColor
              backgroundType: null
              buttonTextWeight: buttonTextWeight
              cardLogoAlignment: cardLogoAlignment
              bodyTextWeight: bodyTextWeight
              buttonHoverStateFillColor: buttonHoverStateFillColor
              bodyTextSize: bodyTextSize
              headerLocalized:
                defaultLanguage: defaultLanguage
                contentType: null
                enabled: true
                content:
                  key:
                    inputText: inputText
                    contentType: null
              subTitleTextWeight: subTitleTextWeight
              inputValueTextColor: inputValueTextColor
              inputLabelTextSize: inputLabelTextSize
              inputLabelTextColor: inputLabelTextColor
              name: name
              header: header
              buttonBorderWidth: buttonBorderWidth
              cardHorizontalAlignment: cardHorizontalAlignment
              cardShadow: cardShadow
              headerBackgroundColor: headerBackgroundColor
              buttonColor: buttonColor
              buttonBorderColor: buttonBorderColor
              footer: footer
              backgroundImage:
                href: href
                id: id
              cardBorderColor: cardBorderColor
              inputBorderWidth: inputBorderWidth
              cardVerticalAlignment: cardVerticalAlignment
              subTitleTextSize: subTitleTextSize
              inputLabelTextWeight: inputLabelTextWeight
              footerLocalized:
                defaultLanguage: defaultLanguage
                contentType: null
                enabled: true
                content:
                  key:
                    inputText: inputText
                    contentType: null
              buttonTextColor: buttonTextColor
              globalFont: globalFont
              logoType: null
              backgroundOutlineColor: backgroundOutlineColor
              inputLabelPosition: inputLabelPosition
              backgroundColor: backgroundColor
              foregroundMainColor: foregroundMainColor
              subTitleTextColor: subTitleTextColor
              schemaVersion: 0
              titleTextWeight: titleTextWeight
              cardCornerRadius: cardCornerRadius
              inputValueTextSize: inputValueTextSize
              inputValueTextWeight: inputValueTextWeight
              cardColor: cardColor
              applicationBackgroundColor: applicationBackgroundColor
              buttonHoverStateTextColor: buttonHoverStateTextColor
              linkTextWeight: linkTextWeight
              linkTextHoverColor: linkTextHoverColor
              linkTextColor: linkTextColor
              bodyTextColor: bodyTextColor
              foregroundHighlightColor: foregroundHighlightColor
              cardBorderWidth: cardBorderWidth
              focusRectangleColor: focusRectangleColor
            modified: 2000-01-23T04:56:07.000+00:00
            id: id
          customDomains:
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            domainName: domainName
            certificate:
              expiresAt: 2000-01-23T04:56:07.000+00:00
            id: id
            canonicalName: canonicalName
            status: null
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            domainName: domainName
            certificate:
              expiresAt: 2000-01-23T04:56:07.000+00:00
            id: id
            canonicalName: canonicalName
            status: null
          permissions:
          - resource:
              name: name
              id: id
            resourceServer:
              environment:
                id: id
              id: id
            action: action
            description: description
            id: id
            key: key
          - resource:
              name: name
              id: id
            resourceServer:
              environment:
                id: id
              id: id
            action: action
            description: description
            id: id
            key: key
          translations:
          - translatedText: translatedText
            referenceText: referenceText
            shortKey: shortKey
            id: id
            key: key
          - translatedText: translatedText
            referenceText: referenceText
            shortKey: shortKey
            id: id
            key: key
          passwordPolicies:
          - populationCount: 3
            _links:
              key:
                href: https://openapi-generator.tech
            description: description
            excludesCommonlyUsed: true
            minComplexity: 4
            createdAt: createdAt
            default: true
            minUniqueCharacters: 8
            maxAgeDays: 1
            id: id
            maxRepeatedCharacters: 3
            shiftedNumberRowSequenceRule:
              maxLength: 3
            updatedAt: updatedAt
            minCharacters:
              "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
              "0123456789": 6
              ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
              abcdefghijklmnopqrstuvwxyz: 7
            length:
              min: 24
              max: 6
            notSimilarToCurrent: true
            alphabetSequenceRule:
              maxLength: 2
            history:
              retentionDays: 1
              count: 1
            qwertySequenceRule:
              maxLength: 3
            excludesProfileData: true
            environment:
              id: id
            numberSequenceRule:
              maxLength: 2
            lockout:
              durationSeconds: 1
              failureCount: 1
            name: name
            minAgeDays: 1
          - populationCount: 3
            _links:
              key:
                href: https://openapi-generator.tech
            description: description
            excludesCommonlyUsed: true
            minComplexity: 4
            createdAt: createdAt
            default: true
            minUniqueCharacters: 8
            maxAgeDays: 1
            id: id
            maxRepeatedCharacters: 3
            shiftedNumberRowSequenceRule:
              maxLength: 3
            updatedAt: updatedAt
            minCharacters:
              "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
              "0123456789": 6
              ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
              abcdefghijklmnopqrstuvwxyz: 7
            length:
              min: 24
              max: 6
            notSimilarToCurrent: true
            alphabetSequenceRule:
              maxLength: 2
            history:
              retentionDays: 1
              count: 1
            qwertySequenceRule:
              maxLength: 3
            excludesProfileData: true
            environment:
              id: id
            numberSequenceRule:
              maxLength: 2
            lockout:
              durationSeconds: 1
              failureCount: 1
            name: name
            minAgeDays: 1
          revisions:
          - agreement:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            requireReconsent: true
            notValidAfter: 2000-01-23T04:56:07.000+00:00
            effectiveAt: 2000-01-23T04:56:07.000+00:00
            language:
              id: id
            id: id
            text: text
            contentType: null
          - agreement:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            requireReconsent: true
            notValidAfter: 2000-01-23T04:56:07.000+00:00
            effectiveAt: 2000-01-23T04:56:07.000+00:00
            language:
              id: id
            id: id
            text: text
            contentType: null
          roleAssignments:
          - environment:
              id: id
            role:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            scope:
              id: id
              type: null
            readOnly: true
            id: id
            gateway:
              id: id
            group:
              id: id
          - environment:
              id: id
            role:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            scope:
              id: id
              type: null
            readOnly: true
            id: id
            gateway:
              id: id
            group:
              id: id
          trustedEmails:
          - environment:
              id: id
            emailAddress: emailAddress
            domain:
              id: id
            id: id
            domainId: domainId
            status: null
          - environment:
              id: id
            emailAddress: emailAddress
            domain:
              id: id
            id: id
            domainId: domainId
            status: null
          grants:
          - createdAt: 2000-01-23T04:56:07.000+00:00
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            resource:
              id: id
            id: id
            scopes:
            - id: id
            - id: id
            updatedAt: 2000-01-23T04:56:07.000+00:00
          - createdAt: 2000-01-23T04:56:07.000+00:00
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            resource:
              id: id
            id: id
            scopes:
            - id: id
            - id: id
            updatedAt: 2000-01-23T04:56:07.000+00:00
          gateways:
          - null
          - null
          identityProviders:
          - null
          - null
          keyRotationPolicies:
          - _links:
              key:
                href: https://openapi-generator.tech
            dn: dn
            nextKeyId: nextKeyId
            currentKeyId: currentKeyId
            signatureAlgorithm: null
            validityPeriod: 6
            environment:
              id: id
            keyLength: 1
            rotationPeriod: 30
            name: name
            rotatedAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            usageType: null
          - _links:
              key:
                href: https://openapi-generator.tech
            dn: dn
            nextKeyId: nextKeyId
            currentKeyId: currentKeyId
            signatureAlgorithm: null
            validityPeriod: 6
            environment:
              id: id
            keyLength: 1
            rotationPeriod: 30
            name: name
            rotatedAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            usageType: null
          notificationsPolicies:
          - createdAt: 2000-01-23T04:56:07.000+00:00
            default: false
            environment:
              id: id
            quotas:
            - total: 9
              unclaimed: 3
              claimed: 6
              type: null
              deliveryMethods:
              - null
              - null
            - total: 9
              unclaimed: 3
              claimed: 6
              type: null
              deliveryMethods:
              - null
              - null
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            countryLimit:
              countries:
              - countries
              - countries
              type: null
              deliveryMethods:
              - null
              - null
            id: id
            providerConfiguration:
              conditions:
              - countries:
                - countries
                - countries
                deliveryMethods:
                - null
                - null
                fallbackChain:
                - id: id
                - id: id
              - countries:
                - countries
                - countries
                deliveryMethods:
                - null
                - null
                fallbackChain:
                - id: id
                - id: id
            cooldownConfiguration:
              voice:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              whatsApp:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              sms:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              email:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
            updatedAt: 2000-01-23T04:56:07.000+00:00
          - createdAt: 2000-01-23T04:56:07.000+00:00
            default: false
            environment:
              id: id
            quotas:
            - total: 9
              unclaimed: 3
              claimed: 6
              type: null
              deliveryMethods:
              - null
              - null
            - total: 9
              unclaimed: 3
              claimed: 6
              type: null
              deliveryMethods:
              - null
              - null
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            countryLimit:
              countries:
              - countries
              - countries
              type: null
              deliveryMethods:
              - null
              - null
            id: id
            providerConfiguration:
              conditions:
              - countries:
                - countries
                - countries
                deliveryMethods:
                - null
                - null
                fallbackChain:
                - id: id
                - id: id
              - countries:
                - countries
                - countries
                deliveryMethods:
                - null
                - null
                fallbackChain:
                - id: id
                - id: id
            cooldownConfiguration:
              voice:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              whatsApp:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              sms:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
              email:
                resendLimit: 8
                periods:
                - duration: 404
                  timeUnit: null
                - duration: 404
                  timeUnit: null
                groupBy: groupBy
                enabled: true
            updatedAt: 2000-01-23T04:56:07.000+00:00
          languages:
          - null
          - null
          phoneDeliverySettings:
          - null
          - null
          templates:
          - createdAt: createdAt
            variables: "{}"
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            allowDynamicVariables: true
            description: description
            id: id
            deliveryMethods:
            - SMS
            - SMS
            updatedAt: updatedAt
          - createdAt: createdAt
            variables: "{}"
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            allowDynamicVariables: true
            description: description
            id: id
            deliveryMethods:
            - SMS
            - SMS
            updatedAt: updatedAt
          agreements:
          - environment:
              id: id
            totalExpiredConsents: 0
            _links:
              key:
                href: https://openapi-generator.tech
            consentsAggregatedAt: 2000-01-23T04:56:07.000+00:00
            name: name
            description: description
            totalConsents: 1
            id: id
            enabled: true
            reconsentPeriodDays: 6.0274563
          - environment:
              id: id
            totalExpiredConsents: 0
            _links:
              key:
                href: https://openapi-generator.tech
            consentsAggregatedAt: 2000-01-23T04:56:07.000+00:00
            name: name
            description: description
            totalConsents: 1
            id: id
            enabled: true
            reconsentPeriodDays: 6.0274563
          emailDomains:
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            domainName: domainName
            id: id
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            domainName: domainName
            id: id
          groups:
          - sourceId: sourceId
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            externalId: externalId
            customData: "{}"
            population:
              id: id
            directMemberCounts:
              users: 7
            environment:
              id: id
            sourceType: null
            name: name
            userFilter: userFilter
            id: id
            totalMemberCounts:
              users: 1
          - sourceId: sourceId
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            externalId: externalId
            customData: "{}"
            population:
              id: id
            directMemberCounts:
              users: 7
            environment:
              id: id
            sourceType: null
            name: name
            userFilter: userFilter
            id: id
            totalMemberCounts:
              users: 1
          resources:
          - null
          - null
          users:
          - preferredLanguage: preferredLanguage
            _links:
              key:
                href: https://openapi-generator.tech
            timezone: timezone
            lastSignOn:
              at: 2000-01-23T04:56:07.000+00:00
              remoteIp: remoteIp
            locale: locale
            title: title
            type: type
            enabled: true
            identityProvider:
              id: id
              type: null
            lifecycle:
              suppressVerificationCode: true
              status: null
            createdAt: 2000-01-23T04:56:07.000+00:00
            password:
              external:
                gateway:
                  id: id
                  userType:
                    id: id
                  correlationAttributes: "{}"
                  type: null
              forceChange: true
              value: value
            verifyStatus: null
            nickname: nickname
            mfaEnabled: true
            id: id
            email: email
            updatedAt: 2000-01-23T04:56:07.000+00:00
            memberOfGroupIDs:
            - memberOfGroupIDs
            - memberOfGroupIDs
            address:
              streetAddress: streetAddress
              countryCode: countryCode
              postalCode: postalCode
              locality: locality
              region: region
            externalId: externalId
            photo:
              href: href
            memberOfGroupNames:
            - memberOfGroupNames
            - memberOfGroupNames
            population:
              id: id
            emailVerified: true
            primaryPhone: primaryPhone
            environment:
              id: id
            mobilePhone: mobilePhone
            name:
              given: given
              honorificSuffix: honorificSuffix
              middle: middle
              formatted: formatted
              honorificPrefix: honorificPrefix
              family: family
            account:
              canAuthenticate: true
              lockedAt: 2000-01-23T04:56:07.000+00:00
              secondsUntilUnlock: 6
              unlockAt: 2000-01-23T04:56:07.000+00:00
              status: null
            username: username
          - preferredLanguage: preferredLanguage
            _links:
              key:
                href: https://openapi-generator.tech
            timezone: timezone
            lastSignOn:
              at: 2000-01-23T04:56:07.000+00:00
              remoteIp: remoteIp
            locale: locale
            title: title
            type: type
            enabled: true
            identityProvider:
              id: id
              type: null
            lifecycle:
              suppressVerificationCode: true
              status: null
            createdAt: 2000-01-23T04:56:07.000+00:00
            password:
              external:
                gateway:
                  id: id
                  userType:
                    id: id
                  correlationAttributes: "{}"
                  type: null
              forceChange: true
              value: value
            verifyStatus: null
            nickname: nickname
            mfaEnabled: true
            id: id
            email: email
            updatedAt: 2000-01-23T04:56:07.000+00:00
            memberOfGroupIDs:
            - memberOfGroupIDs
            - memberOfGroupIDs
            address:
              streetAddress: streetAddress
              countryCode: countryCode
              postalCode: postalCode
              locality: locality
              region: region
            externalId: externalId
            photo:
              href: href
            memberOfGroupNames:
            - memberOfGroupNames
            - memberOfGroupNames
            population:
              id: id
            emailVerified: true
            primaryPhone: primaryPhone
            environment:
              id: id
            mobilePhone: mobilePhone
            name:
              given: given
              honorificSuffix: honorificSuffix
              middle: middle
              formatted: formatted
              honorificPrefix: honorificPrefix
              family: family
            account:
              canAuthenticate: true
              lockedAt: 2000-01-23T04:56:07.000+00:00
              secondsUntilUnlock: 6
              unlockAt: 2000-01-23T04:56:07.000+00:00
              status: null
            username: username
          signOnPolicyAssignments:
          - environment:
              id: id
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            signOnPolicy:
              id: id
            id: id
            priority: 1
          - environment:
              id: id
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            signOnPolicy:
              id: id
            id: id
            priority: 1
          flowPolicyAssignments:
          - environment:
              id: id
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            id: id
            flowPolicy:
              id: id
            priority: 1
          - environment:
              id: id
            application:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            id: id
            flowPolicy:
              id: id
            priority: 1
          licenses:
          - gateways:
              allowLdapGateway: true
              allowRadiusGateway: true
              allowKerberosGateway: true
            package: package
            _links:
              key:
                href: https://openapi-generator.tech
            advancedServices:
              pingId:
                type: type
                included: true
            credentials:
              allowCredentials: true
            environments:
              allowConnections: true
              regions:
              - null
              - null
              allowAddResources: true
              max: 1
              allowCustomSchema: true
              allowProduction: true
              allowCustomDomain: true
            orchestrate:
              allowOrchestration: true
            mfa:
              allowFido2Devices: true
              allowVoiceOtp: true
              allowSmsOtp: true
              allowEmailOtp: true
              allowPushNotification: true
              allowTotp: true
              allowNotificationOutsideWhitelist: true
            expiresAt: 2000-01-23T04:56:07.000+00:00
            users:
              allowUpdateSelf: true
              allowPasswordPolicy: true
              max: 4
              allowMyAccount: true
              allowPasswordOnlyAuthentication: true
              allowRoleAssignment: true
              entitledToSupport: true
              annualActiveIncluded: 9
              allowPasswordManagement: true
              allowIdentityProviders: true
              allowInboundProvisioning: true
              allowVerificationFlow: true
              monthlyActiveIncluded: 9
              allowProvisioning: true
              hardLimitMax: 5
              allowPasswordManagementNotifications: true
            intelligence:
              allowReputation: true
              allowRisk: true
              allowDataConsent: true
              allowGeoVelocity: true
              allowAnonymousNetworkDetection: true
              allowAdvancedPredictors: true
            fraud:
              allowBotMaliciousDeviceDetection: true
              allowAccountProtection: true
            organization:
              id: id
            terminatesAt: 2000-01-23T04:56:07.000+00:00
            name: name
            verify:
              allowDocumentMatch: true
              allowManualIdInspection: true
              allowFaceMatch: true
              allowPushNotifications: true
            assignedEnvironmentsCount: 7
            beginsAt: 2000-01-23T04:56:07.000+00:00
            replacedByLicense:
              id: id
            id: id
            replacesLicense:
              id: id
            authorize:
              allowApiAccessManagement: true
              allowDynamicAuthorization: true
            status: null
          - gateways:
              allowLdapGateway: true
              allowRadiusGateway: true
              allowKerberosGateway: true
            package: package
            _links:
              key:
                href: https://openapi-generator.tech
            advancedServices:
              pingId:
                type: type
                included: true
            credentials:
              allowCredentials: true
            environments:
              allowConnections: true
              regions:
              - null
              - null
              allowAddResources: true
              max: 1
              allowCustomSchema: true
              allowProduction: true
              allowCustomDomain: true
            orchestrate:
              allowOrchestration: true
            mfa:
              allowFido2Devices: true
              allowVoiceOtp: true
              allowSmsOtp: true
              allowEmailOtp: true
              allowPushNotification: true
              allowTotp: true
              allowNotificationOutsideWhitelist: true
            expiresAt: 2000-01-23T04:56:07.000+00:00
            users:
              allowUpdateSelf: true
              allowPasswordPolicy: true
              max: 4
              allowMyAccount: true
              allowPasswordOnlyAuthentication: true
              allowRoleAssignment: true
              entitledToSupport: true
              annualActiveIncluded: 9
              allowPasswordManagement: true
              allowIdentityProviders: true
              allowInboundProvisioning: true
              allowVerificationFlow: true
              monthlyActiveIncluded: 9
              allowProvisioning: true
              hardLimitMax: 5
              allowPasswordManagementNotifications: true
            intelligence:
              allowReputation: true
              allowRisk: true
              allowDataConsent: true
              allowGeoVelocity: true
              allowAnonymousNetworkDetection: true
              allowAdvancedPredictors: true
            fraud:
              allowBotMaliciousDeviceDetection: true
              allowAccountProtection: true
            organization:
              id: id
            terminatesAt: 2000-01-23T04:56:07.000+00:00
            name: name
            verify:
              allowDocumentMatch: true
              allowManualIdInspection: true
              allowFaceMatch: true
              allowPushNotifications: true
            assignedEnvironmentsCount: 7
            beginsAt: 2000-01-23T04:56:07.000+00:00
            replacedByLicense:
              id: id
            id: id
            replacesLicense:
              id: id
            authorize:
              allowApiAccessManagement: true
              allowDynamicAuthorization: true
            status: null
          certificates:
          - customCRL: customCRL
            serialNumber: 5
            _links:
              key:
                href: https://openapi-generator.tech
            issuerDN: issuerDN
            expiresAt: 2000-01-23T04:56:07.000+00:00
            signatureAlgorithm: null
            validityPeriod: 1
            createdAt: 2000-01-23T04:56:07.000+00:00
            default: true
            environment:
              id: id
            keyLength: 5
            organization:
              id: id
            name: name
            startsAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            status: null
            subjectDN: subjectDN
            usageType: null
          - customCRL: customCRL
            serialNumber: 5
            _links:
              key:
                href: https://openapi-generator.tech
            issuerDN: issuerDN
            expiresAt: 2000-01-23T04:56:07.000+00:00
            signatureAlgorithm: null
            validityPeriod: 1
            createdAt: 2000-01-23T04:56:07.000+00:00
            default: true
            environment:
              id: id
            keyLength: 5
            organization:
              id: id
            name: name
            startsAt: 2000-01-23T04:56:07.000+00:00
            id: id
            algorithm: null
            status: null
            subjectDN: subjectDN
            usageType: null
          rateLimitIpConfigs:
          - createdAt: 2000-01-23T04:56:07.000+00:00
            id: id
            type: null
            value: value
            updatedAt: 2000-01-23T04:56:07.000+00:00
          - createdAt: 2000-01-23T04:56:07.000+00:00
            id: id
            type: null
            value: value
            updatedAt: 2000-01-23T04:56:07.000+00:00
          contents:
          - null
          - null
          versions:
          - null
          - null
          plans:
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            id: id
            status: null
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            id: id
            status: null
          schemas:
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            description: description
            attributes:
            - schema:
                id: id
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              type: null
              enumeratedValues:
              - archived: true
                description: description
                value: value
              - archived: true
                description: description
                value: value
              enabled: true
              required: true
              subAttributes:
              - null
              - null
              regexValidation:
                valuesPatternShouldNotMatch:
                - valuesPatternShouldNotMatch
                - valuesPatternShouldNotMatch
                requirements: requirements
                valuesPatternShouldMatch:
                - valuesPatternShouldMatch
                - valuesPatternShouldMatch
                pattern: pattern
              environment:
                id: id
              unique: true
              name: name
              schemaType: null
              id: id
              ldapAttribute: ldapAttribute
              multiValued: true
            - schema:
                id: id
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              type: null
              enumeratedValues:
              - archived: true
                description: description
                value: value
              - archived: true
                description: description
                value: value
              enabled: true
              required: true
              subAttributes:
              - null
              - null
              regexValidation:
                valuesPatternShouldNotMatch:
                - valuesPatternShouldNotMatch
                - valuesPatternShouldNotMatch
                requirements: requirements
                valuesPatternShouldMatch:
                - valuesPatternShouldMatch
                - valuesPatternShouldMatch
                pattern: pattern
              environment:
                id: id
              unique: true
              name: name
              schemaType: null
              id: id
              ldapAttribute: ldapAttribute
              multiValued: true
            id: id
            allowsContainsOperator: true
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            description: description
            attributes:
            - schema:
                id: id
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              type: null
              enumeratedValues:
              - archived: true
                description: description
                value: value
              - archived: true
                description: description
                value: value
              enabled: true
              required: true
              subAttributes:
              - null
              - null
              regexValidation:
                valuesPatternShouldNotMatch:
                - valuesPatternShouldNotMatch
                - valuesPatternShouldNotMatch
                requirements: requirements
                valuesPatternShouldMatch:
                - valuesPatternShouldMatch
                - valuesPatternShouldMatch
                pattern: pattern
              environment:
                id: id
              unique: true
              name: name
              schemaType: null
              id: id
              ldapAttribute: ldapAttribute
              multiValued: true
            - schema:
                id: id
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              type: null
              enumeratedValues:
              - archived: true
                description: description
                value: value
              - archived: true
                description: description
                value: value
              enabled: true
              required: true
              subAttributes:
              - null
              - null
              regexValidation:
                valuesPatternShouldNotMatch:
                - valuesPatternShouldNotMatch
                - valuesPatternShouldNotMatch
                requirements: requirements
                valuesPatternShouldMatch:
                - valuesPatternShouldMatch
                - valuesPatternShouldMatch
                pattern: pattern
              environment:
                id: id
              unique: true
              name: name
              schemaType: null
              id: id
              ldapAttribute: ldapAttribute
              multiValued: true
            id: id
            allowsContainsOperator: true
          organizations:
          - createdAt: createdAt
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            billingConnections:
            - id: id
            - id: id
            description: description
            id: id
            type: null
            updatedAt: updatedAt
          - createdAt: createdAt
            _links:
              key:
                href: https://openapi-generator.tech
            name: name
            billingConnections:
            - id: id
            - id: id
            description: description
            id: id
            type: null
            updatedAt: updatedAt
          groupMemberships:
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            _embedded:
              group:
                sourceId: sourceId
                _links:
                  key:
                    href: https://openapi-generator.tech
                displayName: displayName
                description: description
                externalId: externalId
                customData: "{}"
                population:
                  id: id
                directMemberCounts:
                  users: 7
                environment:
                  id: id
                sourceType: null
                name: name
                userFilter: userFilter
                id: id
                totalMemberCounts:
                  users: 1
            name: name
            id: id
            type: null
          - environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            _embedded:
              group:
                sourceId: sourceId
                _links:
                  key:
                    href: https://openapi-generator.tech
                displayName: displayName
                description: description
                externalId: externalId
                customData: "{}"
                population:
                  id: id
                directMemberCounts:
                  users: 7
                environment:
                  id: id
                sourceType: null
                name: name
                userFilter: userFilter
                id: id
                totalMemberCounts:
                  users: 1
            name: name
            id: id
            type: null
          attributes:
          - null
          - null
          scopes:
          - createdAt: 2000-01-23T04:56:07.000+00:00
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            resource:
              id: id
            name: name
            description: description
            enableMappedClaims: true
            id: id
            mappedClaims:
            - mappedClaims
            - mappedClaims
            schemaAttributes:
            - schemaAttributes
            - schemaAttributes
            updatedAt: 2000-01-23T04:56:07.000+00:00
          - createdAt: 2000-01-23T04:56:07.000+00:00
            environment:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            resource:
              id: id
            name: name
            description: description
            enableMappedClaims: true
            id: id
            mappedClaims:
            - mappedClaims
            - mappedClaims
            schemaAttributes:
            - schemaAttributes
            - schemaAttributes
            updatedAt: 2000-01-23T04:56:07.000+00:00
          actions:
          - null
          - null
          integrations:
          - thirdParty:
              companyName: companyName
              products:
              - products
              - products
            createdAt: 2000-01-23T04:56:07.000+00:00
            marketingLandingPageUrl: marketingLandingPageUrl
            name: name
            description: description
            logo:
              href: href
              id: id
            publisher: publisher
            categories:
            - categories
            - categories
            id: id
            pingProductNames:
            - null
            - null
            tags:
            - null
            - null
          - thirdParty:
              companyName: companyName
              products:
              - products
              - products
            createdAt: 2000-01-23T04:56:07.000+00:00
            marketingLandingPageUrl: marketingLandingPageUrl
            name: name
            description: description
            logo:
              href: href
              id: id
            publisher: publisher
            categories:
            - categories
            - categories
            id: id
            pingProductNames:
            - null
            - null
            tags:
            - null
            - null
          populations:
          - preferredLanguage: preferredLanguage
            passwordPolicy:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            description: description
            createdAt: createdAt
            alternativeIdentifiers:
            - alternativeIdentifiers
            - alternativeIdentifiers
            default: true
            environment:
              id: id
            userCount: 5
            name: name
            theme:
              id: id
            id: id
            updatedAt: updatedAt
          - preferredLanguage: preferredLanguage
            passwordPolicy:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            description: description
            createdAt: createdAt
            alternativeIdentifiers:
            - alternativeIdentifiers
            - alternativeIdentifiers
            default: true
            environment:
              id: id
            userCount: 5
            name: name
            theme:
              id: id
            id: id
            updatedAt: updatedAt
          forms:
          - components:
              fields:
              - null
              - null
            _links:
              key:
                href: https://openapi-generator.tech
            created: 2000-01-23T04:56:07.000+00:00
            description: description
            markRequired: true
            environment:
              id: id
            markOptional: true
            translationMethod: null
            passwordAutoCompleteEnabled: false
            fieldTypes:
            - null
            - null
            textAutoCompleteEnabled: false
            name: name
            modified: 2000-01-23T04:56:07.000+00:00
            languageBundle:
              key: languageBundle
            id: id
            category: null
            cols: 3
          - components:
              fields:
              - null
              - null
            _links:
              key:
                href: https://openapi-generator.tech
            created: 2000-01-23T04:56:07.000+00:00
            description: description
            markRequired: true
            environment:
              id: id
            markOptional: true
            translationMethod: null
            passwordAutoCompleteEnabled: false
            fieldTypes:
            - null
            - null
            textAutoCompleteEnabled: false
            name: name
            modified: 2000-01-23T04:56:07.000+00:00
            languageBundle:
              key: languageBundle
            id: id
            category: null
            cols: 3
          gatewayInstances:
          - lastReportedAt: lastReportedAt
            responseTimeMillis: 4.145608029883936
            version:
              updateStatus: null
              versionNumber: versionNumber
            connected: true
            environment:
              id: id
            currentErrors:
            - currentErrors
            - currentErrors
            hostname: hostname
            operationsPerSecond: 2.027123023002322
            credential:
              id: id
            healthStatus: null
            initializedAt: initializedAt
            id: id
            busyPercentage: 3
            gateway:
              id: id
          - lastReportedAt: lastReportedAt
            responseTimeMillis: 4.145608029883936
            version:
              updateStatus: null
              versionNumber: versionNumber
            connected: true
            environment:
              id: id
            currentErrors:
            - currentErrors
            - currentErrors
            hostname: hostname
            operationsPerSecond: 2.027123023002322
            credential:
              id: id
            healthStatus: null
            initializedAt: initializedAt
            id: id
            busyPercentage: 3
            gateway:
              id: id
          applications:
          - null
          - null
        count: 4.258773108174356
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        _embedded:
          $ref: '#/components/schemas/EntityArray__embedded'
        count:
          type: number
        size:
          type: number
      type: object
    Environment:
      example:
        name: New-Env
        description: New environment description
        type: SANDBOX
        region: EU
        billOfMaterials:
          products:
            type: PING_ONE_BASE
            description: New environment product description
            console:
              href: https://example.com
        license:
          id: 34f0efac-21d9-4a17-8a35-196bb3362983
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        billOfMaterials:
          $ref: '#/components/schemas/BillOfMaterials'
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of the population.
          type: string
        hardDeletedAllowedAt:
          description: "The time when the soft-deleted Production environment (set\
            \ to `DELETE_PENDING` status) can be completely deleted (a hard delete).\
            \ When a soft-deleted environment is restored, this value is cleared."
          format: date-time
          readOnly: true
          type: string
        icon:
          description: "The URL referencing the image to use for the environment icon.\
            \ The supported image types are JPEG/JPG, PNG, and GIF."
          type: string
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        license:
          $ref: '#/components/schemas/Environment_license'
        name:
          description: "A string that specifies the environment name, which must be\
            \ provided and must be unique within an organization."
          type: string
        organization:
          $ref: '#/components/schemas/Environment_organization'
        region:
          $ref: '#/components/schemas/Environment_region'
        softDeletedAt:
          description: "The time the Production environment was set to the `DELETE_PENDING`\
            \ status. When a soft-deleted environment is restored, this value is cleared."
          format: date-time
          readOnly: true
          type: string
        status:
          $ref: '#/components/schemas/EnumEnvironmentStatus'
        type:
          $ref: '#/components/schemas/EnumEnvironmentType'
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
      required:
      - license
      - name
      - region
      - type
      type: object
    EnvironmentStatus:
      example:
        license:
          id: id
        status: null
      properties:
        status:
          $ref: '#/components/schemas/EnumEnvironmentStatus'
        license:
          $ref: '#/components/schemas/EnvironmentStatus_license'
      required:
      - status
      type: object
    FlowPolicy:
      example:
        environment:
          id: id
        application:
          name: name
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        id: id
        trigger:
          type: null
        enabled: true
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: The flow policy resource's unique identifier.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        application:
          $ref: '#/components/schemas/FlowPolicy_application'
        enabled:
          description: A boolean that specifies whether the flow policy is enabled.
          readOnly: true
          type: boolean
        name:
          description: The flow policy resource name.
          readOnly: true
          type: string
        trigger:
          $ref: '#/components/schemas/FlowPolicy_trigger'
      type: object
    FlowPolicyAssignment:
      example:
        environment:
          id: id
        application:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        id: id
        flowPolicy:
          id: id
        priority: 1
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the flow policy assignment resource's
            unique identifier.
          readOnly: true
          type: string
        application:
          $ref: '#/components/schemas/ObjectApplication'
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        flowPolicy:
          $ref: '#/components/schemas/FlowPolicyAssignment_flowPolicy'
        priority:
          description: The order in which the policy referenced by this assignment
            is evaluated during an authentication flow relative to other policies.
            An assignment with a lower priority will be evaluated first.
          minimum: 1
          type: integer
      required:
      - flowPolicy
      - priority
      type: object
    Form:
      example:
        components:
          fields:
          - null
          - null
        _links:
          key:
            href: https://openapi-generator.tech
        created: 2000-01-23T04:56:07.000+00:00
        description: description
        markRequired: true
        environment:
          id: id
        markOptional: true
        translationMethod: null
        passwordAutoCompleteEnabled: false
        fieldTypes:
        - null
        - null
        textAutoCompleteEnabled: false
        name: name
        modified: 2000-01-23T04:56:07.000+00:00
        languageBundle:
          key: languageBundle
        id: id
        category: null
        cols: 3
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        created:
          description: The date the resouce was created (ISO-8061 format).
          format: date-time
          readOnly: true
          type: string
        category:
          $ref: '#/components/schemas/EnumFormCategory'
        cols:
          description: An integer that specifies the number of columns in the form
            (min = 1; max = 4).
          maximum: 4
          minimum: 1
          type: integer
        components:
          $ref: '#/components/schemas/FormComponents'
        description:
          description: A string that specifies the description of the form.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        fieldTypes:
          description: A read-only object that specifies the list of the FormField
            types in the form.
          items:
            $ref: '#/components/schemas/EnumFormFieldType'
          readOnly: true
          type: array
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        languageBundle:
          additionalProperties:
            type: string
          description: "An object that provides a map of i18n keys to their translations.\
            \ This object includes both the keys and their default translations. The\
            \ PingOne language management service finds this object, and creates the\
            \ new keys for translation for this form."
          type: object
        markOptional:
          description: A boolean that specifies whether optional fields are highlighted
            in the rendered form.
          type: boolean
        markRequired:
          description: A boolean that specifies whether required fields are highlighted
            in the rendered form.
          type: boolean
        modified:
          description: The date the resouce was modified (ISO-8061 format).
          format: date-time
          readOnly: true
          type: string
        name:
          description: "A string that specifies the form name, which must be provided\
            \ and must be unique within an environment."
          type: string
        passwordAutoCompleteEnabled:
          default: false
          description: A boolean that specifies whether the password auto-complete
            feature is enabled.
          type: boolean
        textAutoCompleteEnabled:
          default: false
          description: A boolean that specifies whether the text auto-complete feature
            is enabled.
          type: boolean
        translationMethod:
          $ref: '#/components/schemas/EnumFormTranslationMethod'
      required:
      - category
      - components
      - markOptional
      - markRequired
      - name
      type: object
    FormComponents:
      example:
        fields:
        - null
        - null
      properties:
        fields:
          items:
            $ref: '#/components/schemas/FormField'
          type: array
      required:
      - fields
      type: object
    FormElement:
      properties:
        attributeDisabled:
          description: A boolean that specifies whether the linked directory attribute
            is disabled.
          readOnly: true
          type: boolean
        key:
          description: A string that specifies an identifier for the field component.
          type: string
        label:
          description: A string of escaped JSON that is designed to store a series
            of text and translatable keys.
          type: string
        labelMode:
          $ref: '#/components/schemas/EnumFormElementLabelMode'
        required:
          description: A boolean that specifies whether the field is required.
          type: boolean
        otherOptionEnabled:
          description: A boolean that specifies whether the end user can type an entry
            that is not in a predefined list.
          type: boolean
        otherOptionKey:
          description: A string that specifies whether the form identifies that the
            choice is a custom choice not from a predefined list.
          type: string
        otherOptionLabel:
          description: A string that specifies the label for a custom or "other" choice
            in a list.
          type: string
        otherOptionInputLabel:
          description: A string that specifies the label for the other option in drop-down
            controls.
          type: string
        otherOptionAttributeDisabled:
          description: A boolean that specifies whether the directory attribute option
            is disabled. Set to true if it references a PingOne directory attribute.
          type: boolean
      required:
      - key
      - label
      type: object
    FormElementOption:
      properties:
        label:
          description: A string that specifies the label shown to the end user for
            this option.
          type: string
        value:
          description: A string that specifies the value of the field if this option
            is selected.
          type: string
      required:
      - label
      - value
      type: object
    FormElementValidation:
      description: An object containing validation data for the field. This is a required
        property when the type is `TEXT`.
      properties:
        regex:
          description: A string that specifies a validation regular expression. The
            expression must be a valid regular expression string. This is a required
            property when the validation type is `CUSTOM`.
          type: string
        type:
          $ref: '#/components/schemas/EnumFormElementValidationType'
        errorMessage:
          description: A string that specifies the error message to be displayed when
            the field validation fails.
          type: string
      type: object
    FormElementPasswordVerify:
      properties:
        labelPasswordVerify:
          description: "A string that when a second field for verifies password is\
            \ used, this poperty specifies the field label for that verify field."
          type: string
      type: object
    FormField:
      discriminator:
        mapping:
          TEXT: '#/components/schemas/FormFieldText'
          PASSWORD: '#/components/schemas/FormFieldPassword'
          PASSWORD_VERIFY: '#/components/schemas/FormFieldPasswordVerify'
          PHONE_NUMBER: '#/components/schemas/FormFieldPhoneNumber'
          RADIO: '#/components/schemas/FormFieldRadio'
          CHECKBOX: '#/components/schemas/FormFieldCheckbox'
          DROPDOWN: '#/components/schemas/FormFieldDropdown'
          COMBOBOX: '#/components/schemas/FormFieldCombobox'
          DIVIDER: '#/components/schemas/FormFieldDivider'
          EMPTY_FIELD: '#/components/schemas/FormFieldEmptyField'
          SLATE_TEXTBLOB: '#/components/schemas/FormFieldSlateTextblob'
          SUBMIT_BUTTON: '#/components/schemas/FormFieldSubmitButton'
          ERROR_DISPLAY: '#/components/schemas/FormFieldErrorDisplay'
          FLOW_LINK: '#/components/schemas/FormFieldFlowLink'
          FLOW_BUTTON: '#/components/schemas/FormFieldFlowButton'
          RECAPTCHA_V2: '#/components/schemas/FormFieldRecaptchaV2'
          QR_CODE: '#/components/schemas/FormFieldQrCode'
          SOCIAL_LOGIN_BUTTON: '#/components/schemas/FormFieldSocialLoginButton'
          DEVICE_REGISTRATION: '#/components/schemas/FormFieldDeviceRegistration'
          DEVICE_AUTHENTICATION: '#/components/schemas/FormFieldDeviceAuthentication'
          POLLING: '#/components/schemas/FormFieldPolling'
          FIDO2: '#/components/schemas/FormFieldFIDO2'
          SINGLE_CHECKBOX: '#/components/schemas/FormFieldSingleCheckbox'
          AGREEMENT: '#/components/schemas/FormFieldFormAgreement'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/FormFieldText'
      - $ref: '#/components/schemas/FormFieldPassword'
      - $ref: '#/components/schemas/FormFieldPasswordVerify'
      - $ref: '#/components/schemas/FormFieldPhoneNumber'
      - $ref: '#/components/schemas/FormFieldRadio'
      - $ref: '#/components/schemas/FormFieldCheckbox'
      - $ref: '#/components/schemas/FormFieldDropdown'
      - $ref: '#/components/schemas/FormFieldCombobox'
      - $ref: '#/components/schemas/FormFieldDivider'
      - $ref: '#/components/schemas/FormFieldEmptyField'
      - $ref: '#/components/schemas/FormFieldSlateTextblob'
      - $ref: '#/components/schemas/FormFieldSubmitButton'
      - $ref: '#/components/schemas/FormFieldErrorDisplay'
      - $ref: '#/components/schemas/FormFieldFlowLink'
      - $ref: '#/components/schemas/FormFieldFlowButton'
      - $ref: '#/components/schemas/FormFieldRecaptchaV2'
      - $ref: '#/components/schemas/FormFieldQrCode'
      - $ref: '#/components/schemas/FormFieldSocialLoginButton'
      - $ref: '#/components/schemas/FormFieldDeviceRegistration'
      - $ref: '#/components/schemas/FormFieldDeviceAuthentication'
      - $ref: '#/components/schemas/FormFieldPolling'
      - $ref: '#/components/schemas/FormFieldFIDO2'
      - $ref: '#/components/schemas/FormFieldSingleCheckbox'
      - $ref: '#/components/schemas/FormFieldFormAgreement'
    FormFieldCommon:
      properties:
        type:
          $ref: '#/components/schemas/EnumFormFieldType'
        position:
          $ref: '#/components/schemas/FormFieldCommon_position'
        visibility:
          $ref: '#/components/schemas/FormFieldCommon_visibility'
      required:
      - position
      - type
      type: object
    FormFieldText:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        required:
        - validation
        type: object
    FormFieldPassword:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          showPasswordRequirements:
            description: A boolean that specifies whether the password requirements
              are displayed.
            type: boolean
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        type: object
    FormFieldPasswordVerify:
      allOf:
      - $ref: '#/components/schemas/FormFieldPassword'
      - $ref: '#/components/schemas/FormElementPasswordVerify'
    FormFieldPhoneNumber:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          defaultCountryCode:
            description: The country code to default the country code selection field
              to (two character country code).
            type: string
          countryCodeLabel:
            description: Label for the country code field.
            type: string
          validatePhoneNumber:
            description: Whether to validate the phone number input.
            type: boolean
          showExtension:
            description: Whether to show an extension field.
            type: boolean
          extensionLabel:
            description: Label for the extension field. This is required and must
              not be blank if showExtension is true.
            type: string
        type: object
    FormFieldRadio:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        required:
        - layout
        - options
        type: object
    FormFieldCheckbox:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        required:
        - layout
        - options
        type: object
    FormFieldDropdown:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        required:
        - options
        type: object
    FormFieldCombobox:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - properties:
          layout:
            $ref: '#/components/schemas/EnumFormElementLayout'
          options:
            description: "An array of objects (label/value pairs) that specifies the\
              \ unique list of options. This is a required property when the type\
              \ is `RADIO`, `CHECKBOX`, or `DROPDOWN`."
            items:
              $ref: '#/components/schemas/FormElementOption'
            type: array
          validation:
            $ref: '#/components/schemas/FormElementValidation'
        required:
        - options
        type: object
    FormFieldDivider:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormItem'
    FormFieldPolling:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormPolling'
    FormFieldEmptyField:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormItem'
    FormFieldSlateTextblob:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormItem'
      - $ref: '#/components/schemas/FormItemWithIcon'
    FormFieldSubmitButton:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormSubmit'
    FormFieldErrorDisplay:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormItem'
    FormFieldFlowLink:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormLinkCustom'
    FormFieldFlowButton:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormFlowButton'
    FormFieldRecaptchaV2:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormRecaptchaV2'
    FormFieldQrCode:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormQrCode'
    FormFieldFIDO2:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormFIDO2'
    FormFieldSingleCheckbox:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormElement'
      - $ref: '#/components/schemas/FormSingleCheckbox'
    FormFieldFormAgreement:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormAgreement'
    FormFieldSocialLoginButton:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormSocialLoginButton'
    FormFieldDeviceRegistration:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          label:
            description: Label for the device registration field.
            type: string
          options:
            description: List of devices available for registration. Must not be empty.
            items:
              $ref: '#/components/schemas/RegistrationDevice'
            type: array
          required:
            description: Whether the field is required or not.
            type: boolean
        required:
        - label
        - options
        type: object
    FormFieldDeviceAuthentication:
      allOf:
      - $ref: '#/components/schemas/FormFieldCommon'
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          label:
            description: Label for the device authentication field.
            type: string
          options:
            description: List of devices available for authentication. Must not be
              empty.
            items:
              $ref: '#/components/schemas/AuthenticationDevice'
            type: array
          required:
            description: Whether the field is required or not.
            type: boolean
        required:
        - label
        - options
        type: object
    FormFieldWithKey:
      properties:
        key:
          description: A string that specifies an identifier for the field component.
          type: string
      required:
      - key
      type: object
    FormFlowButton:
      properties:
        key:
          description: A string that specifies the field content.
          type: string
        label:
          description: A string that specifies the button label.
          type: string
        styles:
          $ref: '#/components/schemas/FormFlowButton_styles'
      required:
      - key
      - label
      type: object
    FormLinkCustom:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          label:
            description: A string that specifies the link label.
            type: string
          styles:
            $ref: '#/components/schemas/FormLinkCustom_allOf_styles'
        required:
        - key
        - label
        type: object
    FormItem:
      properties:
        content:
          description: A string that specifies the field content.
          type: string
      type: object
    FormItemWithOptionalKey:
      properties:
        key:
          description: A string that specifies the field content.
          type: string
      type: object
    FormItemWithIcon:
      allOf:
      - $ref: '#/components/schemas/FormItemWithOptionalKey'
      - properties:
          icon:
            $ref: '#/components/schemas/FormItemWithIcon_allOf_icon'
        type: object
    RegistrationDevice:
      properties:
        type:
          $ref: '#/components/schemas/EnumFormRegistrationDeviceType'
        title:
          description: Title for the device.
          type: string
        description:
          description: Description for the device (Max 1000 characters).
          maxLength: 1000
          type: string
        iconSrc:
          description: Icon image source to display for the device (Max 500 characters).
          maxLength: 500
          type: string
      required:
      - title
      - type
      type: object
    AuthenticationDevice:
      properties:
        type:
          $ref: '#/components/schemas/EnumFormAuthenticationDeviceType'
        title:
          description: Title for the device.
          type: string
        description:
          description: Description for the device (Max 1000 characters).
          maxLength: 1000
          type: string
        iconSrc:
          description: Icon image source to display for the device (Max 500 characters).
          maxLength: 500
          type: string
      required:
      - title
      - type
      type: object
    FormFIDO2:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          trigger:
            $ref: '#/components/schemas/EnumFormFIDO2Trigger'
          action:
            $ref: '#/components/schemas/EnumFormFIDO2Action'
          label:
            description: A string that specifies the text label for the FIDO2 button.
            type: string
        required:
        - action
        - label
        - trigger
        type: object
    FormPolling:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          pollingAppearance:
            $ref: '#/components/schemas/EnumFormPollingAppearance'
          size:
            $ref: '#/components/schemas/EnumFormItemSize'
        required:
        - pollingAppearance
        - size
        type: object
    FormSingleCheckbox:
      properties:
        appearance:
          $ref: '#/components/schemas/EnumFormSingleCheckboxAppearance'
        errorMessage:
          description: A string that specifies the message to display if validation
            fails.
          type: string
        inputType:
          $ref: '#/components/schemas/EnumFormSingleCheckboxInputType'
      required:
      - appearance
      - inputType
      type: object
    FormAgreement:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          inputType:
            $ref: '#/components/schemas/EnumFormAgreementInputType'
          titleEnabled:
            description: Specifies whether the title is enabled.
            type: boolean
          agreement:
            $ref: '#/components/schemas/FormAgreement_allOf_agreement'
        required:
        - inputType
        - titleEnabled
        type: object
    FormRecaptchaV2:
      properties:
        size:
          $ref: '#/components/schemas/EnumFormRecaptchaV2Size'
        theme:
          $ref: '#/components/schemas/EnumFormRecaptchaV2Theme'
        alignment:
          $ref: '#/components/schemas/EnumFormItemAlignment'
      required:
      - alignment
      - size
      - theme
      type: object
    FormStyles:
      properties:
        alignment:
          $ref: '#/components/schemas/EnumFormItemAlignment'
        backgroundColor:
          description: A string that specifies the button background color. The value
            must be a valid hexadecimal color.
          type: string
        textColor:
          description: A string that specifies the button text color. The value must
            be a valid hexadecimal color.
          type: string
        borderColor:
          description: A string that specifies the button border color. The value
            must be a valid hexadecimal color.
          type: string
        enabled:
          description: A boolean that specifies whether the button is enabled.
          type: boolean
        height:
          type: integer
        padding:
          $ref: '#/components/schemas/FormStylesPadding'
        width:
          description: An integer that specifies the button width. Set as a percentage.
          type: integer
        widthUnit:
          $ref: '#/components/schemas/EnumFormStylesWidthUnit'
      type: object
    FormStylesPadding:
      properties:
        top:
          type: integer
        bottom:
          type: integer
        left:
          type: integer
        right:
          type: integer
      type: object
    FormSocialLoginButton:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          idpName:
            description: A string that specifies the external identity provider name.
            type: string
          idpType:
            $ref: '#/components/schemas/EnumFormSocialLoginIdpType'
          idpId:
            description: A string that specifies the external identity provider's
              ID.
            type: string
          idpEnabled:
            description: A boolean that specifies whether the external identity provider
              is enabled.
            type: boolean
          iconSrc:
            description: A string that specifies the icon image URL to be displayed
              on the button.
            type: string
          label:
            description: A string that specifies the social login button label.
            type: string
          styles:
            $ref: '#/components/schemas/FormSocialLoginButton_allOf_styles'
        required:
        - idpId
        - idpName
        - idpType
        - label
        type: object
    FormSubmit:
      properties:
        label:
          description: A string that specifies the button label.
          type: string
        styles:
          $ref: '#/components/schemas/FormFlowButton_styles'
      required:
      - label
      type: object
    FormQrCode:
      allOf:
      - $ref: '#/components/schemas/FormFieldWithKey'
      - properties:
          alignment:
            $ref: '#/components/schemas/EnumFormItemAlignment'
          size:
            $ref: '#/components/schemas/EnumFormItemSize'
          fallbackText:
            description: A string that specifies the text label for fallback under
              the QR code.
            type: string
        required:
        - alignment
        - size
        type: object
    Gateway:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the instance ID of the gateway. The
            gateway instance ID is created by the gateway when it starts up.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        credentials:
          items:
            $ref: '#/components/schemas/GatewayCredential'
          readOnly: true
          type: array
        name:
          description: "A string that specifies the resource name, which must be provided\
            \ and must be unique within an environment. Valid characters are any Unicode\
            \ letter, mark, numeric character, forward slash, dot, apostrophe, underscore,\
            \ space, or hyphen."
          type: string
        description:
          description: A string that specifies the description of the resource.
          type: string
        type:
          $ref: '#/components/schemas/EnumGatewayType'
        enabled:
          description: A boolean that specifies whether the gateway is enabled. This
            is a required property.
          type: boolean
        supportedVersions:
          description: "An array that lists the LDAP gateway versions associated with\
            \ this gateway resource. This information is returned on a GET {{apiPath}}/environments/{{environmentID}}/gateways\
            \ request, and it is used to trigger alerts if the gateway tries to connect\
            \ with an unsupported version (or a version that is not the latest or\
            \ recommended version)."
          items:
            $ref: '#/components/schemas/Gateway_supportedVersions_inner'
          readOnly: true
          type: array
        currentAlerts:
          items:
            type: object
          readOnly: true
          type: array
      required:
      - enabled
      - name
      - type
      type: object
    GatewayTypeLDAP:
      allOf:
      - $ref: '#/components/schemas/Gateway'
      - properties:
          bindDN:
            description: "A string that specifies the distinguished name information\
              \ to bind to the LDAP database (for example, uid=pingone,dc=example,dc=com)."
            type: string
          bindPassword:
            description: A string that specifies the bind password for the LDAP database.
              This is a required property.
            format: password
            type: string
          connectionSecurity:
            $ref: '#/components/schemas/EnumGatewayTypeLDAPSecurity'
          kerberos:
            $ref: '#/components/schemas/GatewayTypeLDAP_allOf_kerberos'
          serversHostAndPort:
            description: "An array of strings that specifies the LDAP server host\
              \ name and port number (for example, [`ds1.example.com:389`, `ds2.example.com:389`])."
            items:
              type: string
            type: array
          userTypes:
            description: An array of the userTypes properties for the users to be
              provisioned in PingOne. userTypes specifies which user properties in
              PingOne correspond to the user properties in an external LDAP directory.
              You can use an LDAP browser to view the user properties in the external
              LDAP directory.
            items:
              $ref: '#/components/schemas/GatewayTypeLDAP_allOf_userTypes'
            type: array
          validateTlsCertificates:
            description: "A boolean that specifies whether or not to trust all SSL\
              \ certificates (defaults to true). If this value is false, TLS certificates\
              \ are not validated. When the value is set to true, only certificates\
              \ that are signed by the default JVM CAs, or the CA certs that the customer\
              \ has uploaded to the certificate service are trusted."
            type: boolean
          vendor:
            $ref: '#/components/schemas/EnumGatewayVendor'
          followReferrals:
            readOnly: true
            type: boolean
        required:
        - bindDN
        - bindPassword
        - serversHostAndPort
        - vendor
        type: object
    GatewayTypeRADIUS:
      allOf:
      - $ref: '#/components/schemas/Gateway'
      - properties:
          davinci:
            $ref: '#/components/schemas/GatewayTypeRADIUS_allOf_davinci'
          defaultSharedSecret:
            description: Value to use for the shared secret if the shared secret is
              not provided for one or more of the RADIUS clients specified.
            format: password
            type: string
          networkPolicyServer:
            $ref: '#/components/schemas/GatewayTypeRADIUS_allOf_networkPolicyServer'
          radiusClients:
            description: Collection of RADIUS clients.
            items:
              $ref: '#/components/schemas/GatewayTypeRADIUS_allOf_radiusClients'
            type: array
        required:
        - davinci
        - radiusClients
        type: object
    GatewayCredential:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        credential: credential
        lastUsedAt: 2000-01-23T04:56:07.000+00:00
        id: id
      properties:
        id:
          description: A string that specifies the auto-generated ID for this credential.
            This is the JWT's jti claim. This is a required property.
          readOnly: true
          type: string
        createdAt:
          description: A date that specifies the date the credential was created in
            Coordinated Universal Time (UTC). This is a required property.
          format: date-time
          readOnly: true
          type: string
        lastUsedAt:
          description: A date that specifies the date the credential was last used
            in UTC. This is a required property.
          format: date-time
          readOnly: true
          type: string
        credential:
          description: A string that specifies the signed JWT for the gateway credential.
            This property is present only when the gateway credential is created.
          format: password
          readOnly: true
          type: string
      type: object
    GatewayInstance:
      example:
        lastReportedAt: lastReportedAt
        responseTimeMillis: 4.145608029883936
        version:
          updateStatus: null
          versionNumber: versionNumber
        connected: true
        environment:
          id: id
        currentErrors:
        - currentErrors
        - currentErrors
        hostname: hostname
        operationsPerSecond: 2.027123023002322
        credential:
          id: id
        healthStatus: null
        initializedAt: initializedAt
        id: id
        busyPercentage: 3
        gateway:
          id: id
      properties:
        connected:
          description: A boolean that specifies whether or not the gateway instance
            has one or more connections. This is a required property.
          type: boolean
        id:
          description: A string that specifies the instance ID of the gateway. The
            gateway instance ID is created by the gateway when it starts up.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        gateway:
          $ref: '#/components/schemas/GatewayInstance_gateway'
        credential:
          $ref: '#/components/schemas/GatewayInstance_credential'
        currentErrors:
          description: An array of strings that lists the messages that are maintained
            by the gateway instance.
          items:
            type: string
          type: array
        healthStatus:
          $ref: '#/components/schemas/EnumHealthStatus'
        hostname:
          description: A string that specifies the hostname of the container running
            in the customer’s infrastructure. This is a required property.
          type: string
        initializedAt:
          description: A timestamp that specifies when gateway was initialized (when
            the first connect to PingOne was made).
          type: string
        lastReportedAt:
          description: "A timestamp that specifies the last reported timestamp, heartbeat,\
            \ or other message."
          type: string
        version:
          $ref: '#/components/schemas/GatewayInstance_version'
        busyPercentage:
          description: "An integer that specifies the gateway instance's busy percentage.\
            \ When this percentage is high, then more instances should be added."
          type: integer
        operationsPerSecond:
          description: A number that specifies the recent throughput of the gateway
            instance.
          type: number
        responseTimeMillis:
          description: A number that specifies the processing time of the gateway
            instance in milliseconds.
          type: number
      type: object
    Group:
      example:
        sourceId: sourceId
        _links:
          key:
            href: https://openapi-generator.tech
        displayName: displayName
        description: description
        externalId: externalId
        customData: "{}"
        population:
          id: id
        directMemberCounts:
          users: 7
        environment:
          id: id
        sourceType: null
        name: name
        userFilter: userFilter
        id: id
        totalMemberCounts:
          users: 1
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: "The unique identifier for the group. Search all groups for\
            \ a specific group ID with a SCIM filter on GET /environments/{environmentID}/groups.\
            \ Retrieve all the group IDs associated with a user with GET /environments/{environmentID}/users/{userID}?include=memberOfGroupIDs."
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        displayName:
          description: "For external groups, set during user creation/update. For\
            \ groups created on PingOne, this parameter is identical to `name`."
          readOnly: true
          type: string
        population:
          $ref: '#/components/schemas/Group_population'
        name:
          description: "The group name. A group name can be reused across populations,\
            \ but the same user cannot belong to multiple groups with the same group\
            \ name. Population groups cannot share a group name with an environment\
            \ group. Search all groups for a specific group name with a SCIM filter\
            \ on GET /environments/{environmentID}/groups. Retrieve all the group\
            \ names associated with a user with GET /environments/{environmentID}/users/{userID}?include=memberOfGroupNames.\
            \ Use this operation to determine group membership in attribute mappings\
            \ for claims and assertions."
          type: string
        userFilter:
          description: "A SCIM filter that determines which users are dynamically\
            \ added to the group. For more information, see Adding users to a group\
            \ and Removing users from a group."
          type: string
        description:
          description: The group description.
          type: string
        externalId:
          description: "A user-defined identifier for the group. Use this propertry\
            \ to syncronize a group in PingOne with the same group in an external\
            \ system. PingOne does not directly use this property. Search all groups\
            \ for a specific external ID with a SCIM filter on GET /environments/{environmentID}/groups"
          type: string
        customData:
          description: Optional User-defined custom data.
          type: object
        sourceId:
          description: External groups only. Set during user creation/update.
          readOnly: true
          type: string
        sourceType:
          $ref: '#/components/schemas/EnumGroupSourceType'
        directMemberCounts:
          $ref: '#/components/schemas/Group_directMemberCounts'
        totalMemberCounts:
          $ref: '#/components/schemas/Group_totalMemberCounts'
      required:
      - name
      type: object
    GroupMembership:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        _embedded:
          group:
            sourceId: sourceId
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            externalId: externalId
            customData: "{}"
            population:
              id: id
            directMemberCounts:
              users: 7
            environment:
              id: id
            sourceType: null
            name: name
            userFilter: userFilter
            id: id
            totalMemberCounts:
              users: 1
        name: name
        id: id
        type: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        _embedded:
          $ref: '#/components/schemas/GroupMembership__embedded'
        id:
          description: ID of the group to assign
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        name:
          description: A string that specifies the group name assigned to the user.
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/EnumGroupMembershipType'
      required:
      - id
      type: object
    GroupNesting:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        id: id
        type: type
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: ID of the group to nest
          type: string
        type:
          description: The type of the group nesting
          readOnly: true
          type: string
      required:
      - id
      type: object
    IdentityPropagationPlan:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        id: id
        status: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: "The unique identifier for the group. Search all groups for\
            \ a specific group ID with a SCIM filter on GET /environments/{environmentID}/groups.\
            \ Retrieve all the group IDs associated with a user with GET /environments/{environmentID}/users/{userID}?include=memberOfGroupIDs."
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        name:
          description: Unique name of the propagation plan
          type: string
        status:
          $ref: '#/components/schemas/EnumIdentityPropagationPlanStatus'
      required:
      - name
      type: object
    IdentityProvider:
      oneOf:
      - $ref: '#/components/schemas/IdentityProviderFacebook'
      - $ref: '#/components/schemas/IdentityProviderClientIDClientSecret'
      - $ref: '#/components/schemas/IdentityProviderOIDC'
      - $ref: '#/components/schemas/IdentityProviderApple'
      - $ref: '#/components/schemas/IdentityProviderPaypal'
      - $ref: '#/components/schemas/IdentityProviderMicrosoft'
      - $ref: '#/components/schemas/IdentityProviderSAML'
    IdentityProviderAttribute:
      example:
        createdAt: createdAt
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        mappingType: null
        name: name
        update: null
        id: id
        value: value
        identityProvider:
          id: id
        updatedAt: updatedAt
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        mappingType:
          $ref: '#/components/schemas/EnumIdentityProviderAttributeMappingType'
        name:
          description: "The user attribute, which is unique per provider. The attribute\
            \ must not be defined as read only from the user schema or of type COMPLEX\
            \ based on the user schema. Valid examples username, and name.first. The\
            \ following attributes may not be used account, id, created, updated,\
            \ lifecycle, mfaEnabled, and enabled."
          type: string
        value:
          description: "A placeholder referring to the attribute (or attributes) from\
            \ the provider. Placeholders must be valid for the attributes returned\
            \ by the IdP type and use the ${} syntax (for example, username=`${email}`).\
            \ For SAML, any placeholder is acceptable, and it is mapped against the\
            \ attributes available in the SAML assertion after authentication. The\
            \ ${samlAssertion.subject} placeholder is a special reserved placeholder\
            \ used to refer to the subject name ID in the SAML assertion response."
          type: string
        update:
          $ref: '#/components/schemas/EnumIdentityProviderAttributeMappingUpdate'
        id:
          description: The unique identifier for the resource.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        identityProvider:
          $ref: '#/components/schemas/IdentityProviderAttribute_identityProvider'
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
      required:
      - name
      - update
      - value
      type: object
    IdentityProviderCommon:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        description:
          description: The description of the IdP.
          type: string
        enabled:
          description: The current enabled state of the IdP.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        icon:
          $ref: '#/components/schemas/IdentityProviderCommon_icon'
        id:
          description: The resource ID.
          readOnly: true
          type: string
        loginButtonIcon:
          $ref: '#/components/schemas/IdentityProviderCommon_loginButtonIcon'
        name:
          description: The name of the IdP.
          type: string
        registration:
          $ref: '#/components/schemas/IdentityProviderCommon_registration'
        type:
          $ref: '#/components/schemas/EnumIdentityProviderExt'
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
      required:
      - enabled
      - name
      - type
      type: object
    IdentityProviderFacebook:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          appId:
            description: A string that specifies the application ID from Facebook.
              This is a required property.
            type: string
          appSecret:
            description: A string that specifies the application secret from Facebook.
              This is a required property.
            format: password
            type: string
        required:
        - appId
        - appSecret
        type: object
    IdentityProviderClientIDClientSecret:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          clientId:
            description: A string that specifies the application ID from the provider.
              This is a required property.
            type: string
          clientSecret:
            description: A string that specifies the application secret from the provider.
              This is a required property.
            format: password
            type: string
        required:
        - clientId
        - clientSecret
        type: object
    IdentityProviderMicrosoft:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderClientIDClientSecret'
      - properties:
          tenantId:
            description: A string that specifies the tenant ID from Microsoft Entra
              ID. This property is required if Entra ID is enabled.
            type: string
        type: object
    IdentityProviderOIDC:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          authorizationEndpoint:
            description: A string that specifies the the OIDC identity provider's
              authorization endpoint. This value must be a URL that uses https. This
              is a required property.
            type: string
          clientId:
            description: A string that specifies the application ID from the OIDC
              identity provider. This is a required property.
            type: string
          clientSecret:
            description: A string that specifies the application secret from the OIDC
              identity provider. This is a required property.
            format: password
            type: string
          discoveryEndpoint:
            description: A string that specifies the OIDC identity provider's discovery
              endpoint. This value must be a URL that uses https.
            type: string
          issuer:
            description: A string that specifies the issuer to which the authentication
              is sent for the OIDC identity provider. This value must be a URL that
              uses https. This is a required property.
            type: string
          jwksEndpoint:
            description: A string that specifies the OIDC identity provider's jwks
              endpoint. This value must be a URL that uses https. This is a required
              property.
            type: string
          scopes:
            description: An array that specifies the scopes to include in the authentication
              request to the OIDC identity provider. This is a required property.
            items:
              type: string
            type: array
          tokenEndpoint:
            description: A string that specifies the OIDC identity provider's token
              endpoint. This is a required property.
            type: string
          tokenEndpointAuthMethod:
            $ref: '#/components/schemas/EnumIdentityProviderOIDCTokenAuthMethod'
          userInfoEndpoint:
            description: A string that specifies the OIDC identity provider's userInfo
              endpoint.
            type: string
          pkceMethod:
            $ref: '#/components/schemas/EnumIdentityProviderPKCEMethod'
        required:
        - authorizationEndpoint
        - clientId
        - clientSecret
        - issuer
        - jwksEndpoint
        - scopes
        - tokenEndpoint
        - tokenEndpointAuthMethod
        type: object
    IdentityProviderApple:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          clientId:
            description: A string that specifies the application ID from Apple. This
              is the identifier obtained after registering a services ID in the Apple
              developer portal. This is a required property.
            type: string
          clientSecretSigningKey:
            description: A string that specifies the private key that is used to generate
              a client secret. This is a required property.
            format: password
            type: string
          keyId:
            description: A 10-character string that Apple uses to identify an authentication
              key. This is a required property.
            type: string
          teamId:
            description: A 10-character string that Apple uses to identify teams.
              This is a required property.
            type: string
        required:
        - clientId
        - clientSecretSigningKey
        - keyId
        - teamId
        type: object
    IdentityProviderPaypal:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          clientId:
            description: A string that specifies the application ID from PayPal. This
              is a required property.
            type: string
          clientSecret:
            description: A string that specifies the application secret from PayPal.
              This is a required property.
            format: password
            type: string
          clientEnvironment:
            description: "A string that specifies the PayPal environment. Options\
              \ are sandbox, and live. This is a required property."
            type: string
        required:
        - clientEnvironment
        - clientId
        - clientSecret
        type: object
    IdentityProviderSAML:
      allOf:
      - $ref: '#/components/schemas/IdentityProviderCommon'
      - properties:
          authnRequestSigned:
            description: A boolean that specifies whether the SAML authentication
              request will be signed when sending to the identity provider. Set this
              to true if the external IDP is included in an authentication policy
              to be used by applications that are accessed using a mix of default
              URLS and custom Domains URLs.
            type: boolean
          idpEntityId:
            description: A string that specifies the entity ID URI that is checked
              against the issuerId tag in the incoming response.
            type: string
          idpVerification:
            $ref: '#/components/schemas/IdentityProviderSAML_allOf_idpVerification'
          spEntityId:
            description: "A string that specifies the service provider's entity ID,\
              \ used to look up the application."
            type: string
          spSigning:
            $ref: '#/components/schemas/IdentityProviderSAML_allOf_spSigning'
          ssoBinding:
            $ref: '#/components/schemas/EnumIdentityProviderSAMLSSOBinding'
          ssoEndpoint:
            description: A string that specifies the SSO endpoint for the authentication
              request.
            type: string
          sloBinding:
            $ref: '#/components/schemas/EnumIdentityProviderSAMLSLOBinding'
          sloEndpoint:
            description: "The logout endpoint URL. This is an optional property. However,\
              \ if a `sloEndpoint` logout endpoint URL is not defined, logout actions\
              \ result in an error."
            type: string
          sloResponseEndpoint:
            description: "The endpoint URL to submit the logout response. If a value\
              \ is not provided, the `sloEndpoint` property value is used to submit\
              \ SLO response."
            type: string
          sloWindow:
            description: "Defines how long PingOne can exchange logout messages with\
              \ the application, specifically a `LogoutRequest` from the application,\
              \ since the initial request. PingOne can also send a `LogoutRequest`\
              \ to the application when a single logout is initiated by the user from\
              \ other session participants, such as an application or identity provider.\
              \ This setting is per application. The SLO logout is separate from the\
              \ user session logout that revokes all tokens."
            type: integer
        required:
        - idpEntityId
        - idpVerification
        - spEntityId
        - ssoBinding
        - ssoEndpoint
        type: object
    Image:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        id: id
        targets:
          original:
            width: 0
            href: href
            id: id
            type: null
            height: 6
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        targets:
          $ref: '#/components/schemas/Image_targets'
      type: object
    Integration:
      example:
        thirdParty:
          companyName: companyName
          products:
          - products
          - products
        createdAt: 2000-01-23T04:56:07.000+00:00
        marketingLandingPageUrl: marketingLandingPageUrl
        name: name
        description: description
        logo:
          href: href
          id: id
        publisher: publisher
        categories:
        - categories
        - categories
        id: id
        pingProductNames:
        - null
        - null
        tags:
        - null
        - null
      properties:
        categories:
          description: "The list of categories used to classify the integration. Valid\
            \ strings include alphanumeric characters, underscore, hyphen, and space."
          items:
            type: string
          type: array
        createdAt:
          description: Creation date of the integration.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the integration in HTML to be used for the
            integration listing. You can use class and style attributes for inline
            styling. There's a 4000 character limit for the description.
          type: string
        id:
          description: The platform-generated ID of this integration.
          readOnly: true
          type: string
        logo:
          $ref: '#/components/schemas/Integration_logo'
        marketingLandingPageUrl:
          description: Absolute URL link to the marketing landing page.
          type: string
        name:
          description: Name of the integration.
          type: string
        pingProductNames:
          description: "The Ping product associated with the integration. Can include\
            \ `PINGID`, `PINGONE_ENTERPRISE`, `PINGONE`, `PINGACCESS`, `PINGFEDERATE`,\
            \ `PINGDIRECTORY`, `PINGDATAGOVERNANCE`, `PINGINTELLIGENCE_FOR_APIS` or\
            \ `PINGONE_ADVANCED_SERVICES`"
          items:
            $ref: '#/components/schemas/EnumIntegrationPingProductName'
          type: array
        publisher:
          description: Name of the publisher.
          type: string
        tags:
          description: "Tags to apply to the integration metadata. Can include `SSO`,\
            \ `AUTHENTICATION`, `MFA`, `INTELLIGENCE`, `GOVERNANCE`, `IDAAS`, `ACCESS`,\
            \ `DIRECTORY`, or `PROVISIONING`."
          items:
            $ref: '#/components/schemas/EnumIntegrationTag'
          type: array
        thirdParty:
          $ref: '#/components/schemas/Integration_thirdParty'
      required:
      - name
      - pingProductNames
      - publisher
      type: object
    IntegrationVersion:
      discriminator:
        mapping:
          PRODUCT_INTEGRATION_KIT: '#/components/schemas/IntegrationVersionIntegrationKit'
          SAML: '#/components/schemas/IntegrationVersionSAML'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/IntegrationVersionIntegrationKit'
      - $ref: '#/components/schemas/IntegrationVersionSAML'
    IntegrationVersionAttribute:
      example:
        schema: schema
        integration:
          id: id
        name: name
        id: id
        version:
          id: id
        required: true
      properties:
        id:
          description: Auto-generated ID of this attribute.
          readOnly: true
          type: string
        integration:
          $ref: '#/components/schemas/IntegrationVersionAttribute_integration'
        name:
          description: Attribute name the application expects. Unique within the integration
            version and in the form `urn:oasis:names:tc:SAML:2.0:attrname-format:uri`.
          type: string
        required:
          description: "Whether or not the attribute is required. If true, the value\
            \ property must be set with a non-empty value. Default is false."
          type: boolean
        schema:
          description: A JSON schema describing the current attribute mapping.
          type: string
        version:
          $ref: '#/components/schemas/IntegrationVersionAttribute_version'
      required:
      - schema
      type: object
    IntegrationVersionCommon:
      properties:
        configuration:
          $ref: '#/components/schemas/IntegrationVersionCommon_configuration'
        description:
          description: Unicode characters. The description of this integration metadata
            version.
          type: string
        id:
          description: The platform-generated ID of this integration metadata version.
          readOnly: true
          type: string
        integration:
          $ref: '#/components/schemas/IntegrationVersionCommon_integration'
        name:
          description: A unique name for the integration metadata version.
          type: string
        number:
          description: A unique number for the integration version.
          type: string
        type:
          $ref: '#/components/schemas/EnumIntegrationVersionType'
      required:
      - name
      - number
      type: object
    IntegrationVersionIntegrationKit:
      allOf:
      - $ref: '#/components/schemas/IntegrationVersionCommon'
      - properties:
          documentationUrl:
            description: Absolute URL to the documentation.
            type: string
          endOfLifeOn:
            description: EOL support date in the form yyyy-mm-dd.
            format: date
            type: string
          integratedWith:
            $ref: '#/components/schemas/IntegrationVersionIntegrationKit_allOf_integratedWith'
          number:
            description: Unique number for the integration version.
            type: string
          releasedOn:
            description: Release date in the form yyyy-mm-dd.
            format: date
            type: string
        required:
        - number
        - releasedOn
        type: object
    IntegrationVersionSAML:
      allOf:
      - $ref: '#/components/schemas/IntegrationVersionCommon'
      - properties:
          assertionConsumerService:
            description: "The URL to which PingOne sends SAML responses. Parameterize\
              \ the URL using `${_paremter_}`. For example, `https://${subdomain}.slack.com`.\
              \ The maximum length is 2000 characters."
            maxLength: 2000
            type: string
          assertionEncrypted:
            description: The state of assertion encryption. `true` if encrypted.
            type: boolean
          defaultTarget:
            description: "After an IdP-initiated SSO, this URL is passed in the RelayState\
              \ value in the SAML response. Informs the IdP where to send its response.\
              \ Parameterize the URL using `${_paremter_}`. For example, `https://${subdomain}.slack.com`."
            type: string
          entityId:
            description: Unique ID for the application.
            type: string
          nameIdFormat:
            description: |
              This can be one of the following:
              urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
              urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
              urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
              urn:oasis:names:tc:SAML:2.0:nameid-format:transient
            type: string
          protocolVersion:
            $ref: '#/components/schemas/EnumIntegrationVersionSAMLProtocolVersion'
          slo:
            $ref: '#/components/schemas/IntegrationVersionSAML_allOf_slo'
          thirdParty:
            $ref: '#/components/schemas/IntegrationVersionSAML_allOf_thirdParty'
        required:
        - assertionConsumerService
        - protocolVersion
        type: object
    KeyRotationPolicy:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        dn: dn
        nextKeyId: nextKeyId
        currentKeyId: currentKeyId
        signatureAlgorithm: null
        validityPeriod: 6
        environment:
          id: id
        keyLength: 1
        rotationPeriod: 30
        name: name
        rotatedAt: 2000-01-23T04:56:07.000+00:00
        id: id
        algorithm: null
        usageType: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        algorithm:
          $ref: '#/components/schemas/EnumKeyRotationPolicyAlgorithm'
        currentKeyId:
          description: The `kid` (key identifier) of the `KrpKey` designated as `CURRENT`.
          readOnly: true
          type: string
        dn:
          description: The DN this KRP will apply to generated `KrpKeys`. Is applied
            as both `issuerDN` and `subjectDN` because generated `KrpKeys` are self-signed.
          type: string
        id:
          description: The resource’s unique identifier.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        keyLength:
          description: The number of bytes of a cryptographic key this KRP will apply
            to generated `KrpKeys`.
          type: integer
        name:
          description: Human-readable name displayed in the admin console.
          type: string
        nextKeyId:
          description: The `kid` (key identifier) of the `KrpKey` designated as `NEXT`.
          readOnly: true
          type: string
        rotatedAt:
          description: The last time this KRP was rotated.
          format: date-time
          readOnly: true
          type: string
        rotationPeriod:
          default: 90
          description: The number of days to elapse before this KRP rotates `KrpKeys`.
            The default value is `90` days. The minimum value is `30` days. The maximum
            value is 1 day less than the `validityPeriod` value.
          minimum: 30
          type: integer
        signatureAlgorithm:
          $ref: '#/components/schemas/EnumKeyRotationPolicySigAlgorithm'
        usageType:
          $ref: '#/components/schemas/EnumKeyRotationPolicyUsageType'
        validityPeriod:
          default: 365
          description: Controls the `startsAt` and `expiresAt` fields this KRP will
            apply to generated `KrpKeys`. The default value is `365` days.
          type: integer
      required:
      - algorithm
      - dn
      - keyLength
      - name
      - signatureAlgorithm
      - usageType
      type: object
    Language:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        default: true
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        id: id
        locale: locale
        enabled: true
        customerAdded: true
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        default:
          description: Specifies whether this language is the default for the environment.
            This property value must be set to false when creating a language resource.
            It can be set to true only after the language is enabled and after the
            localization of an agreement resource is complete when agreements are
            used for the environment.
          type: boolean
        enabled:
          description: Specifies whether this language is enabled for the environment.
            This property value must be set to false when creating a language.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: The resource’s unique identifier.
          readOnly: true
          type: string
        locale:
          description: "An ISO standard language code. For more information about\
            \ standard language codes, see ISO Language Code Table."
          type: string
        name:
          description: "The language name. If omitted, the ISO standard name is used."
          type: string
        createdAt:
          description: The time the language resource was created.
          format: date-time
          readOnly: true
          type: string
        customerAdded:
          description: Specifies whether this language was added by a customer administrator.
          readOnly: true
          type: boolean
        updatedAt:
          description: The time the language resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - default
      - enabled
      - locale
      type: object
    LanguageLocalizationStatus:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        service: service
        statusDetails: statusDetails
        id: id
        localizationComplete: true
        locale:
          id: id
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        createdAt:
          description: The time the language localization status resource was created.
          format: date-time
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: The resource’s unique identifier.
          readOnly: true
          type: string
        locale:
          $ref: '#/components/schemas/LanguageLocalizationStatus_locale'
        service:
          description: The name of the service associated with this resource.
          type: string
        localizationComplete:
          type: boolean
        statusDetails:
          type: string
        updatedAt:
          description: The time the language localization status resource was last
            updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - service
      type: object
    License:
      example:
        gateways:
          allowLdapGateway: true
          allowRadiusGateway: true
          allowKerberosGateway: true
        package: package
        _links:
          key:
            href: https://openapi-generator.tech
        advancedServices:
          pingId:
            type: type
            included: true
        credentials:
          allowCredentials: true
        environments:
          allowConnections: true
          regions:
          - null
          - null
          allowAddResources: true
          max: 1
          allowCustomSchema: true
          allowProduction: true
          allowCustomDomain: true
        orchestrate:
          allowOrchestration: true
        mfa:
          allowFido2Devices: true
          allowVoiceOtp: true
          allowSmsOtp: true
          allowEmailOtp: true
          allowPushNotification: true
          allowTotp: true
          allowNotificationOutsideWhitelist: true
        expiresAt: 2000-01-23T04:56:07.000+00:00
        users:
          allowUpdateSelf: true
          allowPasswordPolicy: true
          max: 4
          allowMyAccount: true
          allowPasswordOnlyAuthentication: true
          allowRoleAssignment: true
          entitledToSupport: true
          annualActiveIncluded: 9
          allowPasswordManagement: true
          allowIdentityProviders: true
          allowInboundProvisioning: true
          allowVerificationFlow: true
          monthlyActiveIncluded: 9
          allowProvisioning: true
          hardLimitMax: 5
          allowPasswordManagementNotifications: true
        intelligence:
          allowReputation: true
          allowRisk: true
          allowDataConsent: true
          allowGeoVelocity: true
          allowAnonymousNetworkDetection: true
          allowAdvancedPredictors: true
        fraud:
          allowBotMaliciousDeviceDetection: true
          allowAccountProtection: true
        organization:
          id: id
        terminatesAt: 2000-01-23T04:56:07.000+00:00
        name: name
        verify:
          allowDocumentMatch: true
          allowManualIdInspection: true
          allowFaceMatch: true
          allowPushNotifications: true
        assignedEnvironmentsCount: 7
        beginsAt: 2000-01-23T04:56:07.000+00:00
        replacedByLicense:
          id: id
        id: id
        replacesLicense:
          id: id
        authorize:
          allowApiAccessManagement: true
          allowDynamicAuthorization: true
        status: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        advancedServices:
          $ref: '#/components/schemas/License_advancedServices'
        assignedEnvironmentsCount:
          description: A read-only integer that specifies the total number of environments
            associated with this license.
          readOnly: true
          type: integer
        authorize:
          $ref: '#/components/schemas/License_authorize'
        beginsAt:
          description: The date and time this license begins.
          format: date-time
          readOnly: true
          type: string
        credentials:
          $ref: '#/components/schemas/License_credentials'
        environments:
          $ref: '#/components/schemas/License_environments'
        expiresAt:
          description: The date and time this license expires. TRIAL licenses stop
            access to PingOne services at expiration. All other licenses trigger an
            event to send a notification when the license expires but do not block
            services.
          format: date-time
          readOnly: true
          type: string
        fraud:
          $ref: '#/components/schemas/License_fraud'
        gateways:
          $ref: '#/components/schemas/License_gateways'
        id:
          description: A read-only string that specifies the license resource’s unique
            identifier.
          readOnly: true
          type: string
        intelligence:
          $ref: '#/components/schemas/License_intelligence'
        mfa:
          $ref: '#/components/schemas/License_mfa'
        name:
          description: "A string that specifies a descriptive name for the license.\
            \ This is a required property in a license name update request. Valid\
            \ characters consists of any Unicode letter, mark, numeric character,\
            \ forward slash, dot, apostrophe, underscore, space, or hyphen. The maximum\
            \ length of a name is 255 characters."
          type: string
        orchestrate:
          $ref: '#/components/schemas/License_orchestrate'
        organization:
          $ref: '#/components/schemas/ObjectOrganization'
        package:
          description: A string that specifies the license template on which this
            license is based.
          type: string
        replacesLicense:
          $ref: '#/components/schemas/License_replacesLicense'
        replacedByLicense:
          $ref: '#/components/schemas/License_replacedByLicense'
        status:
          $ref: '#/components/schemas/EnumLicenseStatus'
        terminatesAt:
          description: An optional attribute that designates the exact date and time
            when this license terminates access to PingOne services. This attribute
            can be added to any licensing package.
          format: date-time
          type: string
        users:
          $ref: '#/components/schemas/License_users'
        verify:
          $ref: '#/components/schemas/License_verify'
      required:
      - name
      type: object
    LicenseName:
      example:
        name: name
      properties:
        name:
          description: The license name
          type: string
      required:
      - name
      type: object
    LocaleTranslation:
      example:
        translatedText: translatedText
        referenceText: referenceText
        shortKey: shortKey
        id: id
        key: key
      properties:
        id:
          description: The translation ID for a specific string.
          readOnly: true
          type: string
        key:
          description: "The page and name of the interface element to be localized\
            \ (for example, `flow-ui.button.cancel`)."
          minLength: 1
          type: string
        shortKey:
          description: "The interace element only (for example, `button.cancel`)."
          readOnly: true
          type: string
        referenceText:
          description: The English string text associated with the interface element.
          readOnly: true
          type: string
        translatedText:
          description: The translated string text associated with the interface element.
          type: string
      required:
      - key
      - translatedText
      type: object
    LocaleTranslations:
      items:
        $ref: '#/components/schemas/LocaleTranslation'
      type: array
      uniqueItems: true
    NotificationsPolicy:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        default: false
        environment:
          id: id
        quotas:
        - total: 9
          unclaimed: 3
          claimed: 6
          type: null
          deliveryMethods:
          - null
          - null
        - total: 9
          unclaimed: 3
          claimed: 6
          type: null
          deliveryMethods:
          - null
          - null
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        countryLimit:
          countries:
          - countries
          - countries
          type: null
          deliveryMethods:
          - null
          - null
        id: id
        providerConfiguration:
          conditions:
          - countries:
            - countries
            - countries
            deliveryMethods:
            - null
            - null
            fallbackChain:
            - id: id
            - id: id
          - countries:
            - countries
            - countries
            deliveryMethods:
            - null
            - null
            fallbackChain:
            - id: id
            - id: id
        cooldownConfiguration:
          voice:
            resendLimit: 8
            periods:
            - duration: 404
              timeUnit: null
            - duration: 404
              timeUnit: null
            groupBy: groupBy
            enabled: true
          whatsApp:
            resendLimit: 8
            periods:
            - duration: 404
              timeUnit: null
            - duration: 404
              timeUnit: null
            groupBy: groupBy
            enabled: true
          sms:
            resendLimit: 8
            periods:
            - duration: 404
              timeUnit: null
            - duration: 404
              timeUnit: null
            groupBy: groupBy
            enabled: true
          email:
            resendLimit: 8
            periods:
            - duration: 404
              timeUnit: null
            - duration: 404
              timeUnit: null
            groupBy: groupBy
            enabled: true
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        cooldownConfiguration:
          $ref: '#/components/schemas/NotificationsPolicy_cooldownConfiguration'
        countryLimit:
          $ref: '#/components/schemas/NotificationsPolicy_countryLimit'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        default:
          default: false
          description: "Indication of whether this policy is the default notification\
            \ policy for the environment. If the parameter is not provided, the value\
            \ used is `false`"
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: The name to use for the notification policy. Must be unique
            among the notification policies in the environment.
          type: string
        providerConfiguration:
          $ref: '#/components/schemas/NotificationsPolicy_providerConfiguration'
        quotas:
          description: "Collection of objects that define the SMS/Voice limits. Each\
            \ object contain the following elements- `type`, `deliveryMethods`, `total`.\
            \ Currently, a policy can contain ony one such object. Note that instead\
            \ of `total`, you can use the pair of fields- `claimed` and `unclaimed`."
          items:
            $ref: '#/components/schemas/NotificationsPolicy_quotas_inner'
          type: array
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - name
      - quotas
      type: object
    NotificationsPolicyCooldownConfigurationMethod:
      description: "Required if you have included the cooldownConfiguration object.\
        \ Contains the notification cooldown period settings for email, SMS, voice\
        \ or WhatsApp notifications."
      example:
        resendLimit: 8
        periods:
        - duration: 404
          timeUnit: null
        - duration: 404
          timeUnit: null
        groupBy: groupBy
        enabled: true
      properties:
        enabled:
          description: Set to true if you want to specify notification cooldown periods
            for the authentication method. Set to false if you don't want notification
            cooldown periods for this authentication method.
          type: boolean
        periods:
          description: |
            Use the periods array to specify the amount of time the user has to wait before requesting another notification such as another OTP. The array should contain three objects: the time to wait before the first retry, the time to wait before the second retry, and the time to wait before any subsequent retries.
          items:
            $ref: '#/components/schemas/NotificationsPolicyCooldownConfigurationMethod_periods_inner'
          type: array
        groupBy:
          description: "Since bad actors may try to target multiple users at a single\
            \ email address or phone number, by default the cooldown settings (both\
            \ waiting period and maximum retries) are applied to the email address\
            \ or phone number. If you want the settings to be applied at the single-user\
            \ level for the address/number, include the groupBy parameter in the request\
            \ and set it to USER_ID."
          type: string
        resendLimit:
          description: "The maximum number of requests that a user can send to receive\
            \ another notification, such as another OTP, before they are blocked for\
            \ 30 minutes."
          type: integer
      required:
      - enabled
      type: object
    NotificationsSettings:
      example:
        environment:
          id: id
        smsProvidersFallbackChain:
        - smsProvidersFallbackChain
        - smsProvidersFallbackChain
        _links:
          key:
            href: https://openapi-generator.tech
        deliveryMode: null
        replyTo:
          address: address
          name: name
        restrictions:
          smsVoiceQuota:
            daily: 0
        from:
          address: address
          name: name
        id: id
        whitelist:
        - user:
            id: id
        - user:
            id: id
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        deliveryMode:
          $ref: '#/components/schemas/EnumNotificationsSettingsDeliveryMode'
        restrictions:
          $ref: '#/components/schemas/NotificationsSettings_restrictions'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        smsProvidersFallbackChain:
          description: "A list which represents the execution order of different SMS/Voice\
            \ providers configured for the environment. The providers and their accounts’\
            \ configurations are represented in the list by the ID of the corresponding\
            \ `PhoneDeliverySettings` resource. The only provider which is not represented\
            \ by a `phoneDeliverySettingsID` is the PingOne Twilio provider. The PingOne\
            \ Twilio provider is represented by the `PINGONE_TWILIO` string. If the\
            \ `smsProvidersFallbackChain` list is empty, an SMS or voice message will\
            \ be sent using the default Ping Twilio account. Otherwise, an SMS or\
            \ voice message will be sent using the first provider in the list. If\
            \ the server fails to queue the message using that provider, it will use\
            \ the next provider in the list to try to send the message. This process\
            \ will go on until there are no more providers in the list. If the server\
            \ failed to send the message using all providers, the notification status\
            \ is set to `FAILED`."
          items:
            type: string
          type: array
        from:
          $ref: '#/components/schemas/NotificationsSettings_from'
        replyTo:
          $ref: '#/components/schemas/NotificationsSettings_replyTo'
        whitelist:
          items:
            $ref: '#/components/schemas/NotificationsSettings_whitelist_inner'
          type: array
      type: object
    NotificationsSettingsEmailDeliverySettings:
      oneOf:
      - $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCustom'
      - $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsSMTP'
    NotificationsSettingsEmailDeliverySettingsCommon:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        protocol:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsProtocol'
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      type: object
    NotificationsSettingsEmailDeliverySettingsCustom:
      allOf:
      - $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCommon'
      - properties:
          authentication:
            $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCustom_allOf_authentication'
          from:
            $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCustom_allOf_from'
          name:
            description: Name to use to identify the provider.
            type: string
          provider:
            $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomProvider'
          replyTo:
            $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCustom_allOf_replyTo'
          requests:
            description: Contains the object that is used to configure the API requests
              sent to the email provider.
            items:
              $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCustom_allOf_requests'
            type: array
        required:
        - authentication
        - name
        - protocol
        - requests
        type: object
    NotificationsSettingsEmailDeliverySettingsSMTP:
      allOf:
      - $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsCommon'
      - properties:
          host:
            description: A string that specifies the organization's SMTP server.
            type: string
          port:
            default: 465
            description: "An integer that specifies the port used by the organization's\
              \ SMTP server to send emails (default `465`). Note that the protocol\
              \ used depends upon the port specified. If you specify port `25`, `587`,\
              \ or `2525`, SMTP with `STARTTLS` is used. Otherwise, `SMTPS` is used."
            type: integer
          username:
            description: A string that specifies the organization's SMTP server's
              username.
            type: string
          password:
            description: A string that specifies the organization's SMTP server's
              password.
            format: password
            type: string
          from:
            $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsSMTP_allOf_from'
          replyTo:
            $ref: '#/components/schemas/NotificationsSettingsEmailDeliverySettingsSMTP_allOf_replyTo'
        type: object
    NotificationsSettingsPhoneDeliverySettings:
      oneOf:
      - $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCustom'
      - $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsTwilioSyniverse'
    NotificationsSettingsPhoneDeliverySettingsCommon:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        provider:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsProvider'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - provider
      type: object
    NotificationsSettingsPhoneDeliverySettingsCustom:
      allOf:
      - $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCommon'
      - properties:
          name:
            description: The customer provider's name.
            type: string
          requests:
            items:
              $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCustomRequest'
            type: array
          authentication:
            $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCustom_allOf_authentication'
          numbers:
            items:
              $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCustomNumbers'
            type: array
        required:
        - authentication
        - name
        - requests
        type: object
    NotificationsSettingsPhoneDeliverySettingsCustomNumbers:
      properties:
        number:
          description: "The phone number, toll-free number or short code."
          type: string
        type:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomNumbersType'
        selected:
          description: Specifies whether the number is selected by the admin for sending
            messages.
          type: boolean
        available:
          description: Specifies whether the number is currently available in the
            provider account.
          type: boolean
        capabilities:
          description: A collection of the phone delivery service capabilities.
          items:
            $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomNumbersCapability'
          type: array
        supportedCountries:
          description: |
            Specifies the `number`'s supported countries for notification recipients, depending on the phone number type:
            `SHORT_CODE`: A collection containing a single 2-character ISO country code, for example, `US`, `GB`, `CA`.
            If the custom provider is of `type=CUSTOM_PROVIDER`, `supportedCountries` must not be empty or null.
            For other custom provider types, if `supportedCountries` is null (empty is not supported), the specified short code number can only be used to dispatch notifications to United States recipient numbers.
            `TOLL_FREE`: A collection of valid 2-character country ISO codes, for example, `US`, `GB`, `CA`.
            If the custom provider is of `type=CUSTOM_PROVIDER`, `supportedCountries` must not be empty or null.
            For other custom provider types, if `supportedCountries` is null (empty is not supported), the specified toll-free number can only be used to dispatch notifications to United States recipient numbers.
            `PHONE_NUMBER`: `supportedCountries` can not be specified.
            If an SMS template has an alphanumeric `sender` ID and also has short code, the `sender` ID will be used for destination countries that support both alphanumeric senders and short codes. For Unites States and Canada that don't support alphanumeric sender IDs, a short code will be used if both an alphanumeric sender and a short code are specified.
          items:
            type: string
          type: array
      required:
      - number
      - type
      type: object
    NotificationsSettingsPhoneDeliverySettingsCustomRequest:
      properties:
        deliveryMethod:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomDeliveryMethod'
        url:
          description: |
            The provider's remote gateway or customer gateway URL.
            For requests using the POST method, use the provider's remote gateway URL.
            For requests using the GET method, use the provider's remote gateway URL, including the `${to}` and `${message}` mandatory variables, and the optional `${from}` variable, for example:
            `https://api.transmitsms.com/send-sms.json?to=${to}&from=${from}&message=${message}`
          type: string
        body:
          description: |
            The notification's request body. The body should include the ${to} and ${message} mandatory variables. For some vendors, the optional ${from} variable may also be required. For example:
            `messageType=ARN&message=${message}&phoneNumber=${to}&sender=${from}`
            In addition, you can use the following optional variables:
            `${voice}` - the type of voice configured for notifications
            `${locale}` - locale
            `${otp}` - OTP
            `${user.user.name}` - user's username
            `${user.name.given}` - user's given name
            `${user.name.family}` - user's family name
            You can also use dynamic variables in the body. For more information, see [Dynamic variables](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-templates-dynamic-variables).
          type: string
        headers:
          additionalProperties:
            type: string
          description: |
            A map of the notification's request headers
          type: object
        method:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomRequestMethod'
        phoneNumberFormat:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomNumberFormat'
        beforeTag:
          description: |
            For voice OTP notifications only.
            An opening tag which is commonly used by custom providers for defining a pause between each number in the OTP number string.
            Possible value: `<Say>`
          type: string
        afterTag:
          description: |
            For voice OTP notifications only.
            A closing tag which is commonly used by custom providers for defining a pause between each number in the OTP number string.
            Possible value: `</Say> <Pause length="1"/>`
          type: string
      required:
      - deliveryMethod
      - method
      - phoneNumberFormat
      - url
      type: object
    NotificationsSettingsPhoneDeliverySettingsTwilioSyniverse:
      allOf:
      - $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCommon'
      - properties:
          sid:
            description: |
              The public ID of the Twilio account.
              Relevant to Twilio only.
            type: string
          authToken:
            description: The secret key of the Twilio or Syniverse account.
            format: password
            type: string
          numbers:
            items:
              $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettingsCustomNumbers'
            type: array
        required:
        - authToken
        - sid
        type: object
    ObjectApplication:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the application resource ID associated
            with the object.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ObjectEnvironment:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the environment associated with the
            object.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ObjectOrganization:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the organization associated with the
            object.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ObjectPopulation:
      properties:
        id:
          description: A string that specifies the population associated with the
            object.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ObjectResource:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the resource associated with the object.
          readOnly: true
          type: string
      readOnly: true
      type: object
    Organization:
      example:
        createdAt: createdAt
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        billingConnections:
        - id: id
        - id: id
        description: description
        id: id
        type: null
        updatedAt: updatedAt
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: "A string that specifies the organization name, which must\
            \ be provided and must be unique among all organizations in PingOne."
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of the organization.
          readOnly: true
          type: string
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/EnumOrganizationType'
        billingConnections:
          items:
            $ref: '#/components/schemas/Organization_billingConnections_inner'
          readOnly: true
          type: array
      type: object
    P1Error:
      properties:
        id:
          description: "A unique identifier that is stored in log files and always\
            \ included in an error response. This value can be used to track the error\
            \ received by the client, with server-side activity included for troubleshooting\
            \ purposes."
          type: string
        code:
          description: A general fault code which the client must handle to provide
            all exception handling routines and to localize messages for users. This
            code is common across all PingOne services and is human readable (such
            as a defined constant rather than a number).
          type: string
        message:
          description: A short description of the error. This message is intended
            to assist with debugging and is returned in English only.
          type: string
        details:
          description: Additional details about the error. Optional information to
            help resolve the error and to display to users.
          items:
            $ref: '#/components/schemas/P1Error_details_inner'
          type: array
      type: object
    PasswordPolicy:
      example:
        populationCount: 3
        _links:
          key:
            href: https://openapi-generator.tech
        description: description
        excludesCommonlyUsed: true
        minComplexity: 4
        createdAt: createdAt
        default: true
        minUniqueCharacters: 8
        maxAgeDays: 1
        id: id
        maxRepeatedCharacters: 3
        shiftedNumberRowSequenceRule:
          maxLength: 3
        updatedAt: updatedAt
        minCharacters:
          "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
          "0123456789": 6
          ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
          abcdefghijklmnopqrstuvwxyz: 7
        length:
          min: 24
          max: 6
        notSimilarToCurrent: true
        alphabetSequenceRule:
          maxLength: 2
        history:
          retentionDays: 1
          count: 1
        qwertySequenceRule:
          maxLength: 3
        excludesProfileData: true
        environment:
          id: id
        numberSequenceRule:
          maxLength: 2
        lockout:
          durationSeconds: 1
          failureCount: 1
        name: name
        minAgeDays: 1
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        alphabetSequenceRule:
          $ref: '#/components/schemas/PasswordPolicy_alphabetSequenceRule'
        createdAt:
          description: The date and time the resource was created (format ISO-8061).
          readOnly: true
          type: string
        default:
          description: "Indicates whether this password policy is enforced within\
            \ the environment. When set to true, all other password policies are set\
            \ to false."
          type: boolean
        description:
          description: Specifies the brief description of the password policy.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        excludesCommonlyUsed:
          description: Set this to true to ensure the password is not one of the commonly
            used passwords.
          type: boolean
        excludesProfileData:
          description: "Set this to true to ensure the password is not an exact match\
            \ for the value of any attribute in the user’s profile, such as name,\
            \ phone number, or address."
          type: boolean
        history:
          $ref: '#/components/schemas/PasswordPolicy_history'
        id:
          description: The password resource’s unique identifier.
          readOnly: true
          type: string
        length:
          $ref: '#/components/schemas/PasswordPolicy_length'
        lockout:
          $ref: '#/components/schemas/PasswordPolicy_lockout'
        maxAgeDays:
          description: "The maximum number of days the same password can be used before\
            \ it must be changed. The value must be a positive, non-zero integer.\
            \  The value must be greater than the sum of minAgeDays (if set) + 21\
            \ (the expiration warning interval for passwords)."
          minimum: 1
          type: integer
        maxRepeatedCharacters:
          description: The maximum number of repeated characters allowed. This property
            is not enforced when not present.
          type: integer
        minAgeDays:
          description: "The minimum number of days a password must be used before\
            \ changing. The value must be a positive, non-zero integer. This property\
            \ is not enforced when not present."
          minimum: 1
          type: integer
        minCharacters:
          $ref: '#/components/schemas/PasswordPolicy_minCharacters'
        minComplexity:
          description: The minimum complexity of the password based on the concept
            of password haystacks. The value is the number of days required to exhaust
            the entire search space during a brute force attack. This property is
            not enforced when not present.
          type: integer
        minUniqueCharacters:
          description: The minimum number of unique characters required. This property
            is not enforced when not present.
          type: integer
        name:
          description: The name of the password policy. This value must be unique
            within the environment.
          type: string
        notSimilarToCurrent:
          description: "Set this to true to ensure that the proposed password is not\
            \ too similar to the user's current password based on the Levenshtein\
            \ distance algorithm. The value of this parameter is evaluated only for\
            \ password change actions in which the user enters both the current and\
            \ the new password. By design, PingOne does not know the user's current\
            \ password."
          type: boolean
        numberSequenceRule:
          $ref: '#/components/schemas/PasswordPolicy_numberSequenceRule'
        shiftedNumberRowSequenceRule:
          $ref: '#/components/schemas/PasswordPolicy_shiftedNumberRowSequenceRule'
        populationCount:
          description: Returned in the response. The number of populations associated
            with the password policy.
          readOnly: true
          type: integer
        updatedAt:
          description: The date and time the resource was last updated (format ISO-8061).
          readOnly: true
          type: string
        qwertySequenceRule:
          $ref: '#/components/schemas/PasswordPolicy_qwertySequenceRule'
      required:
      - excludesCommonlyUsed
      - excludesProfileData
      - name
      - notSimilarToCurrent
      type: object
    PKICAResponseFileUpload:
      properties:
        file:
          format: binary
          type: string
      required:
      - file
      type: object
    PKIFileUpload:
      properties:
        usageType:
          example: ENCRYPTION
          type: string
        file:
          format: binary
          type: string
      required:
      - file
      - usageType
      type: object
    PKIKeyFileUpload:
      properties:
        usageType:
          example: ENCRYPTION
          type: string
        file:
          format: binary
          type: string
        password:
          type: string
      required:
      - file
      - usageType
      type: object
    Population:
      example:
        preferredLanguage: preferredLanguage
        passwordPolicy:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        description: description
        createdAt: createdAt
        alternativeIdentifiers:
        - alternativeIdentifiers
        - alternativeIdentifiers
        default: true
        environment:
          id: id
        userCount: 5
        name: name
        theme:
          id: id
        id: id
        updatedAt: updatedAt
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        alternativeIdentifiers:
          description: Alternative identifiers that can be used to search for populations
            besides `name`.
          items:
            type: string
          type: array
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        default:
          description: "The population to use as the default population for the environment.\
            \ Only one population per environment can be the default. New users are\
            \ assigned to the default population if it exists, and the Population\
            \ ID is not provided in the [Create User](https://apidocs.pingidentity.com/pingone/platform/v1/api/#post-create-user)\
            \ request."
          type: boolean
        description:
          description: A string that specifies the description of the population.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: "A string that specifies the population name, which must be\
            \ provided and must be unique within an environment."
          type: string
        preferredLanguage:
          description: "The language locale for the population. If absent, the environment\
            \ default is used."
          type: string
        passwordPolicy:
          $ref: '#/components/schemas/Population_passwordPolicy'
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
        userCount:
          description: The number of users that belong to the population
          readOnly: true
          type: integer
        theme:
          $ref: '#/components/schemas/Population_theme'
      required:
      - name
      type: object
    PopulationDefaultIdp:
      example:
        id: id
        type: type
      properties:
        id:
          description: The ID of the default IdP for the population.
          type: string
        type:
          description: The type of the default IdP for the population.
          readOnly: true
          type: string
      type: object
    PropagationStore:
      example:
        image:
          href: href
          id: id
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        configuration:
          key: ""
        managed: true
        name: name
        description: description
        id: id
        type: null
        syncStatus:
          failedCount: 0
          lastSyncAt: 2000-01-23T04:56:07.000+00:00
          userTotal: 5
          syncState: null
          failedDeprovisionCount: 6
          successCount: 1
          details: details
        status: null
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        configuration:
          additionalProperties: true
          description: Configuration properties specific to each identity propagation
            store.
          type: object
        description:
          description: A description for the identity propagation store.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        image:
          $ref: '#/components/schemas/PropagationStore_image'
        managed:
          description: "Indicates whether or not to enable deprovisioning of users\
            \ for a store when it is deleted. The deprovisioning occurs when a new\
            \ revision is created (`POST {{apiPath}}/environments/{{envID}}/propagation/revisions`)."
          type: boolean
        name:
          description: The name of the identity store.
          type: string
        status:
          $ref: '#/components/schemas/EnumPropagationStoreStatus'
        syncStatus:
          $ref: '#/components/schemas/PropagationStore_syncStatus'
        type:
          $ref: '#/components/schemas/EnumPropagationStoreType'
      required:
      - configuration
      - name
      - type
      type: object
    PropagationStoreConfigurationAquera:
      properties:
        ACCESS_TOKEN:
          description: A string specifying the access token for account authentication.
          type: string
        AUTHENTICATION_METHOD:
          $ref: '#/components/schemas/EnumPropagationStoreTypeAqueraAuthenticationMethod'
        BASIC_AUTH_PASSWORD:
          description: The password for account authentication.
          type: string
        BASIC_AUTH_USER:
          description: The user name for account authentication.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        GROUP_NAME_SOURCE:
          $ref: '#/components/schemas/EnumPropagationStoreTypeAqueraGroupSourceName'
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        SCIM_URL:
          description: The SCIM URL.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - AUTHENTICATION_METHOD
      - BASIC_AUTH_PASSWORD
      - BASIC_AUTH_USER
      - SCIM_URL
      type: object
    PropagationStoreConfigurationAzureADSAMLV2:
      properties:
        ClientId:
          description: The Azure Active Directory client ID.
          type: string
        ClientSecret:
          description: The Azure Active Directory client secret.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be deprovisioned (removed)
            following action specified in `REMOVE_ACTION`.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        PROVISION_DISABLED_USERS_PROV_OPT:
          default: true
          description: "Whether or not disabled users can be provisioned. Defaults\
            \ to `true` and, if used, must be set to `true`."
          type: boolean
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        RemoveLicensesWhenSkuIdEmpty:
          description: Whether or not remove licenses from user when `skuId` is empty.
          type: boolean
        TenantDomain:
          description: The account's Azure Active Directory domain.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - ClientId
      - ClientSecret
      - RemoveLicensesWhenSkuIdEmpty
      - TenantDomain
      type: object
    PropagationStoreConfigurationGithubEMU:
      properties:
        BASE_URL:
          description: Base URL of the target propagation store.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be deprovisioned (removed)
            following action specified in `REMOVE_ACTION`.
          type: boolean
        OAUTH_ACCESS_TOKEN:
          description: OAuth 2 access token.
          type: string
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - BASE_URL
      - OAUTH_ACCESS_TOKEN
      type: object
    PropagationStoreConfigurationGoogleApps:
      properties:
        APPLICATION_NAME:
          description: Name of the application using the store.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be deprovisioned (removed)
            following action specified in `REMOVE_ACTION`.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        DOMAIN:
          description: The account's domain name.
          type: string
        OAUTH_ACCESS_TOKEN:
          description: OAuth 2 access token.
          type: string
        OAUTH_CLIENT_ID:
          description: GoogleApps identifier of the client associated with the propagation
            store.
          type: string
        OAUTH_CLIENT_SECRET:
          description: GoogleApps secret of the client associated with the propagation
            store.
          type: string
        OAUTH_REFRESH_TOKEN:
          description: OAuth 2 refresh token.
          type: string
        PROVISION_DISABLED_USERS_PROV_OPT:
          default: true
          description: "Whether or not disabled users can be provisioned. Defaults\
            \ to `true` and, if used, must be set to `true`."
          type: boolean
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - APPLICATION_NAME
      - DOMAIN
      - OAUTH_ACCESS_TOKEN
      - OAUTH_CLIENT_ID
      - OAUTH_CLIENT_SECRET
      - OAUTH_REFRESH_TOKEN
      type: object
    PropagationStoreConfigurationLDAPGateway:
      properties:
        ATTRIBUTE_METADATA:
          description: User-defined attribute metadata.
          type: string
        CLIENT_ID:
          description: Identifier of the client for authentication.
          type: string
        CLIENT_SECRET:
          description: Secret of the client for authentication.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DELETE_USERS:
          description: Whether or not users are allowed to be deleted.
          type: boolean
        ENVIRONMENT_ID:
          description: "Identifier, a UUID, of the environment the connector services."
          type: string
        GATEWAY_BASE_URL:
          description: Base URL of the gateway.
          type: string
        GATEWAY_ID:
          description: Identifier of the gateway to which the connector connects.
          type: string
        LDAP_TYPE:
          $ref: '#/components/schemas/EnumPropagationStoreTypeLDAPGatewayLDAPType'
        OAUTH_URL:
          description: OAuth token request endpoint.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - CLIENT_ID
      - CLIENT_SECRET
      - ENVIRONMENT_ID
      - GATEWAY_BASE_URL
      - GATEWAY_ID
      - LDAP_TYPE
      - OAUTH_URL
      type: object
    PropagationStoreConfigurationPingOne:
      properties:
        CLIENT_ID:
          description: Unique identifier (UUID) of the PingOne client associated with
            the propagation store.
          type: string
        CLIENT_SECRET:
          description: The PingOne client secret.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEFAULT_AUTH_METHOD:
          $ref: '#/components/schemas/EnumPropagationStoreTypePingOneDefaultAuthMethod'
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        ENVIRONMENT_ID:
          description: Unique identifier (UUID) of the PingOne environment associated
            with the propagation store.
          type: string
        MFA_USER_DEVICE_MANAGEMENT:
          description: How to manage MFA user devices when synchronizing. Options
            are either Merge with devices in PingOne or Overwrite devices in PingOne.
          type: string
        PROVISION_DISABLED_USERS_PROV_OPT:
          description: Whether or not disabled users can be provisioned.
          type: boolean
        REGION:
          $ref: '#/components/schemas/EnumPropagationStoreTypePingOneRegion'
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - ENVIRONMENT_ID
      - REGION
      type: object
    PropagationStoreConfigurationSalesforce:
      properties:
        ACCOUNT_ID:
          description: The Salesforce account ID.
          type: string
        CLIENT_ID:
          description: The Salesforce client ID.
          type: string
        CLIENT_SECRET:
          description: The Salesforce client secret.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        ENABLE_COMMUNITIES:
          description: Whether or not to enable Salesforce communities.
          type: boolean
        FREEZE_USER_FLAG:
          description: Whether the user account is frozen.
          type: boolean
        OAUTH_ACCESS_TOKEN:
          description: OAuth access token for account authentication.
          type: string
        OAUTH_REFRESH_TOKEN:
          description: OAuth refresh token for account authentication.
          type: string
        PERMISSION_SET_MANAGEMENT:
          description: The permission sets to be merged with Salesforce.
          type: string
        PROFILE_ID:
          description: The Salesforce profile ID.
          type: string
        PROVISION_DISABLED_USERS:
          description: Whether or not disabled users can be provisioned.
          type: boolean
        SALESFORCE_DOMAIN:
          description: The account's salesforce.com domain.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - CLIENT_ID
      - CLIENT_SECRET
      - ENABLE_COMMUNITIES
      - FREEZE_USER_FLAG
      - OAUTH_ACCESS_TOKEN
      - OAUTH_REFRESH_TOKEN
      - PERMISSION_SET_MANAGEMENT
      - SALESFORCE_DOMAIN
      type: object
    PropagationStoreConfigurationSalesforceContacts:
      properties:
        ACCOUNT_ID:
          description: The Salesforce account ID.
          type: string
        CLIENT_ID:
          description: Unique identifier (UUID) of the Salesforce client associated
            with the propagation store.
          type: string
        CLIENT_SECRET:
          description: The Salesforce client secret.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        ENABLE_COMMUNITIES:
          description: Whether or not to enable Salesforce communities.
          type: boolean
        FREEZE_USER_FLAG:
          description: Whether the user account is frozen.
          type: boolean
        OAUTH_ACCESS_TOKEN:
          description: OAuth access token for account authentication.
          type: string
        OAUTH_REFRESH_TOKEN:
          description: OAuth refresh token for account authentication.
          type: string
        PERMISSION_SET_MANAGEMENT:
          description: The permission sets to be merged with Salesforce.
          type: string
        PROFILE_ID:
          description: The Salesforce profile ID.
          type: string
        PROVISION_DISABLED_USERS:
          description: Whether or not disabled users can be provisioned.
          type: boolean
        RECORD_TYPE:
          $ref: '#/components/schemas/EnumPropagationStoreTypeSalesforceContactsRecordType'
        SALESFORCE_DOMAIN:
          description: The account's salesforce.com domain.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - CLIENT_ID
      - CLIENT_SECRET
      - OAUTH_ACCESS_TOKEN
      - OAUTH_REFRESH_TOKEN
      - RECORD_TYPE
      - SALESFORCE_DOMAIN
      type: object
    PropagationStoreConfigurationSCIM:
      properties:
        AUTHENTICATION_METHOD:
          $ref: '#/components/schemas/EnumPropagationStoreTypeSCIMAuthenticationMethod'
        AUTHORIZATION_TYPE:
          description: The authorization header type.
          type: string
        BASIC_AUTH_PASSWORD:
          description: "The password for account authentication. Required when `AUTHENTICATION_METHOD`\
            \ is `Basic Authentication`, otherwise optional."
          type: string
        BASIC_AUTH_USER:
          description: "The user name for account authentication. Required when `AUTHENTICATION_METHOD`\
            \ is `Basic Authentication`, otherwise optional."
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        GROUP_NAME_SOURCE:
          $ref: '#/components/schemas/EnumPropagationStoreTypeSCIMGroupNameSource'
        GROUPS_RESOURCE:
          description: API endpoint path to the group entity.
          type: string
        OAUTH_ACCESS_TOKEN:
          description: "OAuth access token for account authentication. Required when\
            \ `AUTHENTICATION_METHOD` is `OAuth 2 Bearer Token`, otherwise optional."
          type: string
        OAUTH_CLIENT_ID:
          description: "OAuth client ID. Required when `AUTHENTICATION_METHOD` is\
            \ `OAuth 2 Client Credentials`, otherwise optional."
          type: string
        OAUTH_CLIENT_SECRET:
          description: "OAuth client secret. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth 2 Client Credentials`, otherwise optional."
          type: string
        OAUTH_TOKEN_REQUEST:
          description: "OAuth token request endpoint. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth 2 Bearer Token`, otherwise optional."
          type: string
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        SCIM_URL:
          description: The SCIM URL.
          type: string
        SCIM_VERSION:
          description: The SCIM version.
          type: string
        UNIQUE_USER_IDENTIFIER:
          $ref: '#/components/schemas/EnumPropagationStoreTypeSCIMUniqueUserIdentifier'
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
        USER_FILTER:
          description: A string that specifies a SCIM filter expression.
          type: string
        USERS_RESOURCE:
          description: API endpoint path to the user entity.
          type: string
      required:
      - AUTHENTICATION_METHOD
      - AUTHORIZATION_TYPE
      - SCIM_URL
      - SCIM_VERSION
      - UNIQUE_USER_IDENTIFIER
      - USERS_RESOURCE
      - USER_FILTER
      type: object
    PropagationStoreConfigurationServiceNow:
      properties:
        Administrator_Password:
          description: Password for the administrator.
          type: string
        Administrator_Username:
          description: Username for the administrator.
          type: string
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be deprovisioned (removed)
            following action specified in `REMOVE_ACTION`.
          type: string
        DISABLE_USERS:
          description: Whether or not new users are allowed to be disabled.
          type: boolean
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisable'
        ServiceNow_Url:
          description: The URL for the ServiceNow account.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - Administrator_Password
      - Administrator_Username
      - ServiceNow_Url
      type: object
    PropagationStoreConfigurationSlack:
      properties:
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be deprovisioned (removed)
            following action specified in `REMOVE_ACTION`.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled. Must be set
            to `true`.
          type: boolean
        OAUTH_ACCESS_TOKEN:
          description: OAuth 2 access token.
          type: string
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisable'
        UNIQUE_USER_IDENTIFIER:
          $ref: '#/components/schemas/EnumPropagationStoreTypeSlackUniqueUserIdentifier'
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - OAUTH_ACCESS_TOKEN
      - UNIQUE_USER_IDENTIFIER
      type: object
    PropagationStoreConfigurationWorkday:
      properties:
        excludeContingentWorkers:
          description: Whether or not contingent workers are excluded.
          type: boolean
        excludeEmployees:
          description: Whether or not employees are excluded.
          type: boolean
        excludeInactiveWorkers:
          description: Whether or not inactive workers are excluded.
          type: boolean
        host:
          description: The Workday API host.
          type: string
        password:
          description: The password for account authentication.
          type: string
        tenantId:
          description: The Workday tenant ID.
          type: string
        username:
          description: The user name for account authentication.
          type: string
      required:
      - password
      - tenantId
      - username
      type: object
    PropagationStoreConfigurationZoom:
      properties:
        API_KEY:
          description: "The client API key. Required when `AUTHENTICATION_METHOD`\
            \ is `JWT Bearer Token`, otherwise optional."
          type: string
        API_SECRET:
          description: "The client API secret. Required when `AUTHENTICATION_METHOD`\
            \ is `JWT Bearer Token`, otherwise optional."
          type: string
        AUTHENTICATION_METHOD:
          $ref: '#/components/schemas/EnumPropagationStoreTypeZoomAuthenticationMethod'
        CREATE_USERS:
          description: Whether or not users are allowed to be created.
          type: boolean
        DEPROVISION_USERS:
          description: Whether or not users are allowed to be removed (deprovisioned)
            following the action configured in `REMOVE_ACTION`.
          type: boolean
        DISABLE_USERS:
          description: Whether or not users are allowed to be disabled.
          type: boolean
        OAUTH_ACCOUNT_ID:
          description: "OAuth account identifier. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth Bearer Token`, otherwise optional."
          type: string
        OAUTH_CLIENT_ID:
          description: "OAuth client identifier. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth Bearer Token`, otherwise optional."
          type: string
        OAUTH_CLIENT_SECRET:
          description: "OAuth client secret. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth Bearer Token`, otherwise optional."
          type: string
        OAUTH_TOKEN_URL:
          description: "OAuth token request endpoint. Required when `AUTHENTICATION_METHOD`\
            \ is `OAuth Bearer Token`, otherwise optional."
          type: string
        REMOVE_ACTION:
          $ref: '#/components/schemas/EnumPropagationStoreTypeRemoveActionDisableDelete'
        SCIM_URL:
          description: The SCIM URL.
          type: string
        UPDATE_USERS:
          description: Whether or not users are allowed to be updated.
          type: boolean
      required:
      - SCIM_URL
      type: object
    RateLimitConfiguration:
      description: |
        Rate Limit Configuration object
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        id: id
        type: null
        value: value
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        id:
          description: The UUID of the rate limit configuration.
          readOnly: true
          type: string
        createdAt:
          description: The date and time the rate limit configuration was created.
          format: date-time
          readOnly: true
          type: string
        updatedAt:
          description: The date and time the rate limit configuration was updated.
          format: date-time
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/EnumRateLimitConfigurationType'
        value:
          description: "The IP address (v4 or v6), or a CIDR range, for the IP address\
            \ or addresses to be excluded."
          type: string
      required:
      - type
      - value
      type: object
    RecaptchaConfiguration:
      example:
        environment:
          id: id
        siteKey: siteKey
        secretKey: secretKey
        created: 2000-01-23T04:56:07.000+00:00
        modified: 2000-01-23T04:56:07.000+00:00
      properties:
        created:
          description: The time the configuration was created.
          format: date-time
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        modified:
          description: The time the configuration was last updated.
          format: date-time
          readOnly: true
          type: string
        siteKey:
          description: A string that specifies the public site key for the Recaptcha
            configuration provided by Google.
          type: string
        secretKey:
          description: A string that specifies the confidential secret key for the
            Recaptcha configuration provided by Google.
          type: string
      required:
      - secretKey
      - siteKey
      type: object
    Resource:
      example:
        applicationPermissionsSettings:
          claimEnabled: true
        audience: audience
        clientId: clientId
        _links:
          key:
            href: https://openapi-generator.tech
        resource:
          id: id
        description: description
        type: null
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        accessTokenValiditySeconds: 0
        name: name
        clientSecret: clientSecret
        id: id
        introspectEndpointAuthMethod: null
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        accessTokenValiditySeconds:
          description: "An integer that specifies the number of seconds that the access\
            \ token is valid. If a value is not specified, the default is 3600. The\
            \ minimum value is 300 seconds (5 minutes); the maximum value is 2592000\
            \ seconds (30 days)."
          type: integer
        applicationPermissionsSettings:
          $ref: '#/components/schemas/Resource_applicationPermissionsSettings'
        audience:
          description: "A string that specifies a URL without a fragment or `@ObjectName`\
            \ and must not contain `pingone` or `pingidentity` (for example, `https://api.bxretail.org`).\
            \ If a URL is not specified, the resource name is used."
          type: string
        clientId:
          description: "(Required when `clientSecret` is specified.) Supported only\
            \ for the `POST` operation. To modify the value of this field, the environment\
            \ must be enabled with the feature flag to allow importing resources with\
            \ administrator defined client ID and client secret values. This is the\
            \ unique client ID of an external resource that is being migrated to PingOne.\
            \ The ID must be a minimum of 8 alpha-numeric characters, and must be\
            \ globally unique in PingOne."
          minLength: 8
          type: string
        clientSecret:
          description: "(Required when clientId is specified.) Supported only for\
            \ the POST operation. To modify the value of this field, the environment\
            \ must be enabled with the feature flag to allow importing resources with\
            \ administrator defined client ID and client secret values. This is the\
            \ client secret associated with clientId for an external resource that\
            \ is being migrated to PingOne. This must be a minimum of 8 alpha-numeric\
            \ characters."
          format: password
          minLength: 8
          readOnly: true
          type: string
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of the resource.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        resource:
          $ref: '#/components/schemas/IdentityProviderAttribute_identityProvider'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: "A string that specifies the resource name, which must be provided\
            \ and must be unique within an environment."
          type: string
        introspectEndpointAuthMethod:
          $ref: '#/components/schemas/EnumResourceIntrospectEndpointAuthMethod'
        type:
          $ref: '#/components/schemas/EnumResourceType'
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - name
      type: object
    ResourceApplicationResource:
      example:
        parent:
          id: id
          type: null
        name: name
        description: description
        id: id
      properties:
        description:
          description: The application resource's description.
          type: string
        id:
          description: The resource's unique identifier.
          readOnly: true
          type: string
        name:
          description: The application resource name. The name value must be unique.
          type: string
        parent:
          $ref: '#/components/schemas/ResourceApplicationResource_parent'
      required:
      - name
      type: object
    ResourceApplicationPermission:
      example:
        resource:
          name: name
          id: id
        resourceServer:
          environment:
            id: id
          id: id
        action: action
        description: description
        id: id
        key: key
      properties:
        action:
          description: The action associated with this permission.
          type: string
        description:
          description: The resource's description.
          type: string
        id:
          description: The resource's unique identifier.
          type: string
        key:
          description: The resource.name:action pair of the permission.
          readOnly: true
          type: string
        resource:
          $ref: '#/components/schemas/ResourceApplicationPermission_resource'
        resourceServer:
          $ref: '#/components/schemas/ResourceApplicationPermission_resourceServer'
      required:
      - action
      type: object
    ResourceAttribute:
      example:
        userInfo: true
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        resource:
          id: id
        name: name
        idToken: true
        id: id
        type: null
        value: value
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: |
            A string that specifies the name of the custom resource attribute to be included in the access token. The following are reserved names and cannot be used. Thesese reserved names are applicable only when the resource's type property is `OPENID_CONNECT`:
            - `acr`
            - `amr`
            - `aud`
            - `auth_time`
            - `client_id`
            - `env`
            - `exp`
            - `iat`
            - `iss`
            - `jti`
            - `org`
            - `p1.*` (any name starting with the p1. prefix)
            - `scope`
            - `sid`
            - `sub`
          type: string
        type:
          $ref: '#/components/schemas/EnumResourceAttributeType'
        value:
          description: "A string that specifies the value of the custom resource attribute.\
            \ This value can be a placeholder that references an attribute in the\
            \ user schema, expressed as `${user.path.to.value}`, or it can be a static\
            \ string. Placeholders must be valid, enabled attributes in the environment’\
            s user schema. Examples fo valid values are `${user.email}`, `${user.name.family}`,\
            \ and `myClaimValueString`"
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        resource:
          $ref: '#/components/schemas/IdentityProviderAttribute_identityProvider'
        idToken:
          description: "A boolean that specifies whether the attribute mapping should\
            \ be available in the ID Token. This property is applicable only when\
            \ the application's protocol property is `OPENID_CONNECT`. If omitted,\
            \ the default is `true`. Note that the `idToken` and `userInfo` properties\
            \ cannot both be set to `false`. At least one of these properties must\
            \ have a value of `true`."
          type: boolean
        userInfo:
          description: "A boolean that specifies whether the attribute mapping should\
            \ be available through the `/as/userinfo` endpoint. This property is applicable\
            \ only when the application's protocol property is `OPENID_CONNECT`. If\
            \ omitted, the default is `true`. Note that the `idToken` and `userInfo`\
            \ properties cannot both be set to `false`. At least one of these properties\
            \ must have a value of `true`."
          type: boolean
      required:
      - name
      - value
      type: object
    ResourceSecret:
      example:
        environment:
          id: id
        previous:
          lastUsed: 2000-01-23T04:56:07.000+00:00
          secret: secret
          expiresAt: 2000-01-23T04:56:07.000+00:00
        secret: secret
      properties:
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        secret:
          description: "An auto-generated resource client secret. Possible characters\
            \ are a-z, A-Z, 0-9, -, ., _, ~. The secret has a minimum length of 64\
            \ characters per SHA-512 requirements when using the HS512 algorithm to\
            \ sign ID tokens using the secret as the key."
          format: password
          readOnly: true
          type: string
        previous:
          $ref: '#/components/schemas/ResourceSecret_previous'
      type: object
    ResourceScope:
      example:
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        resource:
          id: id
        name: name
        description: description
        enableMappedClaims: true
        id: id
        mappedClaims:
        - mappedClaims
        - mappedClaims
        schemaAttributes:
        - schemaAttributes
        - schemaAttributes
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        resource:
          $ref: '#/components/schemas/ObjectResource'
        name:
          description: A string that specifies the resource scope name.
          type: string
        description:
          description: A string that specifies the description of the scope.
          type: string
        enableMappedClaims:
          description: "A Boolean that enables attribute mapping in scopes to control\
            \ the attributes included in access tokens. If this property is not set\
            \ or set to `false` (default), the access token includes all custom attribute\
            \ claims. When set to `true`, the access token includes only the claims\
            \ mapped in the scope."
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        schemaAttributes:
          description: "An array that specifies the user schema attributes that can\
            \ be read or updated for the specified PingOne access control scope. The\
            \ value is an array of schema attribute paths (such as `username`, `name.given`,\
            \ `shirtSize`) that the scope controls. This property is supported only\
            \ for the `p1:read:user`, `p1:update:user` and `p1:read:user:{suffix}`\
            \ and `p1:update:user:{suffix}` scopes. No other PingOne platform scopes\
            \ allow this behavior. Any attributes not listed in the attribute array\
            \ are excluded from the read or update action. The wildcard path (*) in\
            \ the array includes all attributes and cannot be used in conjunction\
            \ with any other user schema attribute paths"
          items:
            type: string
          type: array
        mappedClaims:
          description: "A list of custom resource attribute IDs. This property applies\
            \ only for the resource with its `type` property set to `OPENID_CONNECT`\
            \ or `CUSTOM`. Moreover, this property does not display predefined OpenID\
            \ Connect (OIDC) mappings, such as the `email` claim in the OIDC `email`\
            \ scope or the `name` claim in the `profile` scope. You can create custom\
            \ attributes, and these custom attributes can be added to `mappedClaims`\
            \ and will display in the response."
          items:
            type: string
          type: array
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
      - name
      type: object
    Role:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        permissions:
        - classifier: classifier
          description: description
          id: id
        - classifier: classifier
          description: description
          id: id
        name: null
        description: description
        applicableTo:
        - null
        - null
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        applicableTo:
          description: A set of strings that specifies the scopes to which the role
            applies.
          items:
            $ref: '#/components/schemas/EnumRoleAssignmentScopeType'
          readOnly: true
          type: array
        description:
          description: A string that specifies the description of the role.
          readOnly: true
          type: string
        id:
          description: A string that specifies the ID of the role.
          readOnly: true
          type: string
        name:
          $ref: '#/components/schemas/EnumRoleName'
        permissions:
          description: A set of permissions assigned to the role.
          items:
            $ref: '#/components/schemas/Role_permissions_inner'
          readOnly: true
          type: array
      type: object
    RoleAssignment:
      example:
        environment:
          id: id
        role:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        scope:
          id: id
          type: null
        readOnly: true
        id: id
        gateway:
          id: id
        group:
          id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        gateway:
          $ref: '#/components/schemas/GatewayInstance_gateway'
        group:
          $ref: '#/components/schemas/RoleAssignment_group'
        id:
          description: A string that specifies the user role assignment ID.
          readOnly: true
          type: string
        readOnly:
          description: A boolean that specifies whether this role assignment can be
            deleted by the current actor.
          readOnly: true
          type: boolean
        role:
          $ref: '#/components/schemas/RoleAssignment_role'
        scope:
          $ref: '#/components/schemas/RoleAssignment_scope'
      required:
      - role
      - scope
      type: object
    Schema:
      example:
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        description: description
        attributes:
        - schema:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          type: null
          enumeratedValues:
          - archived: true
            description: description
            value: value
          - archived: true
            description: description
            value: value
          enabled: true
          required: true
          subAttributes:
          - null
          - null
          regexValidation:
            valuesPatternShouldNotMatch:
            - valuesPatternShouldNotMatch
            - valuesPatternShouldNotMatch
            requirements: requirements
            valuesPatternShouldMatch:
            - valuesPatternShouldMatch
            - valuesPatternShouldMatch
            pattern: pattern
          environment:
            id: id
          unique: true
          name: name
          schemaType: null
          id: id
          ldapAttribute: ldapAttribute
          multiValued: true
        - schema:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          type: null
          enumeratedValues:
          - archived: true
            description: description
            value: value
          - archived: true
            description: description
            value: value
          enabled: true
          required: true
          subAttributes:
          - null
          - null
          regexValidation:
            valuesPatternShouldNotMatch:
            - valuesPatternShouldNotMatch
            - valuesPatternShouldNotMatch
            requirements: requirements
            valuesPatternShouldMatch:
            - valuesPatternShouldMatch
            - valuesPatternShouldMatch
            pattern: pattern
          environment:
            id: id
          unique: true
          name: name
          schemaType: null
          id: id
          ldapAttribute: ldapAttribute
          multiValued: true
        id: id
        allowsContainsOperator: true
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        allowsContainsOperator:
          description: Indicates whether or not the `contains` operator can be used.
            You can use the `contains` operator in a maximum of 5 custom attributes.
          readOnly: true
          type: boolean
        attributes:
          items:
            $ref: '#/components/schemas/SchemaAttribute'
          readOnly: true
          type: array
        description:
          description: A string that specifies the description of the schema.
          readOnly: true
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        name:
          description: A string that specifies the resource name.
          readOnly: true
          type: string
      type: object
    SchemaAttribute:
      example:
        schema:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        displayName: displayName
        description: description
        type: null
        enumeratedValues:
        - archived: true
          description: description
          value: value
        - archived: true
          description: description
          value: value
        enabled: true
        required: true
        subAttributes:
        - null
        - null
        regexValidation:
          valuesPatternShouldNotMatch:
          - valuesPatternShouldNotMatch
          - valuesPatternShouldNotMatch
          requirements: requirements
          valuesPatternShouldMatch:
          - valuesPatternShouldMatch
          - valuesPatternShouldMatch
          pattern: pattern
        environment:
          id: id
        unique: true
        name: name
        schemaType: null
        id: id
        ldapAttribute: ldapAttribute
        multiValued: true
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        description:
          description: "A string that specifies an optional property that specifies\
            \ the description of the attribute. If provided, it must not be an empty\
            \ string. Valid characters consists of any Unicode letter, mark (for example,\
            \ accent or umlaut), numeric character, punctuation character, or space."
          type: string
        displayName:
          description: "A string that specifies an optional property that specifies\
            \ the display name of the attribute such as 'T-shirt size’. If provided,\
            \ it must not be an empty string. Valid characters consist of any Unicode\
            \ letter, mark (for example, accent or umlaut), numeric character, forward\
            \ slash, dot, apostrophe, underscore, space, or hyphen."
          type: string
        enabled:
          description: A boolean that specifies whether or not the attribute is enabled.
            This is a required property for POST and PUT operations; it cannot be
            omitted or explicitly set to null. Disabled attributes are ignored on
            create/update and not returned on read.
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the resource’s unique identifier.
          readOnly: true
          type: string
        ldapAttribute:
          description: A string that specifies the LDAP attribute.
          readOnly: true
          type: string
        name:
          description: "A string that specifies the name of the attribute. The attribute\
            \ name must be provided during creation, must not be empty and must not\
            \ exceed 256 characters. It must also be unique within the schema for\
            \ an environment. It must start with a letter and may be followed by letters,\
            \ numbers or hyphens."
          type: string
        required:
          description: A boolean that specifies whether or not the attribute is required.
            Required attributes must be provided a value during create/update. Defaults
            to false if not provided.
          type: boolean
        schema:
          $ref: '#/components/schemas/SchemaAttribute_schema'
        schemaType:
          $ref: '#/components/schemas/EnumSchemaAttributeSchemaType'
        subAttributes:
          description: "The list of sub-attributes of this attribute. Only `COMPLEX`\
            \ attribute types can have sub-attributes, and only one-level of nesting\
            \ is allowed. The leaf attribute definition must have a type of `STRING`\
            \ or `JSON`. A `COMPLEX` attribute definition must have at least one child\
            \ attribute definition."
          items:
            $ref: '#/components/schemas/SchemaAttribute'
          type: array
        type:
          $ref: '#/components/schemas/EnumSchemaAttributeType'
        unique:
          description: A boolean that specifies whether or not the attribute must
            have a unique value within the environment. This is a required property
            for POST and PUT operations; it cannot be omitted or explicitly set to
            null.
          type: boolean
        multiValued:
          description: "A boolean that specifies whether the attribute has multiple\
            \ values or a single one. This value can only change from false to true,\
            \ as changing from true to false is not allowed. Maximum number of values\
            \ stored is 1,000."
          type: boolean
        enumeratedValues:
          items:
            $ref: '#/components/schemas/SchemaAttribute_enumeratedValues_inner'
          type: array
        regexValidation:
          $ref: '#/components/schemas/SchemaAttribute_regexValidation'
      required:
      - enabled
      - name
      - type
      type: object
    SchemaAttributePatch:
      example:
        regexValidation:
          valuesPatternShouldNotMatch:
          - valuesPatternShouldNotMatch
          - valuesPatternShouldNotMatch
          requirements: requirements
          valuesPatternShouldMatch:
          - valuesPatternShouldMatch
          - valuesPatternShouldMatch
          pattern: pattern
        displayName: displayName
        unique: true
        name: name
        schemaType: null
        description: description
        type: null
        multiValued: true
        enumeratedValues:
        - archived: true
          description: description
          value: value
        - archived: true
          description: description
          value: value
        enabled: true
        required: true
        subAttributes:
        - schema:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          type: null
          enumeratedValues:
          - archived: true
            description: description
            value: value
          - archived: true
            description: description
            value: value
          enabled: true
          required: true
          subAttributes:
          - null
          - null
          regexValidation:
            valuesPatternShouldNotMatch:
            - valuesPatternShouldNotMatch
            - valuesPatternShouldNotMatch
            requirements: requirements
            valuesPatternShouldMatch:
            - valuesPatternShouldMatch
            - valuesPatternShouldMatch
            pattern: pattern
          environment:
            id: id
          unique: true
          name: name
          schemaType: null
          id: id
          ldapAttribute: ldapAttribute
          multiValued: true
        - schema:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          type: null
          enumeratedValues:
          - archived: true
            description: description
            value: value
          - archived: true
            description: description
            value: value
          enabled: true
          required: true
          subAttributes:
          - null
          - null
          regexValidation:
            valuesPatternShouldNotMatch:
            - valuesPatternShouldNotMatch
            - valuesPatternShouldNotMatch
            requirements: requirements
            valuesPatternShouldMatch:
            - valuesPatternShouldMatch
            - valuesPatternShouldMatch
            pattern: pattern
          environment:
            id: id
          unique: true
          name: name
          schemaType: null
          id: id
          ldapAttribute: ldapAttribute
          multiValued: true
      properties:
        description:
          description: "A string that specifies an optional property that specifies\
            \ the description of the attribute. If provided, it must not be an empty\
            \ string. Valid characters consists of any Unicode letter, mark (for example,\
            \ accent or umlaut), numeric character, punctuation character, or space."
          type: string
        displayName:
          description: "A string that specifies an optional property that specifies\
            \ the display name of the attribute such as 'T-shirt size’. If provided,\
            \ it must not be an empty string. Valid characters consist of any Unicode\
            \ letter, mark (for example, accent or umlaut), numeric character, forward\
            \ slash, dot, apostrophe, underscore, space, or hyphen."
          type: string
        enabled:
          description: A boolean that specifies whether or not the attribute is enabled.
            This is a required property for POST and PUT operations; it cannot be
            omitted or explicitly set to null. Disabled attributes are ignored on
            create/update and not returned on read.
          type: boolean
        name:
          description: "A string that specifies the name of the attribute. The attribute\
            \ name must be provided during creation, must not be empty and must not\
            \ exceed 256 characters. It must also be unique within the schema for\
            \ an environment. It must start with a letter and may be followed by letters,\
            \ numbers or hyphens."
          type: string
        required:
          description: A boolean that specifies whether or not the attribute is required.
            Required attributes must be provided a value during create/update. Defaults
            to false if not provided.
          type: boolean
        schemaType:
          $ref: '#/components/schemas/EnumSchemaAttributeSchemaType'
        subAttributes:
          description: "The list of sub-attributes of this attribute. Only `COMPLEX`\
            \ attribute types can have sub-attributes, and only one-level of nesting\
            \ is allowed. The leaf attribute definition must have a type of `STRING`\
            \ or `JSON`. A `COMPLEX` attribute definition must have at least one child\
            \ attribute definition."
          items:
            $ref: '#/components/schemas/SchemaAttribute'
          type: array
        type:
          $ref: '#/components/schemas/EnumSchemaAttributeType'
        unique:
          description: A boolean that specifies whether or not the attribute must
            have a unique value within the environment. This is a required property
            for POST and PUT operations; it cannot be omitted or explicitly set to
            null.
          type: boolean
        multiValued:
          description: "A boolean that specifies whether the attribute has multiple\
            \ values or a single one. This value can only change from false to true,\
            \ as changing from true to false is not allowed. Maximum number of values\
            \ stored is 1,000."
          type: boolean
        enumeratedValues:
          items:
            $ref: '#/components/schemas/SchemaAttribute_enumeratedValues_inner'
          type: array
        regexValidation:
          $ref: '#/components/schemas/SchemaAttribute_regexValidation'
      type: object
    SignOnPolicy:
      example:
        createdAt: createdAt
        default: false
        environment:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        name: name
        description: description
        id: id
        updatedAt: updatedAt
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        createdAt:
          description: The date and time the resource was created (format ISO-8061).
          readOnly: true
          type: string
        default:
          default: false
          description: "A boolean that specifies whether this sign-on policy is the\
            \ environment's default that is used by applications that do not have\
            \ application-specific sign-on policy assignments. This property can only\
            \ be set to true, in which case the isDefault property of all other sign-on\
            \ policies are set to false."
          type: boolean
        description:
          description: A string that specifies the description of the sign-on policy.
          type: string
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the sign-on policy resource’s unique
            identifier.
          readOnly: true
          type: string
        name:
          description: "A string that specifies the resource name. The name must be\
            \ unique within the environment, and can consist of either a string of\
            \ alphanumeric letters, underscore, hyphen, period `^[a-zA-Z0-9_. -]+$`\
            \ or an absolute URI if the string contains a `:` character."
          type: string
        updatedAt:
          description: The date and time the resource was last updated (format ISO-8061).
          readOnly: true
          type: string
      required:
      - name
      type: object
    SignOnPolicyAction:
      oneOf:
      - $ref: '#/components/schemas/SignOnPolicyActionLogin'
      - $ref: '#/components/schemas/SignOnPolicyActionMFA'
      - $ref: '#/components/schemas/SignOnPolicyActionIDFirst'
      - $ref: '#/components/schemas/SignOnPolicyActionIDP'
      - $ref: '#/components/schemas/SignOnPolicyActionAgreement'
      - $ref: '#/components/schemas/SignOnPolicyActionProgressiveProfiling'
      - $ref: '#/components/schemas/SignOnPolicyActionPingID'
      - $ref: '#/components/schemas/SignOnPolicyActionPingIDWinLoginPasswordless'
    SignOnPolicyActionCommonConditionGreater:
      properties:
        greater:
          description: An integer that specifies the maximum number of seconds to
            wait since the last sign on before prompting for a new sign-on action.
          minimum: 1
          type: integer
        secondsSince:
          description: "A string representing a condition variable.  For more information,\
            \ see documenation at https://apidocs.pingidentity.com/pingone/platform/v1/api/#sign-on-policy-actions\
            \ ."
          type: string
      required:
      - greater
      - secondsSince
      type: object
    SignOnPolicyActionCommonConditionIPRange:
      properties:
        contains:
          type: string
        ipRange:
          items:
            type: string
          type: array
      required:
      - contains
      - ipRange
      type: object
    SignOnPolicyActionCommonConditionIPRisk:
      properties:
        ipRisk:
          $ref: '#/components/schemas/SignOnPolicyActionCommonConditionIPRisk_ipRisk'
        valid:
          type: string
      required:
      - ipRisk
      - valid
      type: object
    SignOnPolicyActionCommonConditionGeovelocity:
      properties:
        geoVelocity:
          type: string
        valid:
          $ref: '#/components/schemas/SignOnPolicyActionCommonConditionGeovelocity_valid'
      required:
      - geoVelocity
      - valid
      type: object
    SignOnPolicyActionCommonConditionAnonymousNetwork:
      properties:
        anonymousNetwork:
          items:
            type: string
          type: array
        valid:
          type: string
      required:
      - anonymousNetwork
      - valid
      type: object
    SignOnPolicyActionCommonConditionEquals:
      properties:
        value:
          type: string
        equals:
          $ref: '#/components/schemas/SignOnPolicyActionCommonConditionEquals_equals'
      required:
      - equals
      - value
      type: object
    SignOnPolicyActionCommonConditionOr:
      properties:
        or:
          items:
            $ref: '#/components/schemas/SignOnPolicyActionCommonConditionOr_or_inner'
          type: array
      type: object
    SignOnPolicyActionCommonConditionAnd:
      properties:
        and:
          items:
            $ref: '#/components/schemas/SignOnPolicyActionCommonConditionOr_or_inner'
          type: array
      type: object
    SignOnPolicyActionCommonConditionNot:
      properties:
        not:
          $ref: '#/components/schemas/SignOnPolicyActionCommonConditionAggregate'
      type: object
    SignOnPolicyActionCommonConditionAggregate:
      oneOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionGreater'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionIPRisk'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionIPRange'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionGeovelocity'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionAnonymousNetwork'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionEquals'
    SignOnPolicyActionCommon:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        condition:
          $ref: '#/components/schemas/SignOnPolicyActionCommonConditionOr_or_inner'
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the sign-on policy assignment resource’s
            unique identifier.
          readOnly: true
          type: string
        priority:
          description: An integer that specifies the order in which the policy referenced
            by this assignment is evaluated during an authentication flow relative
            to other policies. An assignment with a lower priority will be evaluated
            first. This is a required property.
          minimum: 1
          type: integer
        signOnPolicy:
          $ref: '#/components/schemas/SignOnPolicyActionCommon_signOnPolicy'
        type:
          $ref: '#/components/schemas/EnumSignOnPolicyType'
      required:
      - priority
      - type
      type: object
    SignOnPolicyActionLogin:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          enforceLockoutForIdentityProviders:
            description: "A boolean that if set to true and if the user's account\
              \ is locked (the account.canAuthenticate attribute is set to false),\
              \ then social sign on with an external identity provider is prevented."
            type: boolean
          newUserProvisioning:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_newUserProvisioning'
          recovery:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_recovery'
          registration:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_registration'
          socialProviders:
            description: An array of strings that specifies the IDs of the identity
              providers that can be used for the social login sign-on flow.
            items:
              $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_socialProviders'
            type: array
        type: object
    SignOnPolicyActionMFA:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          authenticator:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_authenticator'
          boundBiometrics:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_boundBiometrics'
          email:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_email'
          securityKey:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_securityKey'
          sms:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_sms'
          voice:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_voice'
          applications:
            deprecated: true
            description: "The applications collection specifies all the native native\
              \ applications that are allowed in the sign-on policy action.  If the\
              \ applications collection is empty, a push notification is not allowed\
              \ for the action."
            items:
              $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_applications'
            type: array
          deviceAuthenticationPolicy:
            $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_deviceAuthenticationPolicy'
          noDevicesMode:
            $ref: '#/components/schemas/EnumSignOnPolicyNoDeviceMode'
        type: object
    SignOnPolicyActionIDFirst:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          discoveryRules:
            description: The list of IDP discovery rules that are evaluated in order
              when no user is associated with the user identifier. The maximum number
              of rules is 100. The condition on which this identity provider is used
              to authenticate the user is expressed using the PingOne policy condition
              language
            items:
              $ref: '#/components/schemas/SignOnPolicyActionIDFirst_allOf_discoveryRules'
            type: array
          enforceLockoutForIdentityProviders:
            description: "A boolean that if set to true and if the user's account\
              \ is locked (the account.canAuthenticate attribute is set to false),\
              \ then social sign on with an external identity provider is prevented."
            type: boolean
          recovery:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_recovery'
          registration:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_registration'
          socialProviders:
            description: An array of strings that specifies the IDs of the identity
              providers that can be used for the social login sign-on flow.
            items:
              $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_socialProviders'
            type: array
        type: object
    SignOnPolicyActionIDP:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          acrValues:
            description: "A string that designates the sign-on policies included in\
              \ the authorization flow request. Options can include the PingOne predefined\
              \ sign-on policies, Single_Factor and Multi_Factor, or any custom defined\
              \ sign-on policy names. Sign-on policy names should be listed in order\
              \ of preference, and they must be assigned to the application. This\
              \ property can be configured on the identity provider action and is\
              \ passed to the identity provider if the identity provider is of type\
              \ `SAML` or `OPENID_CONNECT`."
            type: string
          identityProvider:
            $ref: '#/components/schemas/SignOnPolicyActionIDP_allOf_identityProvider'
          passUserContext:
            description: "A boolean that specifies whether to pass in a login hint\
              \ to the identity provider on the authentication request. Based on user\
              \ context, the login hint is set if (1) the user is set on the flow,\
              \ and (2) the user already has an account link for the identity provider.\
              \ If both of these conditions are true, then the user is sent to the\
              \ identity provider with a login hint equal to their externalId for\
              \ the identity provider (saved on the account link). If these conditions\
              \ are not true, then the API checks see if there is an OIDC login hint\
              \ on the flow. If so, that login hint is used. If none of these conditions\
              \ are true, the login hint parameter is not included on the authorization\
              \ request to the identity provider."
            type: boolean
          registration:
            $ref: '#/components/schemas/SignOnPolicyActionIDP_allOf_registration'
        required:
        - identityProvider
        type: object
    SignOnPolicyActionAgreement:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          agreement:
            $ref: '#/components/schemas/SignOnPolicyActionAgreement_allOf_agreement'
          disableDeclineOption:
            description: "When enabled, the `Do Not Accept` button will terminate\
              \ the Flow and display an error message to the user."
            type: boolean
        required:
        - agreement
        type: object
    SignOnPolicyActionProgressiveProfiling:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          attributes:
            items:
              $ref: '#/components/schemas/SignOnPolicyActionProgressiveProfiling_allOf_attributes'
            type: array
          preventMultiplePromptsPerFlow:
            description: A boolean that specifies whether the progressive profiling
              action will not be executed if another progressive profiling action
              has already been executed during the flow. This property is required.
            type: boolean
          promptIntervalSeconds:
            description: An integer that specifies how often to prompt the user to
              provide profile data for the configured attributes for which they do
              not have values. This property is required.
            minimum: 1
            type: integer
          promptText:
            description: A string that specifies text to display to the user when
              prompting for attribute values. This property is required.
            type: string
        required:
        - attributes
        - preventMultiplePromptsPerFlow
        - promptIntervalSeconds
        - promptText
        type: object
    SignOnPolicyActionPingID:
      $ref: '#/components/schemas/SignOnPolicyActionCommon'
    SignOnPolicyActionPingIDWinLoginPasswordless:
      allOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommon'
      - properties:
          uniqueUserAttribute:
            $ref: '#/components/schemas/SignOnPolicyActionPingIDWinLoginPasswordless_allOf_uniqueUserAttribute'
          offlineMode:
            $ref: '#/components/schemas/SignOnPolicyActionPingIDWinLoginPasswordless_allOf_offlineMode'
        required:
        - offlineMode
        - uniqueUserAttribute
        type: object
    SignOnPolicyAssignment:
      example:
        environment:
          id: id
        application:
          id: id
        _links:
          key:
            href: https://openapi-generator.tech
        signOnPolicy:
          id: id
        id: id
        priority: 1
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        application:
          $ref: '#/components/schemas/ObjectApplication'
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: A string that specifies the sign-on policy assignment resource’s
            unique identifier.
          readOnly: true
          type: string
        priority:
          description: The order in which the policy referenced by this assignment
            is evaluated during an authentication flow relative to other policies.
            An assignment with a lower priority will be evaluated first.
          minimum: 1
          type: integer
        signOnPolicy:
          $ref: '#/components/schemas/SignOnPolicyActionCommon_signOnPolicy'
      required:
      - priority
      - signOnPolicy
      type: object
    Subscription:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        format: null
        tlsClientAuthKeyPair:
          id: id
        payloadOptions:
          maximumPayloadLimit:
            size: 4
            type: null
          payloadFormat:
            tcp:
              format: null
              additionalAttributes:
                key: additionalAttributes
            https:
              prettyPrint: true
              format: null
        connectionDetails:
          headers:
            key: headers
          url: url
        enabled: true
        verifyTlsCertificates: true
        createdAt: 2000-01-23T04:56:07.000+00:00
        environment:
          id: id
        protocol: null
        httpEndpoint:
          headers:
            key: headers
          url: url
        name: name
        id: id
        filterOptions:
          includedActionTypes:
          - includedActionTypes
          - includedActionTypes
          includedTags:
          - null
          - null
          userAgentExposed: false
          includedPopulations:
          - id: id
          - id: id
          ipAddressExposed: false
          includedApplications:
          - id: id
          - id: id
        updatedAt: 2000-01-23T04:56:07.000+00:00
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        connectionDetails:
          $ref: '#/components/schemas/Subscription_connectionDetails'
        createdAt:
          description: The time the key resource expires.The date and time at which
            the subscription resource was created (ISO 8601 format).
          format: date-time
          readOnly: true
          type: string
        enabled:
          description: "A boolean that specifies whether a created or updated subscription\
            \ should be active or suspended. A suspended state (`\"enabled\":false`)\
            \ accumulates all matched events, but these events are not delivered until\
            \ the subscription becomes active again (`\"enabled\":true`). For suspended\
            \ subscriptions, events accumulate for a maximum of two weeks. Events\
            \ older than two weeks are deleted. Restarted subscriptions receive the\
            \ saved events (up to two weeks from the restart date). This is a required\
            \ property."
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        filterOptions:
          $ref: '#/components/schemas/Subscription_filterOptions'
        format:
          $ref: '#/components/schemas/EnumSubscriptionFormat'
        id:
          description: A string that specifies the user resource’s unique identifier.
          readOnly: true
          type: string
        httpEndpoint:
          $ref: '#/components/schemas/Subscription_httpEndpoint'
        name:
          description: A string that specifies the subscription name. This is a required
            property.
          type: string
        payloadOptions:
          $ref: '#/components/schemas/Subscription_payloadOptions'
        protocol:
          $ref: '#/components/schemas/EnumSubscriptionProtocol'
        tlsClientAuthKeyPair:
          $ref: '#/components/schemas/Subscription_tlsClientAuthKeyPair'
        updatedAt:
          description: The date and time at which the subscription resource was last
            updated (ISO 8601 format).
          format: date-time
          readOnly: true
          type: string
        verifyTlsCertificates:
          description: "A boolean that specifies whether a certificates should be\
            \ verified. If this property's value is set to false, then all certificates\
            \ are trusted. (Setting this property's value to false introduces a security\
            \ risk.) This is a required property."
          type: boolean
      required:
      - enabled
      - filterOptions
      - name
      - verifyTlsCertificates
      type: object
    Template:
      example:
        createdAt: createdAt
        variables: "{}"
        _links:
          key:
            href: https://openapi-generator.tech
        displayName: displayName
        allowDynamicVariables: true
        description: description
        id: id
        deliveryMethods:
        - SMS
        - SMS
        updatedAt: updatedAt
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: The template id
          readOnly: true
          type: string
        displayName:
          description: The template’s display name.
          type: string
        deliveryMethods:
          description: "The delivery methods supported for this template. Valid values\
            \ are `SMS`, `Voice`, `Email` and `Push`."
          items:
            enum:
            - SMS
            - Voice
            - Email
            - Push
            type: string
          type: array
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
        description:
          description: The description of the template.
          type: string
        variables:
          description: "Lists the variables you can use in each template content.\
            \ The `required` property indicates whether the variable is required in\
            \ template content. If `required` is `true`, the `requiredForDeliveryMethods`\
            \ property lists the `deliveryMethods` types that require the variable.\
            \ Note that if `required` is `true`, but `requiredForDeliveryMethods`\
            \ is not returned, all `deliveryMethods` types are required. For more\
            \ information, see [Variables](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-templates-variables)."
          type: object
        allowDynamicVariables:
          description: "Specifies whether dynamic variables can be used in the template's\
            \ contents. For more information, see [Dynamic variables](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-templates-dynamic-variables)."
          type: boolean
      required:
      - deliveryMethods
      - displayName
      - variables
      type: object
    TemplateContent:
      oneOf:
      - $ref: '#/components/schemas/TemplateContentEmail'
      - $ref: '#/components/schemas/TemplateContentSMS'
      - $ref: '#/components/schemas/TemplateContentPush'
      - $ref: '#/components/schemas/TemplateContentVoice'
    TemplateContentCommon:
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: The template id.
          readOnly: true
          type: string
        createdAt:
          description: The time the resource was created.
          readOnly: true
          type: string
        updatedAt:
          description: The time the resource was last updated.
          readOnly: true
          type: string
        default:
          description: Specifies whether the template is a predefined default template.
          type: boolean
        locale:
          description: |
            A valid case-insensitive locale, complying with the ISO-639 language code and ISO-3166 country code standards:
            Two-character language code, for example, "en".
            Two-character language code followed by a two-character country code, separated by an underscore or dash, for example: "en_GB", "en-GB".
            Cannot be changed after it is initially set in `POST /environments/{{envID}}/templates/{{templateName}}/contents`.
          type: string
        deliveryMethod:
          $ref: '#/components/schemas/EnumTemplateContentDeliveryMethod'
        variant:
          description: "Holds the unique user-defined name for each content variant\
            \ that uses the same template + `deliveryMethod` + `locale` combination.\
            \ This property is case insensitive and has a limit of 100 characters.\
            \ For more information, see [Creating custom contents](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-templates-creating-custom-contents)."
          type: string
      required:
      - deliveryMethod
      - locale
      type: object
    TemplateContentEmail:
      allOf:
      - $ref: '#/components/schemas/TemplateContentCommon'
      - properties:
          body:
            description: "The email text. Email text cannot be larger than 100 kB.\
              \ Email text can contain HTML. If supported, this can include variables."
            type: string
          from:
            $ref: '#/components/schemas/TemplateContentEmail_allOf_from'
          subject:
            description: "The email's subject line. Cannot exceed 256 characters.\
              \ If supported, can include variables."
            maxLength: 256
            type: string
          replyTo:
            $ref: '#/components/schemas/TemplateContentEmail_allOf_replyTo'
          charset:
            default: UTF-8
            description: "If not specified, `UTF-8` is the default value."
            type: string
          emailContentType:
            default: text/html
            description: "If not specified, `text/html` is the default value."
            type: string
        required:
        - body
        type: object
    TemplateContentSMS:
      allOf:
      - $ref: '#/components/schemas/TemplateContentCommon'
      - properties:
          content:
            description: |
              The SMS text.
              UC-2 encoding is used for text that contains non GSM-7 characters. UC-2 encoded text cannot exceed 67 characters. GSM-7 encoded text cannot exceed 153 characters. If supported, it can include variables.
            maxLength: 153
            type: string
          sender:
            description: "The SMS sender ID. This property can contain only alphanumeric\
              \ characters and spaces, and its length cannot exceed 11 characters.\
              \ In some countries, it is impossible to send an SMS with an alphanumeric\
              \ sender ID. For those countries, the sender ID must be empty. For SMS\
              \ recipients in specific countries, refer to Twilio's documentation\
              \ on [International support for Alphanumeric Sender ID](https://support.twilio.com/hc/en-us/articles/223133767-International-support-for-Alphanumeric-Sender-ID)."
            maxLength: 11
            type: string
        required:
        - content
        type: object
    TemplateContentPush:
      allOf:
      - $ref: '#/components/schemas/TemplateContentCommon'
      - properties:
          title:
            description: "The push title (maximum 200 characters). If supported, this\
              \ can include variables."
            maxLength: 200
            type: string
          body:
            description: "The push text (maximum 400 characters for push text). If\
              \ supported, this can include variables."
            maxLength: 400
            type: string
          pushCategory:
            $ref: '#/components/schemas/EnumTemplateContentPushCategory'
        required:
        - body
        - title
        type: object
    TemplateContentVoice:
      allOf:
      - $ref: '#/components/schemas/TemplateContentCommon'
      - properties:
          content:
            description: "The voice text.  Limited to 1Kb characters.\n  The following\
              \ substitution place holders can be embedded in the message:\n  * `<pause1sec>`:\
              \ Pauses the message narration for 1 second.\n    The pause interval\
              \ <pause1sec> cannot be modified. To pause the message narration for\
              \ more than one second, repeat multiple `<pause1sec>` occurrences in\
              \ succession, according to the desired pause interval duration. For\
              \ example, `<pause1sec><pause1sec><pause1sec>` pauses the message narration\
              \ for three seconds.\n  * `<sayCharValue> .. </sayCharValue>`: Reads\
              \ the character name of each character of the enclosed string separately.\n\
              \  * `<repeatMessage val=x> .. </repeatMessage>`: Narrates the enclosed\
              \ text `<val>` number of times.\n  \n  In the following message example,\
              \ `${otp}` is assigned the value `\"123456\"`, and `${email}` is assigned\
              \ the value `\"joe@bxz.com\"`:\n  ```\n  Hello <pause1sec> your authentication\
              \ code is \n  <sayCharValue>${otp}</​sayCharValue> \n  <repeatMessage\
              \ val=2> I repeat your code is \n  <sayCharValue>${otp}</​sayCharValue>\n\
              \  </​repeatMessage> <pause1sec> \n  Mail <sayCharValue>${email}</​\
              sayCharValue> for help\n  ```\n  The narrated message on the voice call\
              \ sounds like:\n  ```\n  HELLO <1 second silence> YOUR AUTHENTICATION\
              \ CODE IS \n  ONE TWO THREE FOUR FIVE SIX \n  I REPEAT YOUR CODE IS\
              \ ONE TWO THREE FOUR FIVE SIX \n  I REPEAT YOUR CODE IS ONE TWO THREE\
              \ FOUR FIVE SIX <1 second silence> \n  MAIL JAY OH EE AT BEE EX ZEE\
              \ DOT SEE OH EM FOR HELP\n  ```\n"
            type: string
          voice:
            description: |
              Voice OTP supports vendor-specific voices.
                * Supported Twilio voices:
                  * Man, Woman
                    Supported locales (default: en):
                    en, en_GB, es, fr, de
                  * Alice (Twilio only)
                    Supported locales (default: en US):
                    da_DK, de_DE, en_AU, en_CA, en_GB, en_US, ca_ES, es_ES, es_MX, fi_FI, fr_CA, fr_FR, it_IT, ja_JP, ko_KR, nb_NO, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, sv_SE, zh_CN, zh_HK, zh_TW
                  * Amazon Polly
                    cy_GB, ro_RO, is_IS, hi_IN tr_TR
                * Supported Syniverse voices:
                  * Man, Woman
                    Supported locales:
                    en_US, en_GB, es_ES, es_US, fr_FR, de_DE, it_IT, en_AU, da_DK, is_IS, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, ja_JP
                  * Woman only
                    Supported locales:
                    cmn_CN, cy_GB, en_IN, fr_CA, hi_IN, nb_NO, ro_RO, sv_SE, tr_TR, ko_KR, ar
            type: string
        required:
        - content
        type: object
    TemplateContentBulkVariant:
      type: object
    User:
      example:
        preferredLanguage: preferredLanguage
        _links:
          key:
            href: https://openapi-generator.tech
        timezone: timezone
        lastSignOn:
          at: 2000-01-23T04:56:07.000+00:00
          remoteIp: remoteIp
        locale: locale
        title: title
        type: type
        enabled: true
        identityProvider:
          id: id
          type: null
        lifecycle:
          suppressVerificationCode: true
          status: null
        createdAt: 2000-01-23T04:56:07.000+00:00
        password:
          external:
            gateway:
              id: id
              userType:
                id: id
              correlationAttributes: "{}"
              type: null
          forceChange: true
          value: value
        verifyStatus: null
        nickname: nickname
        mfaEnabled: true
        id: id
        email: email
        updatedAt: 2000-01-23T04:56:07.000+00:00
        memberOfGroupIDs:
        - memberOfGroupIDs
        - memberOfGroupIDs
        address:
          streetAddress: streetAddress
          countryCode: countryCode
          postalCode: postalCode
          locality: locality
          region: region
        externalId: externalId
        photo:
          href: href
        memberOfGroupNames:
        - memberOfGroupNames
        - memberOfGroupNames
        population:
          id: id
        emailVerified: true
        primaryPhone: primaryPhone
        environment:
          id: id
        mobilePhone: mobilePhone
        name:
          given: given
          honorificSuffix: honorificSuffix
          middle: middle
          formatted: formatted
          honorificPrefix: honorificPrefix
          family: family
        account:
          canAuthenticate: true
          lockedAt: 2000-01-23T04:56:07.000+00:00
          secondsUntilUnlock: 6
          unlockAt: 2000-01-23T04:56:07.000+00:00
          status: null
        username: username
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        account:
          $ref: '#/components/schemas/UserAccount'
        address:
          $ref: '#/components/schemas/User_address'
        createdAt:
          description: The time the resource was created.
          format: date-time
          readOnly: true
          type: string
        email:
          description: "A string that specifies the user’s email address, which must\
            \ be provided and valid. For more information about email address formatting,\
            \ see section 3.4 of RFC 2822, Internet Message Format."
          type: string
        emailVerified:
          description: "Whether the user’s email is verified. An email address can\
            \ be verified during account verification. If the email address used to\
            \ request the verification code is the same as the user’s email at verification\
            \ time (and the verification code is valid), then the email is verified.\
            \ The value of this property can be set on user import."
          readOnly: true
          type: boolean
        enabled:
          description: A read-only boolean attribute that specifies whether the user
            is enabled. This attribute is set to ‘true’ by default when the user is
            created.
          readOnly: true
          type: boolean
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        externalId:
          description: "A string that specifies an identifier for the user resource\
            \ as defined by the provisioning client. This is optional. This may be\
            \ explicitly set to null when updating a user to unset it. The externalId\
            \ attribute simplifies the correlation of the user in PingOne with the\
            \ user’s account in another system of record. The platform does not use\
            \ this attribute directly in any way, but it is used by Ping Identity’\
            s Data Sync product. It can have a length of no more than 1024 characters\
            \ (min/max=1/1024)."
          maxLength: 1024
          minLength: 1
          type: string
        id:
          description: A string that specifies the user resource’s unique identifier.
          readOnly: true
          type: string
        identityProvider:
          $ref: '#/components/schemas/User_identityProvider'
        lastSignOn:
          $ref: '#/components/schemas/User_lastSignOn'
        lifecycle:
          $ref: '#/components/schemas/User_lifecycle'
        locale:
          description: "A string that specifies the user’s default location, which\
            \ is optional. This may be explicitly set to null when updating a user\
            \ to unset it. This is used for purposes of localizing such items as currency,\
            \ date time format, or numerical representations. If provided, it must\
            \ be a valid language tag as defined in RFC 5646. The following are example\
            \ tags fr, en-US, es-419, az-Arab, man-Nkoo-GN. The string can contain\
            \ any letters, numbers, combining characters, math and currency symbols,\
            \ dingbats and drawing characters, and invisible whitespace (regex `^[\\\
            p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It can have a length of no more\
            \ than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        memberOfGroupIDs:
          description: "A read-only array of IDs for the groups the user is a member\
            \ of. This property is returned for GET /environments/{environmentID}/users/{userID}\
            \ when include=memberOfGroupIDs is appended to the request. This property\
            \ is not returned with a list of users."
          items:
            type: string
          readOnly: true
          type: array
        memberOfGroupNames:
          description: "A read-only array of names for the groups the user is a member\
            \ of. This property is returned for GET /environments/{environmentID}/users/{userID}\
            \ when include=memberOfGroupNames is appended to the request. This property\
            \ is not returned with a list of users."
          items:
            type: string
          readOnly: true
          type: array
        mfaEnabled:
          description: "A boolean attribute that specifies whether multi-factor authentication\
            \ is enabled. This attribute is set to false by default when the user\
            \ is created. You can set mfaEnabled to true with POST CREATE User, POST\
            \ CREATE User (Import), or PUT UPDATE User MFA Enabled. You cannot update\
            \ mfaEnabled with PUT UPDATE User or PATCH UPDATE User."
          type: boolean
        mobilePhone:
          description: "A string that specifies the user’s native phone number, which\
            \ is optional. This might also match the primaryPhone attribute. This\
            \ may be explicitly set to null when updating a user to unset it. Valid\
            \ phone numbers must have at least one number and a maximum character\
            \ length of 32."
          maxLength: 32
          type: string
        name:
          $ref: '#/components/schemas/User_name'
        nickname:
          description: "A string that specifies the user’s nickname, which is optional.\
            \ This can be explicitly set to null when updating a user to unset it.\
            \ The string can contain any letters, numbers, combining characters, math\
            \ and currency symbols, dingbats and drawing characters, and invisible\
            \ whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It\
            \ can have a length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        password:
          $ref: '#/components/schemas/User_password'
        photo:
          $ref: '#/components/schemas/User_photo'
        population:
          $ref: '#/components/schemas/User_population'
        preferredLanguage:
          description: "A string that specifies the user’s preferred written or spoken\
            \ languages, which are optional. This may be explicitly set to null when\
            \ updating a user to unset it. If provided, the format of the value must\
            \ be a valid language range and the same as the HTTP Accept-Language header\
            \ field (not including Accept-Language:) and is specified in Section 5.3.5\
            \ of RFC 7231. For example en-US, en-gb;q=0.8, en;q=0.7."
          type: string
        primaryPhone:
          description: "A string that specifies the user’s primary phone number, which\
            \ is optional. This might also match the mobilePhone attribute. This may\
            \ be explicitly set to null when updating a user to unset it. Valid phone\
            \ numbers must have at least one number and a maximum character length\
            \ of 32."
          maxLength: 32
          minLength: 1
          type: string
        timezone:
          description: "A string that specifies the user’s time zone, which is optional.\
            \ This can be explicitly set to null when updating a user to unset it.\
            \ If provided, it must conform with the IANA Time Zone database format\
            \ [RFC6557], also known as the `Olson` time zone database format [Olson-TZ]\
            \ for example, `America/Los_Angeles` (regex `^\\w+\\/\\w+$`)."
          pattern: ^\w+\/\w+$
          type: string
        title:
          description: "A string that specifies the user’s title, which is optional,\
            \ such as \"Vice President\". This can be explicitly set to null when\
            \ updating a user to unset it. The string can contain any letters, numbers,\
            \ combining characters, math and currency symbols, dingbats and drawing\
            \ characters, and invisible whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\\
            p{S}\\p{N}\\p{P}]*$`). It can have a length of no more than 256 characters\
            \ (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        type:
          description: "A string that specifies the user’s type, which is optional.\
            \ This can be explicitly set to null when updating a user to unset it.\
            \ This attribute is organization-specific and has no special meaning within\
            \ the PingOne platform. It could have values of \"Contractor\", \"Employee\"\
            , \"Intern\", \"Temp\", \"External\", and `Unknown`. The string can contain\
            \ any letters, numbers, combining characters, math and currency symbols,\
            \ dingbats and drawing characters, and invisible whitespace (regex `^[\\\
            p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It can have a length of no more\
            \ than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        updatedAt:
          description: The time the resource was last updated.
          format: date-time
          readOnly: true
          type: string
        username:
          description: "A string that specifies the user name, which must be provided\
            \ and must be unique within an environment. The username must either be\
            \ a well-formed email address or a string. The string can contain any\
            \ letters, numbers, combining characters, math and currency symbols, dingbats\
            \ and drawing characters, and invisible whitespace (regex `^[\\p{L}\\\
            p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It can have a length of no more than\
            \ 128 characters (min/max=1/128)."
          maxLength: 128
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        verifyStatus:
          $ref: '#/components/schemas/EnumUserVerifyStatus'
      required:
      - email
      - username
      type: object
    UserApplicationRoleAssignment:
      example:
        environment:
          id: id
        name: name
        description: description
        id: id
      properties:
        environment:
          $ref: '#/components/schemas/ObjectEnvironment'
        id:
          description: Specifies the application role ID to assign to the specified
            user.
          type: string
        name:
          description: Specifies the name of the application role assigned to the
            user.
          type: string
        description:
          description: Specifies the description of the application role assigned
            to the user.
          type: string
      required:
      - id
      type: object
    UserAccount:
      example:
        canAuthenticate: true
        lockedAt: 2000-01-23T04:56:07.000+00:00
        secondsUntilUnlock: 6
        unlockAt: 2000-01-23T04:56:07.000+00:00
        status: null
      properties:
        canAuthenticate:
          description: "A boolean that specifies whether the user can authenticate.\
            \ If the value is set to `false`, the account is locked or the user is\
            \ disabled, and unless specified otherwise by the administrative configuration,\
            \ the user will be unable to authenticate."
          type: boolean
        lockedAt:
          description: A string that specifies the date-time the specified user account
            was locked. This property might be absent if the account is unlocked or
            if the account was locked out automatically by failed password attempts.
          format: date-time
          readOnly: true
          type: string
        secondsUntilUnlock:
          description: "An integer that specifies the number of seconds until the\
            \ user's account is unlocked. This property is absent if the account is\
            \ unlocked, or if it will not automatically unlock (and must be unlocked\
            \ by an administrator)."
          readOnly: true
          type: integer
        status:
          $ref: '#/components/schemas/EnumUserStatus'
        unlockAt:
          description: "A string that specifies the time the specified user account\
            \ will be unlocked. This property is absent if the account is unlocked,\
            \ or if it will not automatically unlock (and must be unlocked by an administrator)."
          format: date-time
          type: string
      required:
      - canAuthenticate
      - status
      type: object
    UserEnabled:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        enabled: true
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        enabled:
          default: true
          description: A read-only boolean attribute that specifies whether the user
            is enabled. This attribute is set to ‘true’ by default when the user is
            created.
          type: boolean
      type: object
    UserPopulation:
      example:
        _links:
          key:
            href: https://openapi-generator.tech
        id: id
      properties:
        _links:
          additionalProperties:
            $ref: '#/components/schemas/LinksHATEOAS_value'
          readOnly: true
          type: object
        id:
          description: A string that specifies the population ID associated with the
            user resource ID identified in the request URL.
          type: string
      required:
      - id
      type: object
    createApplication_request:
      example:
        name: "app_{{$timestamp}}"
        description: this is my application
        enabled: true
        '#loginPageUrl': https://example.com
        type: WEB_APP
        protocol: SAML
        '#icon':
          id: 04ad537e-c9cd-45c3-abfb-f41946cfe374
          href: https://upload.wikimedia.org/wikipedia/commons/a/a8/Baby_Jake.jpg
        assertionDuration: 60
        acsUrls:
        - https://example.com
        sloResponseEndpoint: https://example.com
        spEntityId: test
      oneOf:
      - $ref: '#/components/schemas/ApplicationSAML'
      - $ref: '#/components/schemas/ApplicationOIDC'
      - $ref: '#/components/schemas/ApplicationWSFED'
      - $ref: '#/components/schemas/ApplicationExternalLink'
    createApplication_201_response:
      oneOf:
      - $ref: '#/components/schemas/ApplicationSAML'
      - $ref: '#/components/schemas/ApplicationOIDC'
      - $ref: '#/components/schemas/ApplicationWSFED'
      - $ref: '#/components/schemas/ApplicationExternalLink'
    readOneApplication_200_response:
      oneOf:
      - $ref: '#/components/schemas/ApplicationSAML'
      - $ref: '#/components/schemas/ApplicationOIDC'
      - $ref: '#/components/schemas/ApplicationWSFED'
      - $ref: '#/components/schemas/ApplicationExternalLink'
      - $ref: '#/components/schemas/ApplicationPingOnePortal'
      - $ref: '#/components/schemas/ApplicationPingOneSelfService'
      - $ref: '#/components/schemas/ApplicationPingOneAdminConsole'
    updateApplication_request:
      example:
        name: "UPDATED_{{$timestamp}}"
        description: this is my UPDATED client
        enabled: false
        type: WEB_APP
        protocol: SAML
        assertionDuration: 60
        acsUrls:
        - https://example.com
        sloResponseEndpoint: https://example.com
        spEntityId: test
      oneOf:
      - $ref: '#/components/schemas/ApplicationSAML'
      - $ref: '#/components/schemas/ApplicationOIDC'
      - $ref: '#/components/schemas/ApplicationWSFED'
      - $ref: '#/components/schemas/ApplicationExternalLink'
      - $ref: '#/components/schemas/ApplicationPingOnePortal'
      - $ref: '#/components/schemas/ApplicationPingOneSelfService'
    updateEnvironmentType_request:
      example:
        type: PRODUCTION
      properties:
        type:
          $ref: '#/components/schemas/EnumEnvironmentType'
      type: object
    createGateway_request:
      example:
        name: PING_FED-Gateway
        description: My PingFederate Gateway
        type: PING_FEDERATE
      oneOf:
      - $ref: '#/components/schemas/Gateway'
      - $ref: '#/components/schemas/GatewayTypeLDAP'
      - $ref: '#/components/schemas/GatewayTypeRADIUS'
    createGateway_201_response:
      oneOf:
      - $ref: '#/components/schemas/Gateway'
      - $ref: '#/components/schemas/GatewayTypeLDAP'
      - $ref: '#/components/schemas/GatewayTypeRADIUS'
    LinksHATEOAS_value:
      example:
        href: https://openapi-generator.tech
      properties:
        href:
          description: The HREF of the link.
          format: uri
          type: string
      required:
      - href
      type: object
    AdministratorSecurity_allowedMethods:
      description: "Indicates the methods to enable or disable for admin sign-on.\
        \ Required properties are `TOTP` (temporary one-time password), `FIDO2`, or\
        \ `EMAIL`."
      example:
        TOTP: TOTP
        FIDO2: FIDO2
        EMAIL: EMAIL
      properties:
        EMAIL:
          description: "Indicates whether to enable email for sign-on. Must be set\
            \ to either `{\\\"enabled\\\":true}` or `{\\\"enabled\\\":false}`."
          type: string
        FIDO2:
          description: "Indicates whether to enable FIDO2 for sign-on. Must be set\
            \ to either `{\\\"enabled\\\":true}` or `{\\\"enabled\\\":false}`."
          type: string
        TOTP:
          description: "Indicates whether to enable TOTP for sign-on. Must be set\
            \ to either `{\\\"enabled\\\":true}` or `{\\\"enabled\\\":false}`."
          type: string
      required:
      - EMAIL
      - FIDO2
      - TOTP
      type: object
    AdministratorSecurity_provider:
      example:
        id: id
      properties:
        id:
          description: "The UUID of the external IdP, if applicable."
          type: string
      required:
      - id
      type: object
    AgreementLanguage_agreement:
      example:
        id: id
      properties:
        id:
          description: A read-only string of the ID for the agreement resource for
            this revision.
          type: string
      readOnly: true
      type: object
    AgreementLanguage_currentRevision:
      example:
        id: id
      properties:
        id:
          description: A relationship that specifies the current revision associated
            with this language resource. The current revision is the one shown to
            users for new consents in the language.
          type: string
      readOnly: true
      type: object
    AgreementLanguage_userExperience:
      example:
        acceptCheckboxText: acceptCheckboxText
        declineButtonText: declineButtonText
        continueButtonText: continueButtonText
      properties:
        acceptCheckboxText:
          description: "A string that specifies the text next to the \"accept\" checkbox\
            \ in the end user interface. Accepted character are unicode letters, combining\
            \ marks, numeric characters, whitespace, and punctuation characters (regex\
            \ `^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$`)."
          pattern: "^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$"
          type: string
        continueButtonText:
          description: "A string that specifies the text of the \"continue\" button\
            \ in the end user interface. Accepted character are unicode letters, combining\
            \ marks, numeric characters, whitespace, and punctuation characters (regex\
            \ `^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$`)."
          pattern: "^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$"
          type: string
        declineButtonText:
          description: "A string that specifies the text of the \"decline\" button\
            \ in the end user interface. Accepted character are unicode letters, combining\
            \ marks, numeric characters, whitespace, and punctuation characters (regex\
            \ `^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$`)."
          pattern: "^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}]+$"
          type: string
      type: object
    AgreementLanguageRevision_language:
      example:
        id: id
      properties:
        id:
          description: A relationship that specifies the language resource associated
            with this revision.
          type: string
      readOnly: true
      type: object
    Application_accessControl_role:
      properties:
        type:
          $ref: '#/components/schemas/EnumApplicationAccessControlType'
      required:
      - type
      type: object
    Application_accessControl_group_groups_inner:
      example:
        id: id
      properties:
        id:
          type: string
      required:
      - id
      type: object
    Application_accessControl_group:
      properties:
        type:
          $ref: '#/components/schemas/EnumApplicationAccessControlGroupType'
        groups:
          description: A set that specifies the group IDs for the groups the actor
            must belong to for access to the application.
          items:
            $ref: '#/components/schemas/Application_accessControl_group_groups_inner'
          type: array
      required:
      - groups
      - type
      type: object
    Application_accessControl:
      properties:
        role:
          $ref: '#/components/schemas/Application_accessControl_role'
        group:
          $ref: '#/components/schemas/Application_accessControl_group'
      type: object
    Application_icon:
      description: The HREF and the ID for the application icon.
      properties:
        id:
          type: string
        href:
          type: string
      required:
      - href
      - id
      type: object
    ApplicationSAML_allOf_idpSigning_key:
      properties:
        id:
          description: "A string that specifies the certificate to be used by the\
            \ identity provider to sign assertions and responses. If this property\
            \ is omitted, the default signing certificate for the environment is used."
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationSAML_allOf_idpSigning:
      properties:
        key:
          $ref: '#/components/schemas/ApplicationSAML_allOf_idpSigning_key'
        algorithm:
          $ref: '#/components/schemas/EnumCertificateKeySignagureAlgorithm'
      required:
      - key
      type: object
      example: null
    ApplicationSAML_allOf_spEncryption_certificate:
      description: Contains the ID of the encryption public certificate that has been
        uploaded to PingOne.
      properties:
        id:
          description: Specify the unique identifier of the encryption public certificate
            that has been uploaded to PingOne.
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationSAML_allOf_spEncryption:
      description: Enables PingOne to encrypt SAML assertions to be sent to the application.
        Assertions are not encrypted by default.
      properties:
        algorithm:
          $ref: '#/components/schemas/EnumCertificateKeyEncryptionAlgorithm'
        certificate:
          $ref: '#/components/schemas/ApplicationSAML_allOf_spEncryption_certificate'
      required:
      - algorithm
      - certificate
      type: object
      example: null
    ApplicationSAML_allOf_spVerification_certificates:
      properties:
        id:
          description: An array that specifies the certificate IDs used to verify
            the service provider signature.
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationSAML_allOf_spVerification:
      properties:
        authnRequestSigned:
          default: false
          description: Whether the Authn Request signing should be enforced. Default
            is `false`.
          type: boolean
        certificates:
          items:
            $ref: '#/components/schemas/ApplicationSAML_allOf_spVerification_certificates'
          type: array
      required:
      - certificates
      type: object
      example: null
    ApplicationSAML_allOf_virtualServerIdSettings_virtualServerIds:
      properties:
        vsId:
          description: This must be a valid SAML entity ID.
          type: string
        default:
          description: Indicates whether the virtual server identified by the associated
            `vsId` is to be used as the default virtual server.
          type: boolean
      required:
      - vsId
      type: object
      example: null
    ApplicationSAML_allOf_virtualServerIdSettings:
      description: Contains the virtual server ID or IDs to be used.
      properties:
        enabled:
          default: false
          description: Indicates whether the virtual server ID or IDs specified are
            to be used. Defaults to `false`.
          type: boolean
        virtualServerIds:
          description: Required if `enabled` is `true`. Contains the list of virtual
            ID or IDs to be used.
          items:
            $ref: '#/components/schemas/ApplicationSAML_allOf_virtualServerIdSettings_virtualServerIds'
          type: array
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_passcodeRefreshDuration:
      properties:
        duration:
          default: 30
          description: The amount of time a passcode should be displayed before being
            replaced with a new passcode - must be between 30 and 60.
          maximum: 60
          minimum: 30
          type: integer
        timeUnit:
          $ref: '#/components/schemas/EnumPasscodeRefreshTimeUnit'
      required:
      - duration
      - timeUnit
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_integrityDetection_cacheDuration:
      properties:
        amount:
          description: "An integer that specifies the number of minutes or hours that\
            \ specify the duration between successful integrity detection calls. Every\
            \ attestation request entails a certain time tradeoff. You can choose\
            \ to cache successful integrity detection calls for a predefined duration,\
            \ between a minimum of 1 minute and a maximum of 48 hours. If mobile.integrityDetection.mode\
            \ is ENABLED, the cache duration must be set."
          type: integer
        units:
          $ref: '#/components/schemas/EnumDurationUnitMinsHours'
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_integrityDetection_googlePlay:
      description: Object that contains the credentials required for using Google's
        Play Integrity API for integrity detection.  Required if `excludedPlatforms`
        does not contain `GOOGLE`.
      properties:
        decryptionKey:
          description: Play Integrity verdict decryption key from your Google Play
            Services account. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType`
            to `INTERNAL`.
          format: password
          type: string
        serviceAccountCredentials:
          description: Contents of the JSON file that represents your Service Account
            Credentials. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType`
            to `GOOGLE`.
          format: password
          type: string
        verificationKey:
          description: Play Integrity verdict signature verification key from your
            Google Play Services account. This parameter must be provided if you have
            set `mobile.integrityDetection.googlePlay.verificationType` to `INTERNAL`.
          format: password
          type: string
        verificationType:
          $ref: '#/components/schemas/EnumApplicationNativeGooglePlayVerificationType'
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_integrityDetection:
      properties:
        excludedPlatforms:
          description: "You can enable device integrity checking separately for Android\
            \ and iOS by setting `mobile.integrityDetection.mode` to `ENABLED` and\
            \ then using `mobile.integrityDetection.excludedPlatforms` to specify\
            \ the OS where you do not want to use device integrity checking. The values\
            \ to use are `GOOGLE` and `IOS` (all upper case). Note that this is implemented\
            \ as an array even though currently you can only include a single value.\
            \  If `GOOGLE` is not included as a value, `googlePlay` is required to\
            \ be set."
          items:
            $ref: '#/components/schemas/EnumMobileIntegrityDetectionPlatform'
          maxItems: 1
          type: array
        mode:
          $ref: '#/components/schemas/EnumEnabledStatus'
        cacheDuration:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_integrityDetection_cacheDuration'
        googlePlay:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_integrityDetection_googlePlay'
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_push_numberMatching:
      properties:
        type:
          $ref: '#/components/schemas/EnumApplicationPushNumberMatchingType'
      type: object
      example: null
    ApplicationOIDC_allOf_mobile_push:
      properties:
        numberMatching:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_push_numberMatching'
      type: object
      example: null
    ApplicationOIDC_allOf_mobile:
      properties:
        bundleId:
          description: "A string that specifies the bundle associated with the application,\
            \ for push notifications in native apps. The value of the bundleId property\
            \ is unique per environment, and once defined, is immutable.  this setting\
            \ overrides the top-level bundleId field"
          type: string
        packageName:
          description: "A string that specifies the package name associated with the\
            \ application, for push notifications in native apps. The value of the\
            \ mobile.packageName property is unique per environment, and once defined,\
            \ is immutable.  this setting overrides the top-level packageName field."
          type: string
        huaweiAppId:
          description: "The unique identifier for the app on the device and in the\
            \ Huawei Mobile Service AppGallery. The value of the `huaweiAppId` property\
            \ is unique per environment, and once defined, is immutable. Used only\
            \ for applications for the Huawei ecosystem."
          type: string
        huaweiPackageName:
          description: "The package name associated with the application, for push\
            \ notifications in native apps. The value of the `huaweiPackageName` property\
            \ is unique per environment, and once defined, is immutable. Used only\
            \ for applications for the Huawei ecosystem."
          type: string
        passcodeGracePeriod:
          description: "To cover time synchronization issues, you can use this field\
            \ to customize the grace period during which the passcode can still be\
            \ used even after the passcode has been refreshed. The value of the parameter\
            \ should be the number of windows to use (min 1, max 10). In this context,\
            \ a window is equal to the passcode refresh period in either direction.\
            \ For example, if you defined a passcode refresh duration of 30 seconds\
            \ and a grace period of 2 windows, the passcode is valid for 150 seconds\
            \ (from 60 seconds behind the time of issue until 60 seconds past the\
            \ expiration time). When this field is not included, the default value\
            \ used is 5 windows."
          type: integer
        passcodeRefreshDuration:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_passcodeRefreshDuration'
        integrityDetection:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_integrityDetection'
        push:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_mobile_push'
        uriPrefix:
          description: "A string that specifies a URI prefix that enables direct triggering\
            \ of the mobile application when scanning a QR code. The URI prefix can\
            \ be set to a universal link with a valid value (which can be a URL address\
            \ that starts with `HTTP://` or `HTTPS://`, such as `https://www.acme.com`),\
            \ or an app schema, which is just a string and requires no special validation."
          type: string
      type: object
      example: null
    ApplicationOIDC_allOf_kerberos_key:
      description: A Relationship object containing the certificate issuer (root CA).
      properties:
        id:
          description: The unique identifier for the Kerberos key.
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationOIDC_allOf_kerberos:
      description: Object containing Kerberos settings
      properties:
        key:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_kerberos_key'
      required:
      - key
      type: object
      example: null
    ApplicationOIDC_allOf_signing_keyRotationPolicy:
      description: Contains the Key Rotation Policy (KRP) ID. This property is required
        if `signing` is set.
      properties:
        id:
          description: Reference to a KRP ID from certificate management. This property
            is required if `signing` is set.
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationOIDC_allOf_signing:
      description: "Configuration for the signing key. If absent, application tokens\
        \ will be signed and verified by the PingOne default key at runtime. This\
        \ property only applies to OIDC applications of type `WEB_APP`, `NATIVE_APP`,\
        \ `SINGLE_PAGE_APP`, and `CUSTOM_APP`."
      properties:
        keyRotationPolicy:
          $ref: '#/components/schemas/ApplicationOIDC_allOf_signing_keyRotationPolicy'
      required:
      - keyRotationPolicy
      type: object
      example: null
    ApplicationAttributeMapping_application:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the application associated with the
            application mapping resource.
          type: string
      readOnly: true
      type: object
    ApplicationResourceGrant_application:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the application resource ID.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ApplicationResourceGrant_resource:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the ID of the protected resource associated
            with this grant. This is a required property.
          type: string
      required:
      - id
      type: object
    ApplicationResourceGrant_scopes_inner:
      example:
        id: id
      properties:
        id:
          description: "id\tA array that specifies the IDs of the scopes associated\
            \ with this grant. This is a required property."
          type: string
      required:
      - id
      type: object
    ApplicationSecret_previous:
      example:
        lastUsed: 2000-01-23T04:56:07.000+00:00
        secret: secret
        expiresAt: 2000-01-23T04:56:07.000+00:00
      properties:
        secret:
          description: A string that specifies the previous application secret. This
            property is returned in the response if the previous secret is not expired.
          format: password
          readOnly: true
          type: string
        expiresAt:
          description: A timestamp that specifies how long this secret is saved (and
            can be used) before it expires. Supported time range is 1 minute to 30
            days.
          format: date-time
          type: string
        lastUsed:
          description: A timestamp that specifies when the previous secret was last
            used.
          format: date-time
          readOnly: true
          type: string
      required:
      - expiresAt
      type: object
    ApplicationTemplate_integration:
      properties:
        id:
          description: The UUID of the integration in Integration Catalog.
          type: string
      required:
      - id
      type: object
    ApplicationTemplate_version:
      properties:
        id:
          description: The UUID of the integration version in Integration Catalog.
          type: string
      required:
      - id
      type: object
    ApplicationWSFED_allOf_idpSigning_key:
      description: "The keypair to be used by the IdP to sign requests. If this isn't\
        \ specified, the default signing certificate for the environment is used."
      properties:
        id:
          description: The ID of the key specified for `idpSigning.key`.
          type: string
      required:
      - id
      type: object
      example: null
    ApplicationWSFED_allOf_idpSigning:
      description: Contains the information about the signing of requests by the identity
        provider (IdP).
      properties:
        algorithm:
          $ref: '#/components/schemas/EnumApplicationWSFEDIDPSigningAlgorithm'
        key:
          $ref: '#/components/schemas/ApplicationWSFED_allOf_idpSigning_key'
      required:
      - algorithm
      - key
      type: object
      example: null
    ApplicationWSFED_allOf_kerberos_userType:
      properties:
        id:
          description: The UUID of a user type in the list of `userTypes` for the
            LDAP gateway.
          type: string
      type: object
      example: null
    ApplicationWSFED_allOf_kerberos_gateways:
      properties:
        id:
          description: The UUID of the LDAP gateway.
          type: string
        type:
          $ref: '#/components/schemas/EnumApplicationWSFEDKerberosGatewayType'
        userType:
          $ref: '#/components/schemas/ApplicationWSFED_allOf_kerberos_userType'
      required:
      - id
      - type
      - userType
      type: object
      example: null
    ApplicationWSFED_allOf_kerberos:
      description: Contains the Kerberos authentication settings. Set this to null
        to disable Kerberos authentication.
      properties:
        gateways:
          description: Contains the gateway properties.
          items:
            $ref: '#/components/schemas/ApplicationWSFED_allOf_kerberos_gateways'
          type: array
      type: object
      example: null
    BillOfMaterials_products_inner_console:
      example:
        href: href
      properties:
        href:
          description: Primary console link for certain products
          type: string
      required:
      - href
      type: object
    BillOfMaterials_products_inner_deployment:
      example:
        id: id
      properties:
        id:
          description: The ID of the PingID deployment
          readOnly: true
          type: string
      type: object
    BillOfMaterials_products_inner_bookmarks_inner:
      example:
        name: name
        href: href
      properties:
        name:
          description: Name of the custom bookmark. The name must be unique among
            the product bookmarks and be 50 characters or fewer.
          type: string
        href:
          description: A valid URL for the bookmark.
          type: string
      required:
      - href
      - name
      type: object
    BillOfMaterials_products_inner:
      example:
        bookmarks:
        - name: name
          href: href
        - name: name
          href: href
        console:
          href: href
        description: description
        id: id
        type: null
        tags:
        - null
        - null
        deployment:
          id: id
      properties:
        id:
          description: A string that specifies the BOM ID
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/EnumProductType'
        description:
          description: A string that specifies the description of the product or standalone
            service
          readOnly: true
          type: string
        console:
          $ref: '#/components/schemas/BillOfMaterials_products_inner_console'
        tags:
          items:
            $ref: '#/components/schemas/EnumBillOfMaterialsProductTags'
          type: array
        deployment:
          $ref: '#/components/schemas/BillOfMaterials_products_inner_deployment'
        bookmarks:
          description: Optional array of custom bookmarks. Maximum of five bookmarks
            per product.
          items:
            $ref: '#/components/schemas/BillOfMaterials_products_inner_bookmarks_inner'
          type: array
      required:
      - type
      type: object
    BrandingSettings_logo:
      example:
        href: href
        id: id
      properties:
        href:
          description: The URL or fully qualified path to the logo file used for branding.
          type: string
        id:
          description: The ID of the logo image.
          type: string
      required:
      - href
      - id
      type: object
    BrandingTheme_configuration_backgroundImage:
      example:
        href: href
        id: id
      properties:
        href:
          description: The URL or fully qualified path to the background image file
            used for branding. This is a required property when configuration.backgroundType
            is set to IMAGE.
          type: string
        id:
          description: The ID of the background image.
          type: string
      required:
      - href
      - id
      type: object
    BrandingTheme_configuration_logo:
      example:
        href: href
        id: id
      properties:
        href:
          description: The URL or fully qualified path to the logo file used for branding.
            This is a required property when configuration.logoType is set to IMAGE.
          type: string
        id:
          description: The ID of the logo image.
          type: string
      required:
      - href
      - id
      type: object
    BrandingTheme_configuration:
      example:
        logoHeight: logoHeight
        titleTextColor: titleTextColor
        linkTextSize: linkTextSize
        inputBoxBorderColor: inputBoxBorderColor
        buttonTextSize: buttonTextSize
        buttonCornerRadius: buttonCornerRadius
        headingTextColor: headingTextColor
        inputCornerRadius: inputCornerRadius
        logo:
          href: href
          id: id
        titleTextSize: titleTextSize
        buttonHoverStateBorderColor: buttonHoverStateBorderColor
        backgroundType: null
        buttonTextWeight: buttonTextWeight
        cardLogoAlignment: cardLogoAlignment
        bodyTextWeight: bodyTextWeight
        buttonHoverStateFillColor: buttonHoverStateFillColor
        bodyTextSize: bodyTextSize
        headerLocalized:
          defaultLanguage: defaultLanguage
          contentType: null
          enabled: true
          content:
            key:
              inputText: inputText
              contentType: null
        subTitleTextWeight: subTitleTextWeight
        inputValueTextColor: inputValueTextColor
        inputLabelTextSize: inputLabelTextSize
        inputLabelTextColor: inputLabelTextColor
        name: name
        header: header
        buttonBorderWidth: buttonBorderWidth
        cardHorizontalAlignment: cardHorizontalAlignment
        cardShadow: cardShadow
        headerBackgroundColor: headerBackgroundColor
        buttonColor: buttonColor
        buttonBorderColor: buttonBorderColor
        footer: footer
        backgroundImage:
          href: href
          id: id
        cardBorderColor: cardBorderColor
        inputBorderWidth: inputBorderWidth
        cardVerticalAlignment: cardVerticalAlignment
        subTitleTextSize: subTitleTextSize
        inputLabelTextWeight: inputLabelTextWeight
        footerLocalized:
          defaultLanguage: defaultLanguage
          contentType: null
          enabled: true
          content:
            key:
              inputText: inputText
              contentType: null
        buttonTextColor: buttonTextColor
        globalFont: globalFont
        logoType: null
        backgroundOutlineColor: backgroundOutlineColor
        inputLabelPosition: inputLabelPosition
        backgroundColor: backgroundColor
        foregroundMainColor: foregroundMainColor
        subTitleTextColor: subTitleTextColor
        schemaVersion: 0
        titleTextWeight: titleTextWeight
        cardCornerRadius: cardCornerRadius
        inputValueTextSize: inputValueTextSize
        inputValueTextWeight: inputValueTextWeight
        cardColor: cardColor
        applicationBackgroundColor: applicationBackgroundColor
        buttonHoverStateTextColor: buttonHoverStateTextColor
        linkTextWeight: linkTextWeight
        linkTextHoverColor: linkTextHoverColor
        linkTextColor: linkTextColor
        bodyTextColor: bodyTextColor
        foregroundHighlightColor: foregroundHighlightColor
        cardBorderWidth: cardBorderWidth
        focusRectangleColor: focusRectangleColor
      properties:
        backgroundColor:
          description: "The background color for the theme. It must be a valid hexadecimal\
            \ color code, and it is a required property when configuration.backgroundType\
            \ is set to COLOR."
          type: string
        backgroundOutlineColor:
          description: "For PingOne Neo verification presentation screen, the outline\
            \ color of background objects for the branding theme. It must be a valid\
            \ hexadecimal color code. Defaults to"
          type: string
        backgroundType:
          $ref: '#/components/schemas/EnumBrandingThemeBackgroundType'
        backgroundImage:
          $ref: '#/components/schemas/BrandingTheme_configuration_backgroundImage'
        applicationBackgroundColor:
          description: The application background color for the theme. It must be
            a valid hexadecimal color code. Note that this property is not used by
            DaVinci forms.
          type: string
        bodyTextColor:
          description: The body text color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        bodyTextSize:
          description: The body text size for the theme.
          type: string
        bodyTextWeight:
          description: The body text weight for the theme (range from 100-900).
          type: string
        buttonColor:
          description: The button color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        buttonBorderColor:
          description: The button border color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        buttonCornerRadius:
          description: The button corner radius for the theme (range from 0-25px).
          type: string
        buttonBorderWidth:
          description: The button border width for the theme (range from 0-4px).
          type: string
        buttonHoverStateBorderColor:
          description: The button hover state border color for the theme. It must
            be a valid hexadecimal color code.
          type: string
        buttonHoverStateFillColor:
          description: The button hover state fill color for the theme. It must be
            a valid hexadecimal color code.
          type: string
        buttonHoverStateTextColor:
          description: The button hover state text color for the theme. It must be
            a valid hexadecimal color code.
          type: string
        buttonTextColor:
          description: The button text color for the branding theme. It must be a
            valid hexadecimal color code.
          type: string
        buttonTextSize:
          description: The button text size for the theme.
          type: string
        buttonTextWeight:
          description: The button text weight for the theme (range from 100-900).
          type: string
        cardColor:
          description: The card color for the branding theme. It must be a valid hexadecimal
            color code.
          type: string
        cardBorderColor:
          description: The card border color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        cardBorderWidth:
          description: The card border width for the theme (range from 0-4px).
          type: string
        cardCornerRadius:
          description: The card corner radius for the theme (range from 0-25px).
          type: string
        cardHorizontalAlignment:
          description: The card horizontal alignment for the theme.
          type: string
        cardLogoAlignment:
          description: The card logo alignment for the theme.
          type: string
        cardShadow:
          description: The card shadow for the theme.
          type: string
        cardVerticalAlignment:
          description: The card vertical alignment for the theme.
          type: string
        focusRectangleColor:
          description: The focus rectangle color for the theme. It must be a valid
            hexadecimal color code.
          type: string
        footer:
          description: The footer of the branding theme.
          type: string
        footerLocalized:
          $ref: '#/components/schemas/BrandingThemeConfigurationLocalizedText'
        foregroundHighlightColor:
          description: "For PingOne Neo verification presentation screen, the highlight\
            \ color of the foreground object for the branding theme. It must be a\
            \ valid hexadecimal color code. Defaults to"
          type: string
        foregroundMainColor:
          description: "For PingOne Neo verification presentation screen, the outline\
            \ color of the foreground object for the branding theme. It must be a\
            \ valid hexadecimal color code. Defaults to"
          type: string
        globalFont:
          description: "The global font for the theme. The default value is `Helvetica\
            \ Neue, Helvetica, sans-serif`."
          type: string
        header:
          description: "The header for the theme. For example, \"<h1>Welcome to PingOne<h1>\"\
            ."
          type: string
        headerBackgroundColor:
          description: The header background color for the theme. It must be a valid
            hexadecimal color code. Note that this property is not used by DaVinci
            forms.
          type: string
        headerLocalized:
          $ref: '#/components/schemas/BrandingThemeConfigurationLocalizedText'
        headingTextColor:
          description: The heading text color for the branding theme. It must be a
            valid hexadecimal color code.
          type: string
        inputBorderWidth:
          description: The input border width for the theme (range from 0-4px).
          type: string
        inputBoxBorderColor:
          description: The input box border color for the theme. It must be a valid
            hexadecimal color code.
          type: string
        inputCornerRadius:
          description: The input corner radius for the theme (range from 0-25px).
          type: string
        inputLabelPosition:
          description: The input label position for the theme.
          type: string
        inputLabelTextColor:
          description: The input label text color for the theme. It must be a valid
            hexadecimal color code.
          type: string
        inputLabelTextSize:
          description: The input label text size for the theme.
          type: string
        inputLabelTextWeight:
          description: The input label text weight for the theme (range from 100-900).
          type: string
        inputValueTextColor:
          description: The input value text color for the theme. It must be a valid
            hexadecimal color code.
          type: string
        inputValueTextSize:
          description: The input value text size for the theme.
          type: string
        inputValueTextWeight:
          description: The input value text weight for the theme (range from 100-900).
          type: string
        linkTextColor:
          description: The hyperlink text color for the branding theme. It must be
            a valid hexadecimal color code.
          type: string
        linkTextHoverColor:
          description: The link text hover color for the theme. It must be a valid
            hexadecimal color code.
          type: string
        linkTextSize:
          description: The link text size for the theme.
          type: string
        linkTextWeight:
          description: The link text weight for the theme (range from 100-900).
          type: string
        logo:
          $ref: '#/components/schemas/BrandingTheme_configuration_logo'
        logoHeight:
          description: The logo height assigned to the image (range from 0-100px).
          type: string
        logoType:
          $ref: '#/components/schemas/EnumBrandingLogoType'
        name:
          description: The name of the branding theme.
          type: string
        schemaVersion:
          description: The schema version number for the theme.
          readOnly: true
          type: integer
        subTitleTextColor:
          description: The subtitle text color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        subTitleTextSize:
          description: The subtitle text size for the theme.
          type: string
        subTitleTextWeight:
          description: The subtitle text weight for the theme (range from 100-900).
          type: string
        titleTextColor:
          description: The title text color for the theme. It must be a valid hexadecimal
            color code.
          type: string
        titleTextSize:
          description: The title text size for the theme.
          type: string
        titleTextWeight:
          description: The title text weight for the theme (range from 100-900).
          type: string
      required:
      - backgroundType
      - bodyTextColor
      - buttonColor
      - buttonTextColor
      - cardColor
      - headingTextColor
      - linkTextColor
      - logoType
      type: object
    CustomAdminRole_canAssign_inner:
      example:
        id: id
      properties:
        id:
          description: The unique identifier of the actor.
          type: string
      required:
      - id
      type: object
    CustomAdminRole_permissions_inner:
      example:
        id: id
      properties:
        id:
          description: The unique identifier of the permission (e.g. `permissions:read:userRoleAssignments`).
          type: string
      required:
      - id
      type: object
    CustomDomain_certificate:
      description: "An object that specifies information about the SSL certificate\
        \ used by this custom domain. If this property is not present, it indicates\
        \ that an SSL certificate has not been setup for this custom domain."
      example:
        expiresAt: 2000-01-23T04:56:07.000+00:00
      properties:
        expiresAt:
          description: The time when the certificate expires.
          format: date-time
          readOnly: true
          type: string
      readOnly: true
      type: object
    EmailDomainDKIMStatus_regions_inner_tokens_inner:
      example:
        value: value
        key: key
      properties:
        key:
          description: Record name.
          type: string
        value:
          description: Record value.
          type: string
      type: object
    EmailDomainDKIMStatus_regions_inner:
      example:
        name: name
        tokens:
        - value: value
          key: key
        - value: value
          key: key
        status: null
      properties:
        name:
          description: The name of the region.
          type: string
        status:
          $ref: '#/components/schemas/EnumEmailDomainStatus'
        tokens:
          description: A collection of key and value pairs.
          items:
            $ref: '#/components/schemas/EmailDomainDKIMStatus_regions_inner_tokens_inner'
          type: array
      type: object
    EmailDomainOwnershipStatus_regions_inner:
      example:
        name: name
        value: value
        key: key
        status: null
      properties:
        name:
          description: The name of the region.
          type: string
        status:
          $ref: '#/components/schemas/EnumEmailDomainStatus'
        key:
          description: Record name.
          type: string
        value:
          description: Record value.
          type: string
      type: object
    EmailDomainOwnershipStatus_environmentDnsRecord:
      description: "Contains a key-value pair for a text record that reflects the\
        \ association of the domain with the specific PingOne environment. If you\
        \ add this record to your DNS, any sender email address belonging to the domain\
        \ is set to active status as soon as you create it, with no need for a verification\
        \ email. In the initial call to check ownership status, \"status\" is returned\
        \ with the value \"VERIFICATION_REQUIRED\". If you add the record to your\
        \ DNS, the next time you use the ownership endpoint to check ownership status,\
        \ the value returned for \"status\" will be \"ACTIVE\"."
      example:
        value: value
        key: key
        status: null
      properties:
        status:
          $ref: '#/components/schemas/EnumEmailDomainStatus'
        key:
          description: Record name.
          type: string
        value:
          description: Record value.
          type: string
      readOnly: true
      type: object
    EmailDomainTrustedEmail_domain:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the trusted email domain resource’s
            unique identifier associated with the resource.
          type: string
      readOnly: true
      type: object
    EntityArray__embedded_attributes_inner:
      oneOf:
      - $ref: '#/components/schemas/ApplicationAttributeMapping'
      - $ref: '#/components/schemas/IdentityProviderAttribute'
      - $ref: '#/components/schemas/SchemaAttribute'
      - $ref: '#/components/schemas/ResourceAttribute'
      - $ref: '#/components/schemas/IntegrationVersionAttribute'
    EntityArray__embedded_gateways_inner:
      anyOf:
      - $ref: '#/components/schemas/Gateway'
      - $ref: '#/components/schemas/GatewayTypeLDAP'
      - $ref: '#/components/schemas/GatewayTypeRADIUS'
    EntityArray__embedded_languages_inner:
      oneOf:
      - $ref: '#/components/schemas/AgreementLanguage'
      - $ref: '#/components/schemas/Language'
    EntityArray__embedded_resources_inner:
      oneOf:
      - $ref: '#/components/schemas/Resource'
      - $ref: '#/components/schemas/ResourceApplicationResource'
    EntityArray__embedded_roles_inner:
      oneOf:
      - $ref: '#/components/schemas/Role'
      - $ref: '#/components/schemas/UserApplicationRoleAssignment'
      - $ref: '#/components/schemas/CustomAdminRole'
    EntityArray__embedded:
      example:
        flowPolicies:
        - environment:
            id: id
          application:
            name: name
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          id: id
          trigger:
            type: null
          enabled: true
        - environment:
            id: id
          application:
            name: name
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          id: id
          trigger:
            type: null
          enabled: true
        subscriptions:
        - _links:
            key:
              href: https://openapi-generator.tech
          format: null
          tlsClientAuthKeyPair:
            id: id
          payloadOptions:
            maximumPayloadLimit:
              size: 4
              type: null
            payloadFormat:
              tcp:
                format: null
                additionalAttributes:
                  key: additionalAttributes
              https:
                prettyPrint: true
                format: null
          connectionDetails:
            headers:
              key: headers
            url: url
          enabled: true
          verifyTlsCertificates: true
          createdAt: 2000-01-23T04:56:07.000+00:00
          environment:
            id: id
          protocol: null
          httpEndpoint:
            headers:
              key: headers
            url: url
          name: name
          id: id
          filterOptions:
            includedActionTypes:
            - includedActionTypes
            - includedActionTypes
            includedTags:
            - null
            - null
            userAgentExposed: false
            includedPopulations:
            - id: id
            - id: id
            ipAddressExposed: false
            includedApplications:
            - id: id
            - id: id
          updatedAt: 2000-01-23T04:56:07.000+00:00
        - _links:
            key:
              href: https://openapi-generator.tech
          format: null
          tlsClientAuthKeyPair:
            id: id
          payloadOptions:
            maximumPayloadLimit:
              size: 4
              type: null
            payloadFormat:
              tcp:
                format: null
                additionalAttributes:
                  key: additionalAttributes
              https:
                prettyPrint: true
                format: null
          connectionDetails:
            headers:
              key: headers
            url: url
          enabled: true
          verifyTlsCertificates: true
          createdAt: 2000-01-23T04:56:07.000+00:00
          environment:
            id: id
          protocol: null
          httpEndpoint:
            headers:
              key: headers
            url: url
          name: name
          id: id
          filterOptions:
            includedActionTypes:
            - includedActionTypes
            - includedActionTypes
            includedTags:
            - null
            - null
            userAgentExposed: false
            includedPopulations:
            - id: id
            - id: id
            ipAddressExposed: false
            includedApplications:
            - id: id
            - id: id
          updatedAt: 2000-01-23T04:56:07.000+00:00
        credentials:
        - createdAt: 2000-01-23T04:56:07.000+00:00
          credential: credential
          lastUsedAt: 2000-01-23T04:56:07.000+00:00
          id: id
        - createdAt: 2000-01-23T04:56:07.000+00:00
          credential: credential
          lastUsedAt: 2000-01-23T04:56:07.000+00:00
          id: id
        environments:
        - name: New-Env
          description: New environment description
          type: SANDBOX
          region: EU
          billOfMaterials:
            products:
              type: PING_ONE_BASE
              description: New environment product description
              console:
                href: https://example.com
          license:
            id: 34f0efac-21d9-4a17-8a35-196bb3362983
        - name: New-Env
          description: New environment description
          type: SANDBOX
          region: EU
          billOfMaterials:
            products:
              type: PING_ONE_BASE
              description: New environment product description
              console:
                href: https://example.com
          license:
            id: 34f0efac-21d9-4a17-8a35-196bb3362983
        keys:
        - customCRL: customCRL
          serialNumber: 5
          _links:
            key:
              href: https://openapi-generator.tech
          issuerDN: issuerDN
          expiresAt: 2000-01-23T04:56:07.000+00:00
          signatureAlgorithm: null
          validityPeriod: 1
          createdAt: 2000-01-23T04:56:07.000+00:00
          default: true
          environment:
            id: id
          keyLength: 5
          organization:
            id: id
          name: name
          startsAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          status: null
          subjectDN: subjectDN
          usageType: null
        - customCRL: customCRL
          serialNumber: 5
          _links:
            key:
              href: https://openapi-generator.tech
          issuerDN: issuerDN
          expiresAt: 2000-01-23T04:56:07.000+00:00
          signatureAlgorithm: null
          validityPeriod: 1
          createdAt: 2000-01-23T04:56:07.000+00:00
          default: true
          environment:
            id: id
          keyLength: 5
          organization:
            id: id
          name: name
          startsAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          status: null
          subjectDN: subjectDN
          usageType: null
        roles:
        - null
        - null
        alertChannels:
        - environment:
            id: id
          addresses:
          - addresses
          - addresses
          includeAlertTypes:
          - null
          - null
          _links:
            key:
              href: https://openapi-generator.tech
          alertName: alertName
          includeSeverities:
          - null
          - null
          channelType: null
          excludeAlertTypes:
          - null
          - null
          id: id
        - environment:
            id: id
          addresses:
          - addresses
          - addresses
          includeAlertTypes:
          - null
          - null
          _links:
            key:
              href: https://openapi-generator.tech
          alertName: alertName
          includeSeverities:
          - null
          - null
          channelType: null
          excludeAlertTypes:
          - null
          - null
          id: id
        signOnPolicies:
        - createdAt: createdAt
          default: false
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          description: description
          id: id
          updatedAt: updatedAt
        - createdAt: createdAt
          default: false
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          description: description
          id: id
          updatedAt: updatedAt
        themes:
        - template: null
          default: true
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          configuration:
            logoHeight: logoHeight
            titleTextColor: titleTextColor
            linkTextSize: linkTextSize
            inputBoxBorderColor: inputBoxBorderColor
            buttonTextSize: buttonTextSize
            buttonCornerRadius: buttonCornerRadius
            headingTextColor: headingTextColor
            inputCornerRadius: inputCornerRadius
            logo:
              href: href
              id: id
            titleTextSize: titleTextSize
            buttonHoverStateBorderColor: buttonHoverStateBorderColor
            backgroundType: null
            buttonTextWeight: buttonTextWeight
            cardLogoAlignment: cardLogoAlignment
            bodyTextWeight: bodyTextWeight
            buttonHoverStateFillColor: buttonHoverStateFillColor
            bodyTextSize: bodyTextSize
            headerLocalized:
              defaultLanguage: defaultLanguage
              contentType: null
              enabled: true
              content:
                key:
                  inputText: inputText
                  contentType: null
            subTitleTextWeight: subTitleTextWeight
            inputValueTextColor: inputValueTextColor
            inputLabelTextSize: inputLabelTextSize
            inputLabelTextColor: inputLabelTextColor
            name: name
            header: header
            buttonBorderWidth: buttonBorderWidth
            cardHorizontalAlignment: cardHorizontalAlignment
            cardShadow: cardShadow
            headerBackgroundColor: headerBackgroundColor
            buttonColor: buttonColor
            buttonBorderColor: buttonBorderColor
            footer: footer
            backgroundImage:
              href: href
              id: id
            cardBorderColor: cardBorderColor
            inputBorderWidth: inputBorderWidth
            cardVerticalAlignment: cardVerticalAlignment
            subTitleTextSize: subTitleTextSize
            inputLabelTextWeight: inputLabelTextWeight
            footerLocalized:
              defaultLanguage: defaultLanguage
              contentType: null
              enabled: true
              content:
                key:
                  inputText: inputText
                  contentType: null
            buttonTextColor: buttonTextColor
            globalFont: globalFont
            logoType: null
            backgroundOutlineColor: backgroundOutlineColor
            inputLabelPosition: inputLabelPosition
            backgroundColor: backgroundColor
            foregroundMainColor: foregroundMainColor
            subTitleTextColor: subTitleTextColor
            schemaVersion: 0
            titleTextWeight: titleTextWeight
            cardCornerRadius: cardCornerRadius
            inputValueTextSize: inputValueTextSize
            inputValueTextWeight: inputValueTextWeight
            cardColor: cardColor
            applicationBackgroundColor: applicationBackgroundColor
            buttonHoverStateTextColor: buttonHoverStateTextColor
            linkTextWeight: linkTextWeight
            linkTextHoverColor: linkTextHoverColor
            linkTextColor: linkTextColor
            bodyTextColor: bodyTextColor
            foregroundHighlightColor: foregroundHighlightColor
            cardBorderWidth: cardBorderWidth
            focusRectangleColor: focusRectangleColor
          modified: 2000-01-23T04:56:07.000+00:00
          id: id
        - template: null
          default: true
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          configuration:
            logoHeight: logoHeight
            titleTextColor: titleTextColor
            linkTextSize: linkTextSize
            inputBoxBorderColor: inputBoxBorderColor
            buttonTextSize: buttonTextSize
            buttonCornerRadius: buttonCornerRadius
            headingTextColor: headingTextColor
            inputCornerRadius: inputCornerRadius
            logo:
              href: href
              id: id
            titleTextSize: titleTextSize
            buttonHoverStateBorderColor: buttonHoverStateBorderColor
            backgroundType: null
            buttonTextWeight: buttonTextWeight
            cardLogoAlignment: cardLogoAlignment
            bodyTextWeight: bodyTextWeight
            buttonHoverStateFillColor: buttonHoverStateFillColor
            bodyTextSize: bodyTextSize
            headerLocalized:
              defaultLanguage: defaultLanguage
              contentType: null
              enabled: true
              content:
                key:
                  inputText: inputText
                  contentType: null
            subTitleTextWeight: subTitleTextWeight
            inputValueTextColor: inputValueTextColor
            inputLabelTextSize: inputLabelTextSize
            inputLabelTextColor: inputLabelTextColor
            name: name
            header: header
            buttonBorderWidth: buttonBorderWidth
            cardHorizontalAlignment: cardHorizontalAlignment
            cardShadow: cardShadow
            headerBackgroundColor: headerBackgroundColor
            buttonColor: buttonColor
            buttonBorderColor: buttonBorderColor
            footer: footer
            backgroundImage:
              href: href
              id: id
            cardBorderColor: cardBorderColor
            inputBorderWidth: inputBorderWidth
            cardVerticalAlignment: cardVerticalAlignment
            subTitleTextSize: subTitleTextSize
            inputLabelTextWeight: inputLabelTextWeight
            footerLocalized:
              defaultLanguage: defaultLanguage
              contentType: null
              enabled: true
              content:
                key:
                  inputText: inputText
                  contentType: null
            buttonTextColor: buttonTextColor
            globalFont: globalFont
            logoType: null
            backgroundOutlineColor: backgroundOutlineColor
            inputLabelPosition: inputLabelPosition
            backgroundColor: backgroundColor
            foregroundMainColor: foregroundMainColor
            subTitleTextColor: subTitleTextColor
            schemaVersion: 0
            titleTextWeight: titleTextWeight
            cardCornerRadius: cardCornerRadius
            inputValueTextSize: inputValueTextSize
            inputValueTextWeight: inputValueTextWeight
            cardColor: cardColor
            applicationBackgroundColor: applicationBackgroundColor
            buttonHoverStateTextColor: buttonHoverStateTextColor
            linkTextWeight: linkTextWeight
            linkTextHoverColor: linkTextHoverColor
            linkTextColor: linkTextColor
            bodyTextColor: bodyTextColor
            foregroundHighlightColor: foregroundHighlightColor
            cardBorderWidth: cardBorderWidth
            focusRectangleColor: focusRectangleColor
          modified: 2000-01-23T04:56:07.000+00:00
          id: id
        customDomains:
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          domainName: domainName
          certificate:
            expiresAt: 2000-01-23T04:56:07.000+00:00
          id: id
          canonicalName: canonicalName
          status: null
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          domainName: domainName
          certificate:
            expiresAt: 2000-01-23T04:56:07.000+00:00
          id: id
          canonicalName: canonicalName
          status: null
        permissions:
        - resource:
            name: name
            id: id
          resourceServer:
            environment:
              id: id
            id: id
          action: action
          description: description
          id: id
          key: key
        - resource:
            name: name
            id: id
          resourceServer:
            environment:
              id: id
            id: id
          action: action
          description: description
          id: id
          key: key
        translations:
        - translatedText: translatedText
          referenceText: referenceText
          shortKey: shortKey
          id: id
          key: key
        - translatedText: translatedText
          referenceText: referenceText
          shortKey: shortKey
          id: id
          key: key
        passwordPolicies:
        - populationCount: 3
          _links:
            key:
              href: https://openapi-generator.tech
          description: description
          excludesCommonlyUsed: true
          minComplexity: 4
          createdAt: createdAt
          default: true
          minUniqueCharacters: 8
          maxAgeDays: 1
          id: id
          maxRepeatedCharacters: 3
          shiftedNumberRowSequenceRule:
            maxLength: 3
          updatedAt: updatedAt
          minCharacters:
            "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
            "0123456789": 6
            ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
            abcdefghijklmnopqrstuvwxyz: 7
          length:
            min: 24
            max: 6
          notSimilarToCurrent: true
          alphabetSequenceRule:
            maxLength: 2
          history:
            retentionDays: 1
            count: 1
          qwertySequenceRule:
            maxLength: 3
          excludesProfileData: true
          environment:
            id: id
          numberSequenceRule:
            maxLength: 2
          lockout:
            durationSeconds: 1
            failureCount: 1
          name: name
          minAgeDays: 1
        - populationCount: 3
          _links:
            key:
              href: https://openapi-generator.tech
          description: description
          excludesCommonlyUsed: true
          minComplexity: 4
          createdAt: createdAt
          default: true
          minUniqueCharacters: 8
          maxAgeDays: 1
          id: id
          maxRepeatedCharacters: 3
          shiftedNumberRowSequenceRule:
            maxLength: 3
          updatedAt: updatedAt
          minCharacters:
            "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
            "0123456789": 6
            ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
            abcdefghijklmnopqrstuvwxyz: 7
          length:
            min: 24
            max: 6
          notSimilarToCurrent: true
          alphabetSequenceRule:
            maxLength: 2
          history:
            retentionDays: 1
            count: 1
          qwertySequenceRule:
            maxLength: 3
          excludesProfileData: true
          environment:
            id: id
          numberSequenceRule:
            maxLength: 2
          lockout:
            durationSeconds: 1
            failureCount: 1
          name: name
          minAgeDays: 1
        revisions:
        - agreement:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          requireReconsent: true
          notValidAfter: 2000-01-23T04:56:07.000+00:00
          effectiveAt: 2000-01-23T04:56:07.000+00:00
          language:
            id: id
          id: id
          text: text
          contentType: null
        - agreement:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          requireReconsent: true
          notValidAfter: 2000-01-23T04:56:07.000+00:00
          effectiveAt: 2000-01-23T04:56:07.000+00:00
          language:
            id: id
          id: id
          text: text
          contentType: null
        roleAssignments:
        - environment:
            id: id
          role:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          scope:
            id: id
            type: null
          readOnly: true
          id: id
          gateway:
            id: id
          group:
            id: id
        - environment:
            id: id
          role:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          scope:
            id: id
            type: null
          readOnly: true
          id: id
          gateway:
            id: id
          group:
            id: id
        trustedEmails:
        - environment:
            id: id
          emailAddress: emailAddress
          domain:
            id: id
          id: id
          domainId: domainId
          status: null
        - environment:
            id: id
          emailAddress: emailAddress
          domain:
            id: id
          id: id
          domainId: domainId
          status: null
        grants:
        - createdAt: 2000-01-23T04:56:07.000+00:00
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          resource:
            id: id
          id: id
          scopes:
          - id: id
          - id: id
          updatedAt: 2000-01-23T04:56:07.000+00:00
        - createdAt: 2000-01-23T04:56:07.000+00:00
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          resource:
            id: id
          id: id
          scopes:
          - id: id
          - id: id
          updatedAt: 2000-01-23T04:56:07.000+00:00
        gateways:
        - null
        - null
        identityProviders:
        - null
        - null
        keyRotationPolicies:
        - _links:
            key:
              href: https://openapi-generator.tech
          dn: dn
          nextKeyId: nextKeyId
          currentKeyId: currentKeyId
          signatureAlgorithm: null
          validityPeriod: 6
          environment:
            id: id
          keyLength: 1
          rotationPeriod: 30
          name: name
          rotatedAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          usageType: null
        - _links:
            key:
              href: https://openapi-generator.tech
          dn: dn
          nextKeyId: nextKeyId
          currentKeyId: currentKeyId
          signatureAlgorithm: null
          validityPeriod: 6
          environment:
            id: id
          keyLength: 1
          rotationPeriod: 30
          name: name
          rotatedAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          usageType: null
        notificationsPolicies:
        - createdAt: 2000-01-23T04:56:07.000+00:00
          default: false
          environment:
            id: id
          quotas:
          - total: 9
            unclaimed: 3
            claimed: 6
            type: null
            deliveryMethods:
            - null
            - null
          - total: 9
            unclaimed: 3
            claimed: 6
            type: null
            deliveryMethods:
            - null
            - null
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          countryLimit:
            countries:
            - countries
            - countries
            type: null
            deliveryMethods:
            - null
            - null
          id: id
          providerConfiguration:
            conditions:
            - countries:
              - countries
              - countries
              deliveryMethods:
              - null
              - null
              fallbackChain:
              - id: id
              - id: id
            - countries:
              - countries
              - countries
              deliveryMethods:
              - null
              - null
              fallbackChain:
              - id: id
              - id: id
          cooldownConfiguration:
            voice:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            whatsApp:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            sms:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            email:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
          updatedAt: 2000-01-23T04:56:07.000+00:00
        - createdAt: 2000-01-23T04:56:07.000+00:00
          default: false
          environment:
            id: id
          quotas:
          - total: 9
            unclaimed: 3
            claimed: 6
            type: null
            deliveryMethods:
            - null
            - null
          - total: 9
            unclaimed: 3
            claimed: 6
            type: null
            deliveryMethods:
            - null
            - null
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          countryLimit:
            countries:
            - countries
            - countries
            type: null
            deliveryMethods:
            - null
            - null
          id: id
          providerConfiguration:
            conditions:
            - countries:
              - countries
              - countries
              deliveryMethods:
              - null
              - null
              fallbackChain:
              - id: id
              - id: id
            - countries:
              - countries
              - countries
              deliveryMethods:
              - null
              - null
              fallbackChain:
              - id: id
              - id: id
          cooldownConfiguration:
            voice:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            whatsApp:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            sms:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
            email:
              resendLimit: 8
              periods:
              - duration: 404
                timeUnit: null
              - duration: 404
                timeUnit: null
              groupBy: groupBy
              enabled: true
          updatedAt: 2000-01-23T04:56:07.000+00:00
        languages:
        - null
        - null
        phoneDeliverySettings:
        - null
        - null
        templates:
        - createdAt: createdAt
          variables: "{}"
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          allowDynamicVariables: true
          description: description
          id: id
          deliveryMethods:
          - SMS
          - SMS
          updatedAt: updatedAt
        - createdAt: createdAt
          variables: "{}"
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          allowDynamicVariables: true
          description: description
          id: id
          deliveryMethods:
          - SMS
          - SMS
          updatedAt: updatedAt
        agreements:
        - environment:
            id: id
          totalExpiredConsents: 0
          _links:
            key:
              href: https://openapi-generator.tech
          consentsAggregatedAt: 2000-01-23T04:56:07.000+00:00
          name: name
          description: description
          totalConsents: 1
          id: id
          enabled: true
          reconsentPeriodDays: 6.0274563
        - environment:
            id: id
          totalExpiredConsents: 0
          _links:
            key:
              href: https://openapi-generator.tech
          consentsAggregatedAt: 2000-01-23T04:56:07.000+00:00
          name: name
          description: description
          totalConsents: 1
          id: id
          enabled: true
          reconsentPeriodDays: 6.0274563
        emailDomains:
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          domainName: domainName
          id: id
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          domainName: domainName
          id: id
        groups:
        - sourceId: sourceId
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          externalId: externalId
          customData: "{}"
          population:
            id: id
          directMemberCounts:
            users: 7
          environment:
            id: id
          sourceType: null
          name: name
          userFilter: userFilter
          id: id
          totalMemberCounts:
            users: 1
        - sourceId: sourceId
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          externalId: externalId
          customData: "{}"
          population:
            id: id
          directMemberCounts:
            users: 7
          environment:
            id: id
          sourceType: null
          name: name
          userFilter: userFilter
          id: id
          totalMemberCounts:
            users: 1
        resources:
        - null
        - null
        users:
        - preferredLanguage: preferredLanguage
          _links:
            key:
              href: https://openapi-generator.tech
          timezone: timezone
          lastSignOn:
            at: 2000-01-23T04:56:07.000+00:00
            remoteIp: remoteIp
          locale: locale
          title: title
          type: type
          enabled: true
          identityProvider:
            id: id
            type: null
          lifecycle:
            suppressVerificationCode: true
            status: null
          createdAt: 2000-01-23T04:56:07.000+00:00
          password:
            external:
              gateway:
                id: id
                userType:
                  id: id
                correlationAttributes: "{}"
                type: null
            forceChange: true
            value: value
          verifyStatus: null
          nickname: nickname
          mfaEnabled: true
          id: id
          email: email
          updatedAt: 2000-01-23T04:56:07.000+00:00
          memberOfGroupIDs:
          - memberOfGroupIDs
          - memberOfGroupIDs
          address:
            streetAddress: streetAddress
            countryCode: countryCode
            postalCode: postalCode
            locality: locality
            region: region
          externalId: externalId
          photo:
            href: href
          memberOfGroupNames:
          - memberOfGroupNames
          - memberOfGroupNames
          population:
            id: id
          emailVerified: true
          primaryPhone: primaryPhone
          environment:
            id: id
          mobilePhone: mobilePhone
          name:
            given: given
            honorificSuffix: honorificSuffix
            middle: middle
            formatted: formatted
            honorificPrefix: honorificPrefix
            family: family
          account:
            canAuthenticate: true
            lockedAt: 2000-01-23T04:56:07.000+00:00
            secondsUntilUnlock: 6
            unlockAt: 2000-01-23T04:56:07.000+00:00
            status: null
          username: username
        - preferredLanguage: preferredLanguage
          _links:
            key:
              href: https://openapi-generator.tech
          timezone: timezone
          lastSignOn:
            at: 2000-01-23T04:56:07.000+00:00
            remoteIp: remoteIp
          locale: locale
          title: title
          type: type
          enabled: true
          identityProvider:
            id: id
            type: null
          lifecycle:
            suppressVerificationCode: true
            status: null
          createdAt: 2000-01-23T04:56:07.000+00:00
          password:
            external:
              gateway:
                id: id
                userType:
                  id: id
                correlationAttributes: "{}"
                type: null
            forceChange: true
            value: value
          verifyStatus: null
          nickname: nickname
          mfaEnabled: true
          id: id
          email: email
          updatedAt: 2000-01-23T04:56:07.000+00:00
          memberOfGroupIDs:
          - memberOfGroupIDs
          - memberOfGroupIDs
          address:
            streetAddress: streetAddress
            countryCode: countryCode
            postalCode: postalCode
            locality: locality
            region: region
          externalId: externalId
          photo:
            href: href
          memberOfGroupNames:
          - memberOfGroupNames
          - memberOfGroupNames
          population:
            id: id
          emailVerified: true
          primaryPhone: primaryPhone
          environment:
            id: id
          mobilePhone: mobilePhone
          name:
            given: given
            honorificSuffix: honorificSuffix
            middle: middle
            formatted: formatted
            honorificPrefix: honorificPrefix
            family: family
          account:
            canAuthenticate: true
            lockedAt: 2000-01-23T04:56:07.000+00:00
            secondsUntilUnlock: 6
            unlockAt: 2000-01-23T04:56:07.000+00:00
            status: null
          username: username
        signOnPolicyAssignments:
        - environment:
            id: id
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          signOnPolicy:
            id: id
          id: id
          priority: 1
        - environment:
            id: id
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          signOnPolicy:
            id: id
          id: id
          priority: 1
        flowPolicyAssignments:
        - environment:
            id: id
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          id: id
          flowPolicy:
            id: id
          priority: 1
        - environment:
            id: id
          application:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          id: id
          flowPolicy:
            id: id
          priority: 1
        licenses:
        - gateways:
            allowLdapGateway: true
            allowRadiusGateway: true
            allowKerberosGateway: true
          package: package
          _links:
            key:
              href: https://openapi-generator.tech
          advancedServices:
            pingId:
              type: type
              included: true
          credentials:
            allowCredentials: true
          environments:
            allowConnections: true
            regions:
            - null
            - null
            allowAddResources: true
            max: 1
            allowCustomSchema: true
            allowProduction: true
            allowCustomDomain: true
          orchestrate:
            allowOrchestration: true
          mfa:
            allowFido2Devices: true
            allowVoiceOtp: true
            allowSmsOtp: true
            allowEmailOtp: true
            allowPushNotification: true
            allowTotp: true
            allowNotificationOutsideWhitelist: true
          expiresAt: 2000-01-23T04:56:07.000+00:00
          users:
            allowUpdateSelf: true
            allowPasswordPolicy: true
            max: 4
            allowMyAccount: true
            allowPasswordOnlyAuthentication: true
            allowRoleAssignment: true
            entitledToSupport: true
            annualActiveIncluded: 9
            allowPasswordManagement: true
            allowIdentityProviders: true
            allowInboundProvisioning: true
            allowVerificationFlow: true
            monthlyActiveIncluded: 9
            allowProvisioning: true
            hardLimitMax: 5
            allowPasswordManagementNotifications: true
          intelligence:
            allowReputation: true
            allowRisk: true
            allowDataConsent: true
            allowGeoVelocity: true
            allowAnonymousNetworkDetection: true
            allowAdvancedPredictors: true
          fraud:
            allowBotMaliciousDeviceDetection: true
            allowAccountProtection: true
          organization:
            id: id
          terminatesAt: 2000-01-23T04:56:07.000+00:00
          name: name
          verify:
            allowDocumentMatch: true
            allowManualIdInspection: true
            allowFaceMatch: true
            allowPushNotifications: true
          assignedEnvironmentsCount: 7
          beginsAt: 2000-01-23T04:56:07.000+00:00
          replacedByLicense:
            id: id
          id: id
          replacesLicense:
            id: id
          authorize:
            allowApiAccessManagement: true
            allowDynamicAuthorization: true
          status: null
        - gateways:
            allowLdapGateway: true
            allowRadiusGateway: true
            allowKerberosGateway: true
          package: package
          _links:
            key:
              href: https://openapi-generator.tech
          advancedServices:
            pingId:
              type: type
              included: true
          credentials:
            allowCredentials: true
          environments:
            allowConnections: true
            regions:
            - null
            - null
            allowAddResources: true
            max: 1
            allowCustomSchema: true
            allowProduction: true
            allowCustomDomain: true
          orchestrate:
            allowOrchestration: true
          mfa:
            allowFido2Devices: true
            allowVoiceOtp: true
            allowSmsOtp: true
            allowEmailOtp: true
            allowPushNotification: true
            allowTotp: true
            allowNotificationOutsideWhitelist: true
          expiresAt: 2000-01-23T04:56:07.000+00:00
          users:
            allowUpdateSelf: true
            allowPasswordPolicy: true
            max: 4
            allowMyAccount: true
            allowPasswordOnlyAuthentication: true
            allowRoleAssignment: true
            entitledToSupport: true
            annualActiveIncluded: 9
            allowPasswordManagement: true
            allowIdentityProviders: true
            allowInboundProvisioning: true
            allowVerificationFlow: true
            monthlyActiveIncluded: 9
            allowProvisioning: true
            hardLimitMax: 5
            allowPasswordManagementNotifications: true
          intelligence:
            allowReputation: true
            allowRisk: true
            allowDataConsent: true
            allowGeoVelocity: true
            allowAnonymousNetworkDetection: true
            allowAdvancedPredictors: true
          fraud:
            allowBotMaliciousDeviceDetection: true
            allowAccountProtection: true
          organization:
            id: id
          terminatesAt: 2000-01-23T04:56:07.000+00:00
          name: name
          verify:
            allowDocumentMatch: true
            allowManualIdInspection: true
            allowFaceMatch: true
            allowPushNotifications: true
          assignedEnvironmentsCount: 7
          beginsAt: 2000-01-23T04:56:07.000+00:00
          replacedByLicense:
            id: id
          id: id
          replacesLicense:
            id: id
          authorize:
            allowApiAccessManagement: true
            allowDynamicAuthorization: true
          status: null
        certificates:
        - customCRL: customCRL
          serialNumber: 5
          _links:
            key:
              href: https://openapi-generator.tech
          issuerDN: issuerDN
          expiresAt: 2000-01-23T04:56:07.000+00:00
          signatureAlgorithm: null
          validityPeriod: 1
          createdAt: 2000-01-23T04:56:07.000+00:00
          default: true
          environment:
            id: id
          keyLength: 5
          organization:
            id: id
          name: name
          startsAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          status: null
          subjectDN: subjectDN
          usageType: null
        - customCRL: customCRL
          serialNumber: 5
          _links:
            key:
              href: https://openapi-generator.tech
          issuerDN: issuerDN
          expiresAt: 2000-01-23T04:56:07.000+00:00
          signatureAlgorithm: null
          validityPeriod: 1
          createdAt: 2000-01-23T04:56:07.000+00:00
          default: true
          environment:
            id: id
          keyLength: 5
          organization:
            id: id
          name: name
          startsAt: 2000-01-23T04:56:07.000+00:00
          id: id
          algorithm: null
          status: null
          subjectDN: subjectDN
          usageType: null
        rateLimitIpConfigs:
        - createdAt: 2000-01-23T04:56:07.000+00:00
          id: id
          type: null
          value: value
          updatedAt: 2000-01-23T04:56:07.000+00:00
        - createdAt: 2000-01-23T04:56:07.000+00:00
          id: id
          type: null
          value: value
          updatedAt: 2000-01-23T04:56:07.000+00:00
        contents:
        - null
        - null
        versions:
        - null
        - null
        plans:
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          id: id
          status: null
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          id: id
          status: null
        schemas:
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          description: description
          attributes:
          - schema:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            type: null
            enumeratedValues:
            - archived: true
              description: description
              value: value
            - archived: true
              description: description
              value: value
            enabled: true
            required: true
            subAttributes:
            - null
            - null
            regexValidation:
              valuesPatternShouldNotMatch:
              - valuesPatternShouldNotMatch
              - valuesPatternShouldNotMatch
              requirements: requirements
              valuesPatternShouldMatch:
              - valuesPatternShouldMatch
              - valuesPatternShouldMatch
              pattern: pattern
            environment:
              id: id
            unique: true
            name: name
            schemaType: null
            id: id
            ldapAttribute: ldapAttribute
            multiValued: true
          - schema:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            type: null
            enumeratedValues:
            - archived: true
              description: description
              value: value
            - archived: true
              description: description
              value: value
            enabled: true
            required: true
            subAttributes:
            - null
            - null
            regexValidation:
              valuesPatternShouldNotMatch:
              - valuesPatternShouldNotMatch
              - valuesPatternShouldNotMatch
              requirements: requirements
              valuesPatternShouldMatch:
              - valuesPatternShouldMatch
              - valuesPatternShouldMatch
              pattern: pattern
            environment:
              id: id
            unique: true
            name: name
            schemaType: null
            id: id
            ldapAttribute: ldapAttribute
            multiValued: true
          id: id
          allowsContainsOperator: true
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          description: description
          attributes:
          - schema:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            type: null
            enumeratedValues:
            - archived: true
              description: description
              value: value
            - archived: true
              description: description
              value: value
            enabled: true
            required: true
            subAttributes:
            - null
            - null
            regexValidation:
              valuesPatternShouldNotMatch:
              - valuesPatternShouldNotMatch
              - valuesPatternShouldNotMatch
              requirements: requirements
              valuesPatternShouldMatch:
              - valuesPatternShouldMatch
              - valuesPatternShouldMatch
              pattern: pattern
            environment:
              id: id
            unique: true
            name: name
            schemaType: null
            id: id
            ldapAttribute: ldapAttribute
            multiValued: true
          - schema:
              id: id
            _links:
              key:
                href: https://openapi-generator.tech
            displayName: displayName
            description: description
            type: null
            enumeratedValues:
            - archived: true
              description: description
              value: value
            - archived: true
              description: description
              value: value
            enabled: true
            required: true
            subAttributes:
            - null
            - null
            regexValidation:
              valuesPatternShouldNotMatch:
              - valuesPatternShouldNotMatch
              - valuesPatternShouldNotMatch
              requirements: requirements
              valuesPatternShouldMatch:
              - valuesPatternShouldMatch
              - valuesPatternShouldMatch
              pattern: pattern
            environment:
              id: id
            unique: true
            name: name
            schemaType: null
            id: id
            ldapAttribute: ldapAttribute
            multiValued: true
          id: id
          allowsContainsOperator: true
        organizations:
        - createdAt: createdAt
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          billingConnections:
          - id: id
          - id: id
          description: description
          id: id
          type: null
          updatedAt: updatedAt
        - createdAt: createdAt
          _links:
            key:
              href: https://openapi-generator.tech
          name: name
          billingConnections:
          - id: id
          - id: id
          description: description
          id: id
          type: null
          updatedAt: updatedAt
        groupMemberships:
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          _embedded:
            group:
              sourceId: sourceId
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              externalId: externalId
              customData: "{}"
              population:
                id: id
              directMemberCounts:
                users: 7
              environment:
                id: id
              sourceType: null
              name: name
              userFilter: userFilter
              id: id
              totalMemberCounts:
                users: 1
          name: name
          id: id
          type: null
        - environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          _embedded:
            group:
              sourceId: sourceId
              _links:
                key:
                  href: https://openapi-generator.tech
              displayName: displayName
              description: description
              externalId: externalId
              customData: "{}"
              population:
                id: id
              directMemberCounts:
                users: 7
              environment:
                id: id
              sourceType: null
              name: name
              userFilter: userFilter
              id: id
              totalMemberCounts:
                users: 1
          name: name
          id: id
          type: null
        attributes:
        - null
        - null
        scopes:
        - createdAt: 2000-01-23T04:56:07.000+00:00
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          resource:
            id: id
          name: name
          description: description
          enableMappedClaims: true
          id: id
          mappedClaims:
          - mappedClaims
          - mappedClaims
          schemaAttributes:
          - schemaAttributes
          - schemaAttributes
          updatedAt: 2000-01-23T04:56:07.000+00:00
        - createdAt: 2000-01-23T04:56:07.000+00:00
          environment:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          resource:
            id: id
          name: name
          description: description
          enableMappedClaims: true
          id: id
          mappedClaims:
          - mappedClaims
          - mappedClaims
          schemaAttributes:
          - schemaAttributes
          - schemaAttributes
          updatedAt: 2000-01-23T04:56:07.000+00:00
        actions:
        - null
        - null
        integrations:
        - thirdParty:
            companyName: companyName
            products:
            - products
            - products
          createdAt: 2000-01-23T04:56:07.000+00:00
          marketingLandingPageUrl: marketingLandingPageUrl
          name: name
          description: description
          logo:
            href: href
            id: id
          publisher: publisher
          categories:
          - categories
          - categories
          id: id
          pingProductNames:
          - null
          - null
          tags:
          - null
          - null
        - thirdParty:
            companyName: companyName
            products:
            - products
            - products
          createdAt: 2000-01-23T04:56:07.000+00:00
          marketingLandingPageUrl: marketingLandingPageUrl
          name: name
          description: description
          logo:
            href: href
            id: id
          publisher: publisher
          categories:
          - categories
          - categories
          id: id
          pingProductNames:
          - null
          - null
          tags:
          - null
          - null
        populations:
        - preferredLanguage: preferredLanguage
          passwordPolicy:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          description: description
          createdAt: createdAt
          alternativeIdentifiers:
          - alternativeIdentifiers
          - alternativeIdentifiers
          default: true
          environment:
            id: id
          userCount: 5
          name: name
          theme:
            id: id
          id: id
          updatedAt: updatedAt
        - preferredLanguage: preferredLanguage
          passwordPolicy:
            id: id
          _links:
            key:
              href: https://openapi-generator.tech
          description: description
          createdAt: createdAt
          alternativeIdentifiers:
          - alternativeIdentifiers
          - alternativeIdentifiers
          default: true
          environment:
            id: id
          userCount: 5
          name: name
          theme:
            id: id
          id: id
          updatedAt: updatedAt
        forms:
        - components:
            fields:
            - null
            - null
          _links:
            key:
              href: https://openapi-generator.tech
          created: 2000-01-23T04:56:07.000+00:00
          description: description
          markRequired: true
          environment:
            id: id
          markOptional: true
          translationMethod: null
          passwordAutoCompleteEnabled: false
          fieldTypes:
          - null
          - null
          textAutoCompleteEnabled: false
          name: name
          modified: 2000-01-23T04:56:07.000+00:00
          languageBundle:
            key: languageBundle
          id: id
          category: null
          cols: 3
        - components:
            fields:
            - null
            - null
          _links:
            key:
              href: https://openapi-generator.tech
          created: 2000-01-23T04:56:07.000+00:00
          description: description
          markRequired: true
          environment:
            id: id
          markOptional: true
          translationMethod: null
          passwordAutoCompleteEnabled: false
          fieldTypes:
          - null
          - null
          textAutoCompleteEnabled: false
          name: name
          modified: 2000-01-23T04:56:07.000+00:00
          languageBundle:
            key: languageBundle
          id: id
          category: null
          cols: 3
        gatewayInstances:
        - lastReportedAt: lastReportedAt
          responseTimeMillis: 4.145608029883936
          version:
            updateStatus: null
            versionNumber: versionNumber
          connected: true
          environment:
            id: id
          currentErrors:
          - currentErrors
          - currentErrors
          hostname: hostname
          operationsPerSecond: 2.027123023002322
          credential:
            id: id
          healthStatus: null
          initializedAt: initializedAt
          id: id
          busyPercentage: 3
          gateway:
            id: id
        - lastReportedAt: lastReportedAt
          responseTimeMillis: 4.145608029883936
          version:
            updateStatus: null
            versionNumber: versionNumber
          connected: true
          environment:
            id: id
          currentErrors:
          - currentErrors
          - currentErrors
          hostname: hostname
          operationsPerSecond: 2.027123023002322
          credential:
            id: id
          healthStatus: null
          initializedAt: initializedAt
          id: id
          busyPercentage: 3
          gateway:
            id: id
        applications:
        - null
        - null
      properties:
        actions:
          items:
            $ref: '#/components/schemas/SignOnPolicyAction'
          type: array
        agreements:
          items:
            $ref: '#/components/schemas/Agreement'
          type: array
        alertChannels:
          items:
            $ref: '#/components/schemas/AlertChannel'
          type: array
        attributes:
          items:
            $ref: '#/components/schemas/EntityArray__embedded_attributes_inner'
          type: array
        applications:
          items:
            $ref: '#/components/schemas/readOneApplication_200_response'
          type: array
        certificates:
          items:
            $ref: '#/components/schemas/Certificate'
          type: array
        contents:
          items:
            $ref: '#/components/schemas/TemplateContent'
          type: array
        credentials:
          items:
            $ref: '#/components/schemas/GatewayCredential'
          type: array
        customDomains:
          items:
            $ref: '#/components/schemas/CustomDomain'
          type: array
        emailDomains:
          items:
            $ref: '#/components/schemas/EmailDomain'
          type: array
        environments:
          items:
            $ref: '#/components/schemas/Environment'
          type: array
        flowPolicies:
          items:
            $ref: '#/components/schemas/FlowPolicy'
          type: array
        flowPolicyAssignments:
          items:
            $ref: '#/components/schemas/FlowPolicyAssignment'
          type: array
        forms:
          items:
            $ref: '#/components/schemas/Form'
          type: array
        gatewayInstances:
          items:
            $ref: '#/components/schemas/GatewayInstance'
          type: array
        gateways:
          items:
            $ref: '#/components/schemas/EntityArray__embedded_gateways_inner'
          type: array
        grants:
          items:
            $ref: '#/components/schemas/ApplicationResourceGrant'
          type: array
        groups:
          items:
            $ref: '#/components/schemas/Group'
          type: array
        groupMemberships:
          items:
            $ref: '#/components/schemas/GroupMembership'
          type: array
        identityProviders:
          items:
            $ref: '#/components/schemas/IdentityProvider'
          type: array
        integrations:
          items:
            $ref: '#/components/schemas/Integration'
          type: array
        keys:
          items:
            $ref: '#/components/schemas/Certificate'
          type: array
        keyRotationPolicies:
          items:
            $ref: '#/components/schemas/KeyRotationPolicy'
          type: array
        languages:
          items:
            $ref: '#/components/schemas/EntityArray__embedded_languages_inner'
          type: array
        licenses:
          items:
            $ref: '#/components/schemas/License'
          type: array
        notificationsPolicies:
          items:
            $ref: '#/components/schemas/NotificationsPolicy'
          type: array
        organizations:
          items:
            $ref: '#/components/schemas/Organization'
          type: array
        passwordPolicies:
          items:
            $ref: '#/components/schemas/PasswordPolicy'
          type: array
        permissions:
          items:
            $ref: '#/components/schemas/ResourceApplicationPermission'
          type: array
        phoneDeliverySettings:
          items:
            $ref: '#/components/schemas/NotificationsSettingsPhoneDeliverySettings'
          type: array
        plans:
          items:
            $ref: '#/components/schemas/IdentityPropagationPlan'
          type: array
        populations:
          items:
            $ref: '#/components/schemas/Population'
          type: array
        rateLimitIpConfigs:
          items:
            $ref: '#/components/schemas/RateLimitConfiguration'
          type: array
        resources:
          items:
            $ref: '#/components/schemas/EntityArray__embedded_resources_inner'
          type: array
        revisions:
          items:
            $ref: '#/components/schemas/AgreementLanguageRevision'
          type: array
        scopes:
          items:
            $ref: '#/components/schemas/ResourceScope'
          type: array
        signOnPolicies:
          items:
            $ref: '#/components/schemas/SignOnPolicy'
          type: array
        signOnPolicyAssignments:
          items:
            $ref: '#/components/schemas/SignOnPolicyAssignment'
          type: array
        subscriptions:
          items:
            $ref: '#/components/schemas/Subscription'
          type: array
        templates:
          items:
            $ref: '#/components/schemas/Template'
          type: array
        themes:
          items:
            $ref: '#/components/schemas/BrandingTheme'
          type: array
        translations:
          items:
            $ref: '#/components/schemas/LocaleTranslation'
          type: array
        trustedEmails:
          items:
            $ref: '#/components/schemas/EmailDomainTrustedEmail'
          type: array
        roleAssignments:
          items:
            $ref: '#/components/schemas/RoleAssignment'
          type: array
        roles:
          items:
            $ref: '#/components/schemas/EntityArray__embedded_roles_inner'
          type: array
        schemas:
          items:
            $ref: '#/components/schemas/Schema'
          type: array
        users:
          items:
            $ref: '#/components/schemas/User'
          type: array
        versions:
          items:
            $ref: '#/components/schemas/IntegrationVersion'
          type: array
      type: object
    Environment_license:
      properties:
        id:
          description: A string that specifies the active license associated with
            this environment. This property is required only if your organization
            has more than one active license.
          type: string
      required:
      - id
      type: object
    Environment_organization:
      properties:
        id:
          description: A string that specifies the organization resource’s unique
            identifier associated with the environment.
          type: string
      type: object
    Environment_region:
      oneOf:
      - $ref: '#/components/schemas/EnumRegionCode'
      - type: string
    EnvironmentStatus_license:
      description: The PingOne license to assign to the environment when setting the
        status to `ACTIVE`. This property is only required when setting the status
        to `ACTIVE`.
      example:
        id: id
      properties:
        id:
          description: The id of the license.
          type: string
      required:
      - id
      type: object
    FlowPolicy_application:
      description: An object that specifies the application information associated
        with the flow policy resource.
      example:
        name: name
        id: id
      properties:
        id:
          description: The unique identifier of the application resource associated
            with the flow policy.
          type: string
        name:
          description: The name of the application resource associated with the flow
            policy.
          type: string
      readOnly: true
      type: object
    FlowPolicy_trigger:
      description: An object that specifies trigger information associated with the
        flow policy resource.
      example:
        type: null
      properties:
        type:
          $ref: '#/components/schemas/EnumFlowPolicyTriggerType'
      readOnly: true
      type: object
    FlowPolicyAssignment_flowPolicy:
      description: An object that contains details of the flow policy resource.
      example:
        id: id
      properties:
        id:
          description: A string that specifies the flow policy resource ID associated
            with the flow policy assignment.
          type: string
      required:
      - id
      type: object
    FormFieldCommon_position:
      properties:
        row:
          description: An integer that specifies the number of rows (maximum number
            is 50).
          maximum: 50
          type: integer
        col:
          description: An integer that specifies the number of columns (min = 0; max
            = 4).
          maximum: 4
          minimum: 0
          type: integer
        width:
          description: An integer that specifies the width of the field (in percentage).
          type: integer
      required:
      - col
      - row
      type: object
    FormFieldCommon_visibility:
      properties:
        type:
          $ref: '#/components/schemas/EnumFormFieldVisibility'
        key:
          description: "A non-unique string associated with the field when visibility\
            \ is evaluated by DaVinci at runtime. If the `type` property is set to\
            \ `SHOW_BY_DEFAULT` or `HIDE_BY_DEFAULT`, then this property is required."
          type: string
      required:
      - type
      type: object
    FormFlowButton_styles:
      properties:
        height:
          description: An integer that specifies the button height.
          type: integer
        width:
          description: An integer that specifies the button width.
          type: integer
        widthUnit:
          $ref: '#/components/schemas/EnumFormStylesWidthUnit'
        alignment:
          $ref: '#/components/schemas/EnumFormItemAlignment'
        padding:
          $ref: '#/components/schemas/FormStylesPadding'
        backgroundColor:
          description: A string that specifies the button background color. The value
            must be a valid hexadecimal color.
          type: string
        textColor:
          description: A string that specifies the button text color. The value must
            be a valid hexadecimal color.
          type: string
        borderColor:
          description: A string that specifies the button border color. The value
            must be a valid hexadecimal color.
          type: string
        enabled:
          description: A boolean that specifies whether the button is enabled.
          type: boolean
        displayDefaultThemeButtonBackgroundColor:
          description: A boolean that specifies whether the button uses the default
            theme’s background color.
          type: boolean
        displayDefaultThemeButtonBorderColor:
          description: A boolean that specifies whether the button uses the default
            theme’s border color.
          type: boolean
        displayDefaultThemeButtonTextColor:
          description: A boolean that specifies whether the button uses the default
            theme’s text color.
          type: boolean
      type: object
    FormLinkCustom_allOf_styles:
      properties:
        alignment:
          $ref: '#/components/schemas/EnumFormItemAlignment'
        textColor:
          description: A string that specifies the link text color. The value must
            be a valid hexadecimal color.
          type: string
        enabled:
          description: A boolean that specifies whether the link is enabled.
          type: boolean
        padding:
          $ref: '#/components/schemas/FormStylesPadding'
        displayDefaultThemeLinkColor:
          description: A boolean that specifies whether the default theme’s link color
            is enabled.
          type: boolean
      type: object
      example: null
    FormItemWithIcon_allOf_icon:
      description: An object that specifies the icon for the field.
      properties:
        type:
          $ref: '#/components/schemas/EnumFormItemIconType'
        size:
          $ref: '#/components/schemas/EnumFormItemIconSize'
      required:
      - size
      - type
      type: object
      example: null
    FormAgreement_allOf_agreement:
      properties:
        id:
          description: An identifier that specifies the ID of the agreement.
          format: uuid
          type: string
        useDynamicAgreement:
          description: An agreement option that specifies whether to use the agreement
            identified in the DaVinci form node.
          type: boolean
      type: object
      example: null
    FormSocialLoginButton_allOf_styles:
      properties:
        alignment:
          $ref: '#/components/schemas/EnumFormItemAlignment'
        textColor:
          description: A string that specifies the button text color. The value must
            be a valid hexadecimal color.
          type: string
        enabled:
          description: A boolean that specifies whether the button is enabled.
          type: boolean
        height:
          description: An integer that specifies the button height.
          type: integer
        width:
          description: An integer that specifies the button width.
          type: integer
        widthUnit:
          $ref: '#/components/schemas/EnumFormStylesWidthUnit'
        padding:
          $ref: '#/components/schemas/FormStylesPadding'
        backgroundColor:
          description: A string that specifies the button background color. The value
            must be a valid hexadecimal color.
          type: string
        borderColor:
          description: A string that specifies the button border color. The value
            must be a valid hexadecimal color.
          type: string
        displayDefaultThemeButtonBackgroundColor:
          description: A boolean that specifies whether the button uses the default
            theme’s background color.
          type: boolean
        displayDefaultThemeButtonBorderColor:
          description: A boolean that specifies whether the button uses the default
            theme’s border color.
          type: boolean
        displayDefaultThemeButtonTextColor:
          description: A boolean that specifies whether the button uses the default
            theme’s text color.
          type: boolean
      type: object
      example: null
    Gateway_supportedVersions_inner:
      properties:
        version:
          description: A string that specifies the gateway version number.
          type: string
        image:
          description: A string that identifies the gateway image path.
          type: string
        recommended:
          description: A boolean that specifies whether this is the recommended LDAP
            gateway version.
          type: boolean
        latest:
          description: A boolean that specifies whether this is the latest LDAP gateway
            version.
          type: boolean
        supportEndsOn:
          format: date-time
          type: string
        daysUntilSupportEnds:
          type: integer
      type: object
    GatewayTypeLDAP_allOf_kerberos:
      description: Contains the Kerberos authentication settings. Set this to null
        to disable Kerberos authentication.
      properties:
        serviceAccountPassword:
          description: The password for the Kerberos service account.
          format: password
          type: string
        serviceAccountUserPrincipalName:
          description: "The Kerberos service account user principal name (for example,\
            \ `username@domain.com`)."
          type: string
        minutesToRetainPreviousCredentials:
          description: The number of minutes for which the previous credentials are
            persisted.
          type: integer
      required:
      - serviceAccountUserPrincipalName
      type: object
      example: null
    GatewayTypeLDAP_allOf_newUserLookup_attributeMappings:
      properties:
        name:
          description: The PingOne username attribute. See Users properties for the
            complete list of PingOne user attributes.
          type: string
        value:
          description: A placeholder reference to the corresponding external LDAP
            attribute for name.
          type: string
      required:
      - name
      - value
      type: object
      example: null
    GatewayTypeLDAP_allOf_newUserLookup_population:
      description: The PingOne population to use to create user entries during lookup.
      properties:
        id:
          description: The ID of the population to use to create user entries during
            lookup.
          type: string
      required:
      - id
      type: object
      example: null
    GatewayTypeLDAP_allOf_newUserLookup:
      description: "The configurations for initially authenticating new users who\
        \ will be migrated to PingOne. Note If there are multiple users having the\
        \ same user name, only the first user processed is provisioned."
      properties:
        attributeMappings:
          description: A list of objects supplying a mapping of PingOne attributes
            to external LDAP attributes. One of the entries must be a mapping for
            "username`. This is required for the PingOne user schema.
          items:
            $ref: '#/components/schemas/GatewayTypeLDAP_allOf_newUserLookup_attributeMappings'
          type: array
        ldapFilterPattern:
          description: "The LDAP user search filter to use to match users against\
            \ the entered user identifier at login. For example, (((uid=${identifier})(mail=${identifier})).\
            \ Alternatively, this can be a search against the user directory."
          type: string
        population:
          $ref: '#/components/schemas/GatewayTypeLDAP_allOf_newUserLookup_population'
      required:
      - attributeMappings
      - ldapFilterPattern
      - population
      type: object
      example: null
    GatewayTypeLDAP_allOf_userTypes:
      properties:
        allowPasswordChanges:
          description: "Defaults to false if this property isn't specified in the\
            \ request. If false, the user cannot change the password in the remote\
            \ LDAP directory. In this case, operations for forgotten passwords or\
            \ resetting of passwords are not available to a user referencing this\
            \ gateway."
          type: boolean
        updateUserOnSuccessfulAuthentication:
          description: "If set to true, when users sign on through an LDAP Gateway\
            \ client, user attributes are updated based on responses from the LDAP\
            \ server. Defaults to false if this property isn't specified in the request."
          type: boolean
        id:
          description: The UUID of the user type. This correlates to the password.external.gateway.userType.id
            User property.
          type: string
        name:
          description: The name of the user type.
          type: string
        newUserLookup:
          $ref: '#/components/schemas/GatewayTypeLDAP_allOf_newUserLookup'
        orderedCorrelationAttributes:
          description: A map of key/value entries used to persist the external LDAP
            directory attributes.
          items:
            type: string
          type: array
        passwordAuthority:
          $ref: '#/components/schemas/EnumGatewayPasswordAuthority'
        searchBaseDn:
          description: The LDAP base domain name (DN) for this user type.
          type: string
      required:
      - name
      - orderedCorrelationAttributes
      - passwordAuthority
      - searchBaseDn
      type: object
      example: null
    GatewayTypeRADIUS_allOf_davinci_policy:
      properties:
        id:
          description: The ID of the Davinci flow policy to use.
          type: string
      required:
      - id
      type: object
      example: null
    GatewayTypeRADIUS_allOf_davinci:
      properties:
        policy:
          $ref: '#/components/schemas/GatewayTypeRADIUS_allOf_davinci_policy'
      required:
      - policy
      type: object
      example: null
    GatewayTypeRADIUS_allOf_networkPolicyServer:
      description: "If specified, the RADIUS gateway authenticates using the MS-CHAP\
        \ v2 protocol."
      properties:
        ip:
          description: The IP address of the Network Policy Server (NPS).
          type: string
        port:
          description: The port number of the NPS.
          type: integer
      required:
      - ip
      - port
      type: object
      example: null
    GatewayTypeRADIUS_allOf_blastRadiusMitigation:
      description: "This object contains two optional fields that can be used to block\
        \ Blast RADIUS attacks. Since these two options use different approaches to\
        \ deal with the same issue, you should not set more than one of them to `true`.\
        \ If both are set to `true`, an error is returned."
      properties:
        requireMsgAuth:
          description: Set to `true` to require that all requests from the client
            include the Message-Authenticator attribute. Any requests without the
            attribute will be ignored.
          type: boolean
        limitProxyState:
          description: "For older clients that don't support sending the Message-Authenticator\
            \ attribute, you can set this field to `true`. This instructs the gateway\
            \ to ignore requests that don't contain the Message-Authenticator attribute\
            \ but contain the Proxy-State attribute."
          type: boolean
      type: object
      example: null
    GatewayTypeRADIUS_allOf_radiusClients:
      properties:
        blastRadiusMitigation:
          $ref: '#/components/schemas/GatewayTypeRADIUS_allOf_blastRadiusMitigation'
        ip:
          description: The IP of the RADIUS client.
          type: string
        sharedSecret:
          description: "The shared secret for the RADIUS client. If this value is\
            \ not provided, the shared secret specified with `defaultSharedSecret`\
            \ is used. If you are not providing a shared secret for the client, leave\
            \ out `sharedSecret` or set it to null."
          format: password
          type: string
      required:
      - ip
      type: object
      example: null
    GatewayInstance_gateway:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the gateway ID.
          type: string
      readOnly: true
      type: object
    GatewayInstance_credential:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the credential ID.
          type: string
      readOnly: true
      type: object
    GatewayInstance_version:
      description: An object containing the version of the gateway running for the
        instance.
      example:
        updateStatus: null
        versionNumber: versionNumber
      properties:
        versionNumber:
          description: A string that specifies the version number of the gateway running
            for the instance. This is a required property.
          type: string
        updateStatus:
          $ref: '#/components/schemas/EnumUpdateStatus'
      type: object
    Group_population:
      description: The population to assign the group to
      example:
        id: id
      properties:
        id:
          description: The population ID
          type: string
      required:
      - id
      type: object
    Group_directMemberCounts:
      description: "An object containing a users (int) property. This property lists\
        \ the number of users explicitly added to the group with POST /environments/{environmentID}/users/{userID}/memberOfGroups.\
        \ Since these members were explicitly added to the group, they can be removed\
        \ from the group with DELETE /environments/{environmentID}/users/{userID}/memberOfGroups/{groupID}."
      example:
        users: 7
      properties:
        users:
          description: Number of users with direct membership
          type: integer
      readOnly: true
      type: object
    Group_totalMemberCounts:
      description: "An object containing a users (int) property. This property lists\
        \ the total number of users added to the group. You must use GET /environments/{environmentID}/groups\
        \ with the include=totalMemberCounts query parameter to retrieve this property.\
        \ This property is not returned with a list of groups."
      example:
        users: 1
      properties:
        users:
          description: Number of users with direct membership
          type: integer
      readOnly: true
      type: object
    GroupMembership__embedded:
      example:
        group:
          sourceId: sourceId
          _links:
            key:
              href: https://openapi-generator.tech
          displayName: displayName
          description: description
          externalId: externalId
          customData: "{}"
          population:
            id: id
          directMemberCounts:
            users: 7
          environment:
            id: id
          sourceType: null
          name: name
          userFilter: userFilter
          id: id
          totalMemberCounts:
            users: 1
      properties:
        group:
          $ref: '#/components/schemas/Group'
      type: object
    IdentityProviderAttribute_identityProvider:
      example:
        id: id
      properties:
        id:
          type: string
      readOnly: true
      type: object
    IdentityProviderCommon_icon:
      properties:
        id:
          description: The ID for the IdP icon.
          type: string
        href:
          description: The HREF for the IdP icon.
          type: string
      type: object
    IdentityProviderCommon_loginButtonIcon:
      properties:
        id:
          description: "The image ID for the IdP login button icon. For Facebook,\
            \ Google, and LinkedIn IdPs, updates to the login button are ignored to\
            \ preserve the IdP branding rules."
          type: string
        href:
          description: "The HREF for the IdP login button icon image file. For Facebook,\
            \ Google, and LinkedIn IdPs, updates to the login button are ignored to\
            \ preserve the IdP branding rules."
          type: string
      type: object
    IdentityProviderCommon_registration_population:
      properties:
        id:
          description: An external IdP to use as authoritative. Setting this attribute
            gives management of linked users to the IdP and also triggers just-in-time
            provisioning of new users. These users are created in the population indicated
            with registration.population.id.
          type: string
      type: object
    IdentityProviderCommon_registration:
      properties:
        population:
          $ref: '#/components/schemas/IdentityProviderCommon_registration_population'
      type: object
    IdentityProviderSAML_allOf_idpVerification_certificates:
      properties:
        id:
          type: string
      required:
      - id
      type: object
      example: null
    IdentityProviderSAML_allOf_idpVerification:
      properties:
        certificates:
          description: A array that specifies the identity provider's certificate
            IDs used to verify the signature on the signed assertion from the identity
            provider. Signing is done with a private key and verified with a public
            key.
          items:
            $ref: '#/components/schemas/IdentityProviderSAML_allOf_idpVerification_certificates'
          type: array
      required:
      - certificates
      type: object
      example: null
    IdentityProviderSAML_allOf_spSigning_key:
      properties:
        id:
          description: A string that specifies the service provider's signing key
            ID.
          type: string
      required:
      - id
      type: object
      example: null
    IdentityProviderSAML_allOf_spSigning:
      properties:
        algorithm:
          $ref: '#/components/schemas/EnumIdentityProviderSAMLSigningAlgorithm'
        key:
          $ref: '#/components/schemas/IdentityProviderSAML_allOf_spSigning_key'
      required:
      - key
      type: object
      example: null
    Image_targets_original:
      example:
        width: 0
        href: href
        id: id
        type: null
        height: 6
      properties:
        href:
          description: A string that specifies the URL or fully qualified path to
            the image source file.
          readOnly: true
          type: string
        id:
          description: A string that specifies the UUID of the target image.
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/EnumImageFormat'
        width:
          description: The width of the image (in pixels).
          readOnly: true
          type: integer
        height:
          description: The height of the image (in pixels).
          readOnly: true
          type: integer
      readOnly: true
      type: object
    Image_targets:
      example:
        original:
          width: 0
          href: href
          id: id
          type: null
          height: 6
      properties:
        original:
          $ref: '#/components/schemas/Image_targets_original'
      readOnly: true
      type: object
    Integration_logo:
      description: "A logo to use for the integration. If specified, the associated\
        \ properties are required."
      example:
        href: href
        id: id
      properties:
        href:
          description: The href to the absolute URL of the image.
          type: string
        id:
          description: The image ID generated by the Image service.
          type: string
      required:
      - href
      - id
      type: object
    Integration_thirdParty:
      description: Metadata that defines the third party related to this integration.
      example:
        companyName: companyName
        products:
        - products
        - products
      properties:
        companyName:
          description: Name of the third party company for the listing.
          type: string
        products:
          description: Names of the third party products for the integration.
          items:
            type: string
          type: array
      required:
      - companyName
      type: object
    IntegrationVersionAttribute_integration:
      description: The parent integration of the integration version.
      example:
        id: id
      properties:
        id:
          description: The platform-generated ID of the parent integration.
          readOnly: true
          type: string
      readOnly: true
      required:
      - id
      type: object
    IntegrationVersionAttribute_version:
      description: The relationship to the parent integration version.
      example:
        id: id
      properties:
        id:
          description: The platform-generated ID of the parent integration version.
          type: string
      readOnly: true
      required:
      - id
      type: object
    IntegrationVersionCommon_configuration:
      description: "The configuration of the integration version. If specified, configuration.schema\
        \ and configuration.properties is required."
      properties:
        schema:
          description: Contains a JSON schema defining the integration version.
          type: object
        properties:
          description: Contains the property names and assigned values for the integration
            version.
          type: object
      required:
      - properties
      - schema
      type: object
    IntegrationVersionCommon_integration:
      description: The parent integration of the integration version.
      properties:
        id:
          description: The platform-generated ID of the parent integration.
          type: string
      readOnly: true
      required:
      - id
      type: object
    IntegrationVersionIntegrationKit_allOf_integratedWith:
      description: Ping product integration details.
      properties:
        name:
          $ref: '#/components/schemas/EnumIntegrationVersionIntegrationKitIntegratedWithName'
        minVersion:
          description: Earliest version of the integrated Ping product.
          type: string
        maxVersion:
          description: Latest version of the integrated Ping product.
          type: string
      required:
      - name
      type: object
      example: null
    IntegrationVersionSAML_allOf_slo:
      description: The Single Logout information.
      properties:
        requestEndpoint:
          description: The endpoint where SLO requests are sent.
          type: string
        responseEndpoint:
          description: The endpoint where SLO responses are sent.
          type: string
        binding:
          $ref: '#/components/schemas/EnumIntegrationVersionSAMLSLOBinding'
      type: object
      example: null
    IntegrationVersionSAML_allOf_thirdParty_metadata:
      description: The third-party IdP metadata.
      properties:
        href:
          description: URL of IdP's SAML metadata XML.
          type: string
      type: object
      example: null
    IntegrationVersionSAML_allOf_thirdParty_instructions:
      properties:
        href:
          description: URL of IdP's setup instructions.
          type: string
      type: object
      example: null
    IntegrationVersionSAML_allOf_thirdParty:
      description: Third-party IdP information.
      properties:
        metadata:
          $ref: '#/components/schemas/IntegrationVersionSAML_allOf_thirdParty_metadata'
        instructions:
          $ref: '#/components/schemas/IntegrationVersionSAML_allOf_thirdParty_instructions'
      type: object
      example: null
    LanguageLocalizationStatus_locale:
      example:
        id: id
      properties:
        id:
          description: The locale ID.
          type: string
      readOnly: true
      type: object
    License_advancedServices_pingId:
      example:
        type: type
        included: true
      properties:
        included:
          type: boolean
        type:
          type: string
      type: object
    License_advancedServices:
      example:
        pingId:
          type: type
          included: true
      properties:
        pingId:
          $ref: '#/components/schemas/License_advancedServices_pingId'
      readOnly: true
      type: object
    License_authorize:
      example:
        allowApiAccessManagement: true
        allowDynamicAuthorization: true
      properties:
        allowApiAccessManagement:
          description: A read-only boolean that specifies whether to enable the PingOne
            Authorize API access management feature.
          type: boolean
        allowDynamicAuthorization:
          description: A read-only boolean that specifies whether to enable the PingOne
            Authorize dynamic authorization feature.
          type: boolean
      readOnly: true
      type: object
    License_credentials:
      example:
        allowCredentials: true
      properties:
        allowCredentials:
          type: boolean
      readOnly: true
      type: object
    License_environments:
      example:
        allowConnections: true
        regions:
        - null
        - null
        allowAddResources: true
        max: 1
        allowCustomSchema: true
        allowProduction: true
        allowCustomDomain: true
      properties:
        allowAddResources:
          type: boolean
        allowConnections:
          description: A boolean that specifies whether the license supports creation
            of application connections in the specified environment.
          type: boolean
        allowCustomDomain:
          description: A read-only boolean that specifies whether the license supports
            creation of a custom domain in the specified environment.
          type: boolean
        allowCustomSchema:
          description: A read-only boolean that specifies whether the license supports
            using custom schema attributes in the specified environment.
          type: boolean
        allowProduction:
          description: A read-only boolean that specifies whether production environments
            are allowed.
          type: boolean
        max:
          description: A read-only integer that specifies the maximum number of environments
            allowed.
          type: integer
        regions:
          items:
            $ref: '#/components/schemas/EnumRegionCodeLicense'
          type: array
      readOnly: true
      type: object
    License_fraud:
      example:
        allowBotMaliciousDeviceDetection: true
        allowAccountProtection: true
      properties:
        allowBotMaliciousDeviceDetection:
          type: boolean
        allowAccountProtection:
          type: boolean
      readOnly: true
      type: object
    License_gateways:
      example:
        allowLdapGateway: true
        allowRadiusGateway: true
        allowKerberosGateway: true
      properties:
        allowLdapGateway:
          type: boolean
        allowKerberosGateway:
          type: boolean
        allowRadiusGateway:
          type: boolean
      readOnly: true
      type: object
    License_intelligence:
      example:
        allowReputation: true
        allowRisk: true
        allowDataConsent: true
        allowGeoVelocity: true
        allowAnonymousNetworkDetection: true
        allowAdvancedPredictors: true
      properties:
        allowGeoVelocity:
          description: "A read-only boolean that specifies whether to use the intelligence\
            \ geo-velocity feature. For `TRIAL` (unpaid) licenses, the default value\
            \ is true. For `ADMIN`, `GLOBAL`, `RISK`, and `MFARISK`, the default value\
            \ is true."
          type: boolean
        allowAnonymousNetworkDetection:
          description: "A read-only boolean that specifies whether to use the intelligence\
            \ anonymous network detection feature. For `TRIAL` (unpaid) licenses,\
            \ the default value is true. For `ADMIN`, `GLOBAL`, `RISK`, and `MFARISK`,\
            \ the default value is true."
          type: boolean
        allowReputation:
          description: "A read-only boolean that specifies whether to use the intelligence\
            \ IP reputation feature. For `TRIAL` (unpaid) licenses, the default value\
            \ is true. For `ADMIN`, `GLOBAL`, `RISK`, and `MFARISK`, the default value\
            \ is true."
          type: boolean
        allowDataConsent:
          description: A read-only boolean that specifies whether the customer has
            opted in to allow user and event behavior analytics (UEBA) data collection.
          type: boolean
        allowRisk:
          description: "A read-only boolean that specifies whether your license permits\
            \ you to configure risk features such as sign-on policies that include\
            \ rules to detect anomalous changes to your locations (such as impossible\
            \ travel). This capability is supported for TRIAL, RISK, and MFARISK license\
            \ packages. Note, The sharing of user data to enable our machine-learning\
            \ engine, which is integral to PingOne Risk, is captured in the license\
            \ property license.intelligence.allowDataConsent, but it is not set to\
            \ true by default in any license package. This license capability always\
            \ requires active consent by the customer before it can be enabled, and\
            \ if consent is given, then it allows the full scope of intelligence features\
            \ included in PingOne Risk (and PingOne Risk plus MFA)."
          type: boolean
        allowAdvancedPredictors:
          type: boolean
      readOnly: true
      type: object
    License_mfa:
      example:
        allowFido2Devices: true
        allowVoiceOtp: true
        allowSmsOtp: true
        allowEmailOtp: true
        allowPushNotification: true
        allowTotp: true
        allowNotificationOutsideWhitelist: true
      properties:
        allowPushNotification:
          description: "A read-only boolean that specifies whether push notifications\
            \ are allowed. For TRIAL (unpaid) licenses, the default value is true.\
            \ For other license package types, adoption of the feature determines\
            \ the default value."
          type: boolean
        allowNotificationOutsideWhitelist:
          description: A read-only boolean that specifies whether the license supports
            sending notifications outside of the environment's whitelist.
          type: boolean
        allowFido2Devices:
          description: "A read-only boolean that specifies whether FIDO2 devices are\
            \ allowed. For TRIAL (unpaid) licenses, the default value is true. For\
            \ other license package types, adoption of the feature determines the\
            \ default value."
          type: boolean
        allowVoiceOtp:
          type: boolean
        allowEmailOtp:
          type: boolean
        allowSmsOtp:
          type: boolean
        allowTotp:
          type: boolean
      readOnly: true
      type: object
    License_orchestrate:
      example:
        allowOrchestration: true
      properties:
        allowOrchestration:
          type: boolean
      type: object
    License_replacesLicense:
      description: A read-only object that specifies the license ID of the license
        that is replaced by this license.
      example:
        id: id
      properties:
        id:
          description: A read-only string that specifies the license ID of the license
            that is replaced by this license.
          type: string
      type: object
    License_replacedByLicense:
      description: A read-only object that specifies the license ID of the license
        that replaces this license.
      example:
        id: id
      properties:
        id:
          description: A read-only string that specifies the license ID of the license
            that replaces this license.
          type: string
      type: object
    License_users:
      example:
        allowUpdateSelf: true
        allowPasswordPolicy: true
        max: 4
        allowMyAccount: true
        allowPasswordOnlyAuthentication: true
        allowRoleAssignment: true
        entitledToSupport: true
        annualActiveIncluded: 9
        allowPasswordManagement: true
        allowIdentityProviders: true
        allowInboundProvisioning: true
        allowVerificationFlow: true
        monthlyActiveIncluded: 9
        allowProvisioning: true
        hardLimitMax: 5
        allowPasswordManagementNotifications: true
      properties:
        allowPasswordManagementNotifications:
          description: A read-only boolean that specifies whether the license supports
            sending password management notifications.
          type: boolean
        allowIdentityProviders:
          description: A read-only boolean that specifies whether the license supports
            using external identity providers in the specified environment.
          type: boolean
        allowMyAccount:
          description: A read-only boolean that specifies whether the license supports
            using My Account capabilities in the specified environment.
          type: boolean
        allowPasswordManagement:
          description: A read-only boolean that specifies whether the license supports
            using password management capabilities in the specified environment.
          type: boolean
        allowPasswordOnlyAuthentication:
          description: A read-only boolean that specifies whether the license supports
            using password only login capabilities in the specified environment.
          type: boolean
        allowPasswordPolicy:
          description: A read-only boolean that specifies whether the license supports
            using password policies in the specified environment.
          type: boolean
        allowProvisioning:
          description: A read-only boolean that specifies whether the license supports
            using provisioning capabilities in the specified environment.
          type: boolean
        allowInboundProvisioning:
          type: boolean
        allowRoleAssignment:
          description: A read-only boolean that specifies whether the license supports
            role assignments in the specified environment.
          type: boolean
        allowVerificationFlow:
          description: A read-only boolean that specifies whether the license supports
            using verification flows in the specified environment.
          type: boolean
        allowUpdateSelf:
          description: A read-only boolean that specifies whether the license supports
            allowing users to update their own profile.
          type: boolean
        entitledToSupport:
          description: A read-only boolean that specifies whether the license allows
            PingOne support.
          type: boolean
        max:
          description: An read-only integer that specifies the maximum number of users
            allowed per environment.
          type: integer
        hardLimitMax:
          type: integer
        annualActiveIncluded:
          description: A read-only integer that specifies a soft limit on the number
            of active identities across all environments on the license per year.
            This property is not visible if a value is not provided at the time the
            license is created.
          type: integer
        monthlyActiveIncluded:
          description: A read-only integer that specifies a soft limit on the number
            of active identities across all environments on the license per month.
            This property is not visible if a value is not provided at the time the
            license is created.
          type: integer
      readOnly: true
      type: object
    License_verify:
      example:
        allowDocumentMatch: true
        allowManualIdInspection: true
        allowFaceMatch: true
        allowPushNotifications: true
      properties:
        allowPushNotifications:
          description: A read-only boolean that specifies whether to enable the PingOne
            Verify push notifications feature.
          type: boolean
        allowDocumentMatch:
          description: A read-only boolean that specifies whether to enable the PingOne
            Verify document matching feature.
          type: boolean
        allowFaceMatch:
          description: A read-only boolean that specifies whether to enable the PingOne
            Verify face matching feature.
          type: boolean
        allowManualIdInspection:
          description: A read-only boolean that specifies whether to enable the PingOne
            Verify manual ID inspection feature.
          type: boolean
      readOnly: true
      type: object
    NotificationsPolicy_cooldownConfiguration:
      description: Include the cooldownConfiguration object in the request if you
        want to specify a period of time that users must wait before requesting an
        additional notification such as an additional OTP.
      example:
        voice:
          resendLimit: 8
          periods:
          - duration: 404
            timeUnit: null
          - duration: 404
            timeUnit: null
          groupBy: groupBy
          enabled: true
        whatsApp:
          resendLimit: 8
          periods:
          - duration: 404
            timeUnit: null
          - duration: 404
            timeUnit: null
          groupBy: groupBy
          enabled: true
        sms:
          resendLimit: 8
          periods:
          - duration: 404
            timeUnit: null
          - duration: 404
            timeUnit: null
          groupBy: groupBy
          enabled: true
        email:
          resendLimit: 8
          periods:
          - duration: 404
            timeUnit: null
          - duration: 404
            timeUnit: null
          groupBy: groupBy
          enabled: true
      properties:
        email:
          $ref: '#/components/schemas/NotificationsPolicyCooldownConfigurationMethod'
        sms:
          $ref: '#/components/schemas/NotificationsPolicyCooldownConfigurationMethod'
        voice:
          $ref: '#/components/schemas/NotificationsPolicyCooldownConfigurationMethod'
        whatsApp:
          $ref: '#/components/schemas/NotificationsPolicyCooldownConfigurationMethod'
      required:
      - email
      - sms
      - voice
      - whatsApp
      type: object
    NotificationsPolicy_countryLimit:
      description: You can use the `countryLimit` object to limit the countries where
        you can send SMS and voice notifications.
      example:
        countries:
        - countries
        - countries
        type: null
        deliveryMethods:
        - null
        - null
      properties:
        type:
          $ref: '#/components/schemas/EnumNotificationsPolicyCountryLimitType'
        deliveryMethods:
          description: "The delivery methods that the defined limitation should be\
            \ applied to. Content of the array can be `SMS`, `Voice`, or both. If\
            \ the parameter is not provided, the default is `SMS` and `Voice`."
          items:
            $ref: '#/components/schemas/EnumNotificationsPolicyCountryLimitDeliveryMethod'
          type: array
        countries:
          description: The countries where the specified methods should be allowed
            or denied. Use the two-letter country codes from ISO 3166-1.
          items:
            pattern: "^[A-Z]{2}$"
            type: string
          type: array
      required:
      - countries
      - type
      type: object
    NotificationsPolicy_providerConfiguration_conditions_inner_fallbackChain_inner:
      example:
        id: id
      properties:
        id:
          description: The ID of one of the defined custom providers. This is the
            ID that is returned when you create the provider using the phoneDeliverySettings
            endpoint or when you run the GET request with that endpoint to retrieve
            the details of all the providers.
          type: string
      required:
      - id
      type: object
    NotificationsPolicy_providerConfiguration_conditions_inner:
      example:
        countries:
        - countries
        - countries
        deliveryMethods:
        - null
        - null
        fallbackChain:
        - id: id
        - id: id
      properties:
        deliveryMethods:
          description: "The authentication methods that the fallback order should\
            \ be used for. The array can contain VOICE, SMS, or both."
          items:
            $ref: '#/components/schemas/EnumNotificationsPolicyProviderConfigurationConditionsDeliveryMethods'
          type: array
        countries:
          description: The countries for which the fallback order should be used.
            Use the two-letter country codes from ISO 3166-1.
          items:
            pattern: "^[A-Z]{2}$"
            type: string
          type: array
        fallbackChain:
          description: "An array containing the IDs of the defined custom providers,\
            \ in the order that they should be used if available."
          items:
            $ref: '#/components/schemas/NotificationsPolicy_providerConfiguration_conditions_inner_fallbackChain_inner'
          type: array
      type: object
    NotificationsPolicy_providerConfiguration:
      description: "If you have defined more than one custom provider, you can use\
        \ the providerConfiguration object to specify the provider preference to use\
        \ for different countries and for the different methods (SMS and Voice)."
      example:
        conditions:
        - countries:
          - countries
          - countries
          deliveryMethods:
          - null
          - null
          fallbackChain:
          - id: id
          - id: id
        - countries:
          - countries
          - countries
          deliveryMethods:
          - null
          - null
          fallbackChain:
          - id: id
          - id: id
      properties:
        conditions:
          description: "Each element in the conditions array represents the provider\
            \ fallback order to use for a specific group of countries for the specified\
            \ methods (SMS and/or Voice). Note that in addition to any country-specific\
            \ orders specified, the array must contain a fallback order without the\
            \ countries array in the object. This order is used for all countries\
            \ that were not specified in one of the other fallback orders defined."
          items:
            $ref: '#/components/schemas/NotificationsPolicy_providerConfiguration_conditions_inner'
          type: array
      type: object
    NotificationsPolicy_quotas_inner:
      example:
        total: 9
        unclaimed: 3
        claimed: 6
        type: null
        deliveryMethods:
        - null
        - null
      properties:
        type:
          $ref: '#/components/schemas/EnumNotificationsPolicyQuotaItemType'
        deliveryMethods:
          description: |
            The delivery methods for which the limit is being defined. The value can be `Email` or `SMS,Voice`. When you use the `SMS`, `Voice` option, it means that the combined total of SMS and voice notifications must be below the limit defined. If you are limiting both email and SMS/voice, each limit should be represented by a different object in the `quotas` array, for example:
            `"quotas": [{"type": "USER","deliveryMethods": ["SMS","Voice"],"total": 30},{"type": "USER","deliveryMethods": ["Email"],"total": 30}]`
          items:
            $ref: '#/components/schemas/EnumNotificationsPolicyQuotaDeliveryMethods'
          type: array
        total:
          description: The maximum number of notifications allowed per day.
          type: integer
        claimed:
          description: The maximum number of notifications that can be received and
            responded to each day. Used in conjunction with unclaimed in place of
            the single field total.
          type: integer
        unclaimed:
          description: The maximum number of notifications that can be received and
            not responded to each day. Used in conjunction with claimed in place of
            the single field total.
          type: integer
      required:
      - deliveryMethods
      - type
      type: object
    NotificationsPolicyCooldownConfigurationMethod_periods_inner:
      example:
        duration: 404
        timeUnit: null
      properties:
        duration:
          description: "Used in conjunction with timeUnit to specify the waiting period.\
            \ Minimum is ten seconds, maximum is ten minutes."
          maximum: 600
          minimum: 10
          type: integer
        timeUnit:
          $ref: '#/components/schemas/EnumNotificationsPolicyCooldownConfigurationMethodPeriodTimeUnit'
      required:
      - duration
      - timeUnit
      type: object
    NotificationsSettings_restrictions_smsVoiceQuota:
      example:
        daily: 0
      properties:
        daily:
          description: |
            The maximum number of SMS and voice notifications that can be sent per user per day.
            - `restrictions.smsVoiceQuota.daily` can be set to any value between 0 and 50.
            - Trial accounts have a default value of 30.
            - The daily counters are reset every night at midnight UTC.
          type: integer
      required:
      - daily
      type: object
    NotificationsSettings_restrictions:
      example:
        smsVoiceQuota:
          daily: 0
      properties:
        smsVoiceQuota:
          $ref: '#/components/schemas/NotificationsSettings_restrictions_smsVoiceQuota'
      required:
      - smsVoiceQuota
      type: object
    NotificationsSettings_from:
      example:
        address: address
        name: name
      properties:
        name:
          description: "A string that specifies the email's \"from\" name (relevant\
            \ when the `deliveryMethod` is `Email`).  See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-settings-from-replyTo-note)\
            \ for details."
          type: string
        address:
          description: "A string that specifies the email's \"from\" address (relevant\
            \ when the `deliveryMethod` is `Email`). This value must be a trusted\
            \ email address.  See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-settings-from-replyTo-note)\
            \ for details."
          type: string
      type: object
    NotificationsSettings_replyTo:
      example:
        address: address
        name: name
      properties:
        name:
          description: "A string that specifies the email's \"reply to\" name (relevant\
            \ when `deliveryMethod` is `Email`).  See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-settings-from-replyTo-note)\
            \ for details."
          type: string
        address:
          description: "A string that specifies the email's \"reply to\" address (relevant\
            \ when `deliveryMethod` is `Email`). This value must be a trusted email\
            \ address.  See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#notifications-settings-from-replyTo-note)\
            \ for details."
          type: string
      type: object
    NotificationsSettings_whitelist_inner:
      example:
        user:
          id: id
      properties:
        user:
          $ref: '#/components/schemas/Application_accessControl_group_groups_inner'
      type: object
    NotificationsSettingsEmailDeliverySettingsCustom_allOf_authentication:
      description: Contains the information for authenticating with the email provider.
      properties:
        method:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationMethod'
        authToken:
          description: "If you specified `BEARER` as the authentication method, use\
            \ authToken to provide the bearer token to use."
          type: string
        username:
          description: "If you specified `BASIC` as the authentication method, use\
            \ username to provide the username for authenticating with the email provider."
          type: string
        password:
          description: "If you specified `BASIC` as the authentication method, use\
            \ password to provide the password for authenticating with the email provider."
          format: password
          type: string
        authUrl:
          description: The URL of the authorization server that issues the access
            token for the email provider. Required when `authentication.method=OAUTH2`
          type: string
        grantType:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationGrantType'
        assertion:
          description: The JWT assertion used to request the access token from the
            authorization server. Must be a valid JWT. Required when `authentication.grantType=JWT_BEARER`
          type: string
        clientId:
          description: The client ID used to request the access token from the authorization
            server. Required when `authentication.grantType=CLIENT_CREDENTIALS`
          type: string
        clientSecret:
          description: The client secret used to request the access token from the
            authorization server. Required when `authentication.grantType=CLIENT_CREDENTIALS`
          format: password
          type: string
        scopes:
          description: "An array of scopes to request in the access token from the\
            \ authorization server, for example, `mail.send`."
          items:
            type: string
          type: array
        headerName:
          description: The name of the custom header used to authenticate requests
            to the email provider. Required when `authentication.method=CUSTOM_HEADER`
          type: string
        headerValue:
          description: The value of the custom header used to authenticate requests
            to the email provider. Required when `authentication.method=CUSTOM_HEADER`
          type: string
        clientAuthenticationMethod:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomAuthenticationClientAuthenticationMethod'
      required:
      - method
      type: object
      example: null
    NotificationsSettingsEmailDeliverySettingsCustom_allOf_from:
      description: Contains the "from" information to use for the notifications.
      properties:
        name:
          description: The "from" name to use in the notifications that are sent.
          type: string
        address:
          description: The "from" address to use in the notifications that are sent.
          type: string
      type: object
      example: null
    NotificationsSettingsEmailDeliverySettingsCustom_allOf_replyTo:
      description: Contains the "reply-to" information to use for the notifications.
      properties:
        name:
          description: The "reply-to" name to use in the notifications that are sent.
          type: string
        address:
          description: The "reply-to" address to use in the notifications that are
            sent.
          type: string
      type: object
      example: null
    NotificationsSettingsEmailDeliverySettingsCustom_allOf_requests:
      properties:
        body:
          description: |
            Required if method is set to `POST`. Use body to provide the content of the body for the request sent to the email provider. The body that you define must include the mandatory PingOne variables for notifications: `${from}`, `${to}`, and `${message}`. You can also include any optional notification variables.
            If you are including the header `content-type: application/json` in `headers`:
            - The content of `body` must be valid JSON
            - You must enclose the JSON object in quotation marks and escape all quotation marks within the string, for example, `"{\"From\": \"${from}\",\"To\": \"${to}\",\"message2\": \"${message}\"}"`.
          type: string
        deliveryMethod:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomRequestsDeliveryMethod'
        headers:
          additionalProperties:
            type: string
          description: Use this object to specify the headers that your email provider's
            API expects.
          type: object
        method:
          $ref: '#/components/schemas/EnumNotificationsSettingsEmailDeliverySettingsCustomRequestsMethod'
        url:
          description: "Use url to specify the endpoint for your email provider, for\
            \ example, `https://api.example.com/email`. If `method` is set to `GET`,\
            \ append to the URL the various query parameters that the email provider's\
            \ API requires. The URL must also include the required PingOne variables,\
            \ as described for the body parameter."
          type: string
      required:
      - deliveryMethod
      - method
      - url
      type: object
      example: null
    NotificationsSettingsEmailDeliverySettingsSMTP_allOf_from:
      properties:
        name:
          description: A string that specifies the email's "from" name.
          type: string
        address:
          description: A string that specifies the email's "from" address.
          type: string
      required:
      - address
      type: object
      example: null
    NotificationsSettingsEmailDeliverySettingsSMTP_allOf_replyTo:
      properties:
        name:
          description: A string that specifies the email's "reply to" name.
          type: string
        address:
          description: A string that specifies the email's "reply to" address.
          type: string
      type: object
      example: null
    NotificationsSettingsPhoneDeliverySettingsCustom_allOf_authentication:
      properties:
        method:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthMethod'
        username:
          description: The username for the custom provider account. Required when
            `authentication.method=BASIC`
          type: string
        password:
          description: The password for the custom provider account. Required when
            `authentication.method=BASIC`
          format: password
          type: string
        authToken:
          description: The authentication token for the custom provider account.  Required
            when `authentication.method=BEARER`
          format: password
          type: string
        authUrl:
          description: The URL of the authorization server that issues the access
            token for the custom provider account. Required when `authentication.method=OAUTH2`
          type: string
        grantType:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthGrantType'
        assertion:
          description: The JWT assertion used to request the access token from the
            authorization server. Must be a valid JWT. Required when `authentication.grantType=JWT_BEARER`
          type: string
        clientId:
          description: The client ID used to request the access token from the authorization
            server. Required when `authentication.grantType=CLIENT_CREDENTIALS`
          type: string
        clientSecret:
          description: The client secret used to request the access token from the
            authorization server. Required when `authentication.grantType=CLIENT_CREDENTIALS`
          format: password
          type: string
        scopes:
          description: "An array of scopes to request in the access token from the\
            \ authorization server, for example, `sms:send`, `voice:send`."
          items:
            type: string
          type: array
        headerName:
          description: The name of the custom header used to authenticate requests
            to the custom provider. Required when `authentication.method=CUSTOM_HEADER`
          type: string
        headerValue:
          description: The value of the custom header used to authenticate requests
            to the custom provider. Required when `authentication.method=CUSTOM_HEADER`
          type: string
        clientAuthenticationMethod:
          $ref: '#/components/schemas/EnumNotificationsSettingsPhoneDeliverySettingsCustomAuthClientAuthenticationMethod'
      required:
      - method
      type: object
      example: null
    Organization_billingConnections_inner:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the list of the BillingConnection resource
            IDs for the organization.
          readOnly: true
          type: string
      type: object
    P1Error_details_inner_innerError:
      description: Additional details to help the client developer resolve the fault
        (primarily for UI validation reasons).
      properties:
        rangeMinimumValue:
          description: Errors that failed due to range violation. This attribute represents
            the minimum value of the range.
          type: integer
        rangeMaximumValue:
          description: The maximum range or value of an attribute.
          type: integer
        allowedPattern:
          description: A regex pattern describing an acceptable input pattern.
          type: string
        allowedValues:
          description: A list describing acceptable values.
          items:
            type: string
          type: array
        maximumValue:
          description: The maximum value allowed for the request.
          type: integer
        referencedValues:
          items:
            type: string
          type: array
      type: object
    P1Error_details_inner:
      properties:
        code:
          description: A general fault code which the client must handle to provide
            all exception handling routines and to localize messages for users. This
            code is common across all PingOne services and is human readable (such
            as a defined constant rather than a number).
          type: string
        target:
          description: The item that caused the error (such as a form field ID or
            an attribute inside a JSON object).
          type: string
        message:
          description: A short description of the error. This message is intended
            to assist with debugging and is returned in English only.
          type: string
        innerError:
          $ref: '#/components/schemas/P1Error_details_inner_innerError'
      type: object
    PasswordPolicy_alphabetSequenceRule:
      description: Number sequence rule options
      example:
        maxLength: 2
      properties:
        maxLength:
          description: Maximum number of allowed sequential English letters in the
            password. Must be a value of 2 or 3.
          format: int32
          maximum: 3
          minimum: 2
          type: integer
      type: object
    PasswordPolicy_history:
      description: Settings to control the users password history
      example:
        retentionDays: 1
        count: 1
      properties:
        count:
          description: "Specifies the number of prior passwords to keep for prevention\
            \ of password re-use. The value must be a positive, non-zero integer."
          minimum: 1
          type: integer
        retentionDays:
          description: "The length of time to keep recent passwords for prevention\
            \ of password re-use. The value must be a positive, non-zero integer."
          minimum: 1
          type: integer
      type: object
    PasswordPolicy_length:
      description: Settings to control the user's password length
      example:
        min: 24
        max: 6
      properties:
        max:
          default: 255
          description: The maximum number of characters allowed for the password.
            Defaults to 255. This property is not enforced when not present.
          type: integer
        min:
          default: 8
          description: The minimum number of characters required for the password.
            This can be from 8 to 32 (inclusive). Defaults to 8 characters. This property
            is not enforced when not present.
          maximum: 32
          minimum: 8
          type: integer
      type: object
    PasswordPolicy_lockout:
      description: Settings to control the user's lockout on unsuccessful authentication
        attempts
      example:
        durationSeconds: 1
        failureCount: 1
      properties:
        durationSeconds:
          description: "The length of time before a password is automatically moved\
            \ out of the lock out state. The value must be a positive, non-zero integer."
          minimum: 1
          type: integer
        failureCount:
          description: "The number of tries before a password is placed in the lockout\
            \ state. The value must be a positive, non-zero integer."
          minimum: 1
          type: integer
      type: object
    PasswordPolicy_minCharacters:
      description: "A set of key-value pairs where the key is contains all characters\
        \ that can be included, and the value is the minimum number of times one of\
        \ the characters must appear in the password. The only allowed key values\
        \ are `ABCDEFGHIJKLMNOPQRSTUVWXYZ`, `abcdefghijklmnopqrstuvwxyz`, `0123456789`,\
        \ and `~!@#$%^&*()-_=+[]{}\\|;:,.<>/?`. This property is not enforced when\
        \ not present."
      example:
        "~!@#$%^&*()-_=+[]{}|;:,.<>/?": 0
        "0123456789": 6
        ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0
        abcdefghijklmnopqrstuvwxyz: 7
      properties:
        ABCDEFGHIJKLMNOPQRSTUVWXYZ:
          description: Count of alphabetical uppercase characters (`ABCDEFGHIJKLMNOPQRSTUVWXYZ`)
            that should feature in the user's password.
          type: integer
        abcdefghijklmnopqrstuvwxyz:
          description: Count of alphabetical uppercase characters (`abcdefghijklmnopqrstuvwxyz`)
            that should feature in the user's password.
          type: integer
        "0123456789":
          description: Count of numeric characters (`0123456789`) that should feature
            in the user's password.
          type: integer
        "~!@#$%^&*()-_=+[]{}|;:,.<>/?":
          description: "Count of special characters (`~!@#$%^&*()-_=+[]{}\\\\|;:,.<>/?`)\
            \ that should feature in the user's password."
          type: integer
      type: object
    PasswordPolicy_numberSequenceRule:
      description: Number sequence rule options
      example:
        maxLength: 2
      properties:
        maxLength:
          description: Maximum number of allowed sequential numbers in the password.
            Must be a value of 2 or 3.
          format: int32
          maximum: 3
          minimum: 2
          type: integer
      type: object
    PasswordPolicy_shiftedNumberRowSequenceRule:
      description: Options to control policy rules for the allowed sequential symbol
        row characters.
      example:
        maxLength: 3
      properties:
        maxLength:
          description: Maximum number of allowed sequential symbol row characters.
            Must be a value of 3.
          format: int32
          maximum: 3
          minimum: 3
          type: integer
      type: object
    PasswordPolicy_qwertySequenceRule:
      description: Options to control policy rules for the number of allowed sequential
        QWERTY keyboard characters in the password.
      example:
        maxLength: 3
      properties:
        maxLength:
          description: Maximum number of allowed sequential QWERTY keyboard characters
            in the password. Must be a value of 3.
          format: int32
          maximum: 3
          minimum: 3
          type: integer
      type: object
    Population_passwordPolicy:
      description: The object reference to the password policy resource. This is an
        optional property.
      example:
        id: id
      properties:
        id:
          description: "The ID of the password policy that is used for this population.\
            \ If absent, the environment's default is used. Requried if `passwordPolicy`\
            \ is used."
          type: string
      required:
      - id
      type: object
    Population_theme:
      description: The object reference to the theme resource.
      example:
        id: id
      properties:
        id:
          description: "The ID of the theme to use for the population. If absent,\
            \ the environment's default is used."
          type: string
      type: object
    PropagationStore_image:
      example:
        href: href
        id: id
      properties:
        href:
          description: The URL for the identity store resource image file.
          type: string
        id:
          description: The image ID for the identity store resource.
          type: string
      type: object
    PropagationStore_syncStatus:
      example:
        failedCount: 0
        lastSyncAt: 2000-01-23T04:56:07.000+00:00
        userTotal: 5
        syncState: null
        failedDeprovisionCount: 6
        successCount: 1
        details: details
      properties:
        details:
          description: Details of any synchronization errors.
          readOnly: true
          type: string
        failedCount:
          description: A count of failed synchronization events since the last revision.
          readOnly: true
          type: integer
        failedDeprovisionCount:
          description: A count of failed deprovisioning synchronization events since
            the last revision.
          readOnly: true
          type: integer
        lastSyncAt:
          description: The last synchronization in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
          format: date-time
          readOnly: true
          type: string
        successCount:
          description: A count of successful synchronization events since the last
            revision.
          readOnly: true
          type: integer
        syncState:
          $ref: '#/components/schemas/EnumPropagationStoreSyncState'
        userTotal:
          description: A count of users that will synchronize to the target store
            based on the Rule’s filter.
          readOnly: true
          type: integer
      readOnly: true
      type: object
    Resource_applicationPermissionsSettings:
      description: An object that specifies whether to add application permissions
        to access tokens generated by PingOne.
      example:
        claimEnabled: true
      properties:
        claimEnabled:
          description: "A setting to enable application permission claims in the access\
            \ token. If this property is omitted, the value is set to `false`."
          type: boolean
      type: object
    ResourceApplicationResource_parent:
      description: The application resource's parent.
      example:
        id: id
        type: null
      properties:
        type:
          $ref: '#/components/schemas/EnumResourceApplicationResourceType'
        id:
          description: The application resource's parent ID.
          type: string
      readOnly: true
      type: object
    ResourceApplicationPermission_resource:
      description: An object that identifies the associated application resource.
      example:
        name: name
        id: id
      properties:
        id:
          description: The ID for the associated application resource.
          type: string
        name:
          description: The name of the associated application resource.
          type: string
      readOnly: true
      type: object
    ResourceApplicationPermission_resourceServer_environment:
      example:
        id: id
      properties:
        id:
          description: The ID for the environment associated with the application
            resource server.
          type: string
      type: object
    ResourceApplicationPermission_resourceServer:
      description: An object that identifies the associated application resource server.
      example:
        environment:
          id: id
        id: id
      properties:
        id:
          description: The ID for the associated application resource server.
          type: string
        environment:
          $ref: '#/components/schemas/ResourceApplicationPermission_resourceServer_environment'
      readOnly: true
      type: object
    ResourceSecret_previous:
      description: "An object that specifies the resource's previous secret, when\
        \ it expires, and when it was last used."
      example:
        lastUsed: 2000-01-23T04:56:07.000+00:00
        secret: secret
        expiresAt: 2000-01-23T04:56:07.000+00:00
      properties:
        secret:
          description: A string that specifies the resource's previous secret. This
            property is returned in the response if the previous secret is not expired.
          format: password
          readOnly: true
          type: string
        expiresAt:
          description: A timestamp that specifies how long this secret is saved (and
            can be used) before it expires. Supported time range is 1 minute to 30
            days.
          format: date-time
          type: string
        lastUsed:
          description: A timestamp that specifies when the previous secret was last
            used.
          format: date-time
          readOnly: true
          type: string
      required:
      - expiresAt
      type: object
    Role_permissions_inner:
      example:
        classifier: classifier
        description: description
        id: id
      properties:
        classifier:
          description: A string that specifies the resource for which the permission
            is applicable.
          readOnly: true
          type: string
        description:
          description: A string that specifies the description of what the permission
            enables for the role.
          readOnly: true
          type: string
        id:
          description: The ID of a permission associated with this role.
          readOnly: true
          type: string
      type: object
    RoleAssignment_group:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the group ID.
          type: string
      readOnly: true
      type: object
    RoleAssignment_role:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the role ID.
          type: string
      required:
      - id
      type: object
    RoleAssignment_scope:
      example:
        id: id
        type: null
      properties:
        id:
          description: A string that specifies the role assignment scope ID.
          type: string
        type:
          $ref: '#/components/schemas/EnumRoleAssignmentScopeType'
      required:
      - id
      - type
      type: object
    SchemaAttribute_schema:
      example:
        id: id
      properties:
        id:
          description: A string that specifies the identifier of the resource referenced
            by this relationship.
          readOnly: true
          type: string
      type: object
    SchemaAttribute_enumeratedValues_inner:
      description: An object representation of an enumerated value. Maximum number
        of enumerations is 100.
      example:
        archived: true
        description: description
        value: value
      properties:
        value:
          description: A string that specifies the immutable value. Values are case
            sensitive; two values that differ only by case are not allowed.
          type: string
        archived:
          description: "A boolean that specifies whether the enumerated value is archived.\
            \ Archived values cannot be added to a user, but existing archived values\
            \ are preserved. This allows clients that read the schema to know all\
            \ possible values of an attribute."
          type: boolean
        description:
          description: A string that specifies the description of the enumerated value.
          type: string
      required:
      - value
      type: object
    SchemaAttribute_regexValidation:
      description: Object representation of the optional regular expression representation
        of this attribute.
      example:
        valuesPatternShouldNotMatch:
        - valuesPatternShouldNotMatch
        - valuesPatternShouldNotMatch
        requirements: requirements
        valuesPatternShouldMatch:
        - valuesPatternShouldMatch
        - valuesPatternShouldMatch
        pattern: pattern
      properties:
        pattern:
          description: A string that specifies the regular expression to which the
            attribute must conform.
          type: string
        requirements:
          description: A string that specifies a developer friendly description of
            the regular expression requirements.
          type: string
        valuesPatternShouldMatch:
          description: An array that specifies the list of strings matching the regular
            expression.
          items:
            type: string
          type: array
        valuesPatternShouldNotMatch:
          description: An array that specifies the list of strings not matching the
            regular expression.
          items:
            type: string
          type: array
      required:
      - pattern
      - requirements
      type: object
    SignOnPolicyActionCommonConditionIPRisk_ipRisk:
      properties:
        minScore:
          minimum: 1
          type: integer
        maxScore:
          minimum: 1
          type: integer
      required:
      - maxScore
      - minScore
      type: object
    SignOnPolicyActionCommonConditionGeovelocity_valid:
      properties:
        previousSuccessfulAuthenticationIp:
          type: string
        previousSuccessfulAuthenticationTime:
          type: string
      required:
      - previousSuccessfulAuthenticationIp
      - previousSuccessfulAuthenticationTime
      type: object
    SignOnPolicyActionCommonConditionEquals_equals:
      oneOf:
      - type: string
      - type: boolean
    SignOnPolicyActionCommonConditionOr_or_inner:
      oneOf:
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionAnd'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionOr'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionNot'
      - $ref: '#/components/schemas/SignOnPolicyActionCommonConditionAggregate'
    SignOnPolicyActionCommon_signOnPolicy:
      description: The sign-on policy associated with this sign-on policy assignment
      example:
        id: id
      properties:
        id:
          description: A string that specifies the sign-on policy resource's unique
            identifier associated with this sign-on policy assignment.
          type: string
      required:
      - id
      type: object
    SignOnPolicyActionLogin_allOf_newUserProvisioning_userType:
      description: A reference to the ID of the `userTypes` configuration set on the
        gateway for user account migration.
      properties:
        id:
          description: A string referencing the UUID of `userType`.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_newUserProvisioning_gateways:
      properties:
        id:
          description: A string referencing the UUID for the gateway.
          type: string
        type:
          $ref: '#/components/schemas/EnumSignOnPolicyActionLoginNewUserProvisioningGatewayType'
        userType:
          $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_newUserProvisioning_userType'
      required:
      - id
      - type
      - userType
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_newUserProvisioning:
      description: "Enables user entries existing outside of PingOne to be provisioned\
        \ in PingDirectory during login, using an external integration solution (such\
        \ as a Gateway)."
      properties:
        gateways:
          description: "Allows a set of preconfigured gateways or `userType` pairs\
            \ that are specified in the [Gateway Management](https://apidocs.pingidentity.com/pingone/platform/v1/api/#gateway-management)\
            \ schema to determine how to find and migrate user entries existing in\
            \ an external directory."
          items:
            $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_newUserProvisioning_gateways'
          type: array
      required:
      - gateways
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_recovery:
      description: Specifies the account recovery options.
      properties:
        enabled:
          description: "A boolean that specifies the enabled/disabled state of the\
            \ account recovery action. The default is disabled when creating a new\
            \ policy. When enabled, it allows the use of the forgot password flow."
          type: boolean
      required:
      - enabled
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_registration_external:
      properties:
        href:
          description: A string that specifies the link to the external identity provider's
            identity store. This property is set when the administrator chooses to
            have users register in an external identity store. This attribute can
            be set only when the registration.enabled property is set to false.
          type: string
      required:
      - href
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_registration_population:
      properties:
        id:
          description: A string that specifies the population ID associated with the
            newly registered user.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_registration:
      description: Specifies the account registration options.
      properties:
        enabled:
          description: "A boolean that specifies the enabled/disabled state of the\
            \ policy action. The default is disabled when creating a new policy. When\
            \ enabled, it allows the use of the new user registration flow. This attribute\
            \ should be set to true when implementing the social login sign-on policy\
            \ option."
          type: boolean
        external:
          $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_registration_external'
        population:
          $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_registration_population'
        confirmIdentityProviderAttributes:
          default: false
          description: "A boolean that specifies whether users must confirm data returned\
            \ from an identity provider prior to registration. Users can modify the\
            \ data and omit non-required attributes. Modified attributes are added\
            \ to the user's profile during account creation. This is an optional property.\
            \ If omitted, the default value is set to false."
          type: boolean
      required:
      - enabled
      type: object
      example: null
    SignOnPolicyActionLogin_allOf_socialProviders:
      properties:
        id:
          description: ID of the identity provider that can be used for the social
            login sign-on flow.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_authenticator:
      deprecated: true
      description: Specifies MFA through a Time-based One-time Password (TOTP) option
        over a third-party authenticator application.
      properties:
        enabled:
          default: false
          description: "A boolean that specifies the enabled/disabled state of the\
            \ MFA through a Time-based One-time Password (TOTP) action. The default\
            \ is disabled when creating a new policy. When enabled, it allows users\
            \ to authenticate using a TOTP authenticator application."
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_boundBiometrics:
      deprecated: true
      description: Specifies MFA through a FIDO2 biometrics platform device.
      properties:
        enabled:
          default: false
          description: A boolean that specifies whether to permit users to authenticate
            with a FIDO2 biometrics platform device.
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_email:
      deprecated: true
      description: Specifies MFA through email options.
      properties:
        enabled:
          default: false
          description: "A boolean that specifies the enabled/disabled state of the\
            \ MFA through email action. The default is disbled when creating a new\
            \ policy. When enabled, it allows users to receive the one-time password\
            \ and authenticate through email."
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_securityKey:
      deprecated: true
      description: Specifies MFA using a FIDO2 or U2F security key device.
      properties:
        enabled:
          default: false
          description: A boolean that specifies whether to permit users to authenticate
            with a security key device.
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_sms:
      deprecated: true
      description: Specifies MFA through SMS text messaging options.
      properties:
        enabled:
          default: false
          description: "A boolean that specifies the enabled/disabled state of the\
            \ MFA through SMS action. The default is disabled when creating a new\
            \ policy. When enabled, it allows users to receive the one-time password\
            \ and authenticate through SMS text message."
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_voice:
      deprecated: true
      description: Specifies MFA through voice messaging options.
      properties:
        enabled:
          default: false
          description: "A boolean that specifies the enabled/disabled state of the\
            \ MFA through voice message action. The default is disabled when creating\
            \ a new policy. When enabled, it allows users to receive the one-time\
            \ password and authenticate through a voice message."
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_autoEnrollment:
      properties:
        enabled:
          default: false
          description: "A boolean that specifies the enabled/disabled state of automatic\
            \ MFA enrollment for the application.  When enabled, it allows automatic\
            \ enrollment of the native application to MFA during the authentication\
            \ flow."
          type: boolean
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_deviceAuthorization:
      properties:
        enabled:
          default: false
          description: A boolean that specifies the enabled/disabled state of automatic
            MFA for native devices paired with the user for the specified application.
          type: boolean
        extraVerification:
          $ref: '#/components/schemas/EnumSignOnPolicyExtraVerification'
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_applications:
      properties:
        id:
          type: string
        autoEnrollment:
          $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_autoEnrollment'
        deviceAuthorization:
          $ref: '#/components/schemas/SignOnPolicyActionMFA_allOf_deviceAuthorization'
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionMFA_allOf_deviceAuthenticationPolicy:
      description: "Details of the MFA policy that should be used. If it is omitted,\
        \ the environment default MFA policy is used."
      properties:
        id:
          description: The ID of the MFA policy that should be used.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionIDFirst_allOf_condition:
      properties:
        contains:
          type: string
        value:
          type: string
      required:
      - contains
      - value
      type: object
      example: null
    SignOnPolicyActionIDFirst_allOf_identityProvider:
      properties:
        id:
          description: A string that specifies the identity provider that will be
            used to authenticate the user if the condition is matched.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionIDFirst_allOf_discoveryRules:
      properties:
        condition:
          $ref: '#/components/schemas/SignOnPolicyActionIDFirst_allOf_condition'
        identityProvider:
          $ref: '#/components/schemas/SignOnPolicyActionIDFirst_allOf_identityProvider'
      required:
      - condition
      - identityProvider
      type: object
      example: null
    SignOnPolicyActionIDP_allOf_identityProvider:
      description: A reference to the external identity provider that is used to authenticate
        the user. This property is required.
      properties:
        id:
          description: A string that specifies the ID of the external identity provider
            to which the user is redirected for sign-on. This property is required.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionIDP_allOf_registration:
      description: Specifies the account registration options.
      properties:
        confirmIdentityProviderAttributes:
          default: false
          description: "A boolean that specifies whether users must confirm data returned\
            \ from an identity provider prior to registration. Users can modify the\
            \ data and omit non-required attributes. Modified attributes are added\
            \ to the user's profile during account creation. This is an optional property.\
            \ If omitted, the default value is set to false."
          type: boolean
        enabled:
          description: "A boolean that specifies the enabled/disabled state of the\
            \ policy action. The property is disabled by default when creating a new\
            \ policy. When enabled, it allows the use of the new user registration\
            \ flow. This attribute should be set to true when implementing the social\
            \ login sign-on policy option."
          type: boolean
        population:
          $ref: '#/components/schemas/SignOnPolicyActionLogin_allOf_registration_population'
      required:
      - enabled
      type: object
      example: null
    SignOnPolicyActionAgreement_allOf_agreement:
      description: The relationship to the agreement to which the user must consent.
        The agreement must exist and be enabled. An agreement cannot be disabed if
        an action uses it. An enabled agreement must always support the default language.
        This property is required.
      properties:
        id:
          description: A string that specifies the ID of the agreement to which the
            user must consent. This property is required.
          type: string
      required:
      - id
      type: object
      example: null
    SignOnPolicyActionProgressiveProfiling_allOf_attributes:
      properties:
        name:
          description: "A string that specifies the name and path of the user profile\
            \ attribute as defined in the user schema (for example, email or address.postalCode).\
            \ This property is required."
          type: string
        required:
          description: A boolean that specifies whether the user is required to provide
            a value for the attribute. This property is required.
          type: boolean
      required:
      - name
      - required
      type: object
      example: null
    SignOnPolicyActionPingIDWinLoginPasswordless_allOf_uniqueUserAttribute:
      properties:
        name:
          description: Schema attributes to match against the provided identifier
            when searching for a user in the directory. Only unique attributes may
            be included.
          type: string
      required:
      - name
      type: object
      example: null
    SignOnPolicyActionPingIDWinLoginPasswordless_allOf_offlineMode:
      properties:
        enabled:
          description: Select this option to allow users to log in when PingOne and
            or PingID are not available.
          type: boolean
      required:
      - enabled
      type: object
      example: null
    Subscription_connectionDetails:
      example:
        headers:
          key: headers
        url: url
      properties:
        url:
          description: A string that specifies a valid URL to which event messages
            are sent. This is a required property.
          type: string
        headers:
          additionalProperties:
            type: string
          description: "An object map of strings that specifies the headers applied\
            \ to the outbound request (for example, `Authorization` `Basic usernamepassword`.\
            \ The purpose of these headers is for the endpoint to authenticate the\
            \ PingOne service, ensuring that the information from PingOne is from\
            \ a trusted source."
          type: object
      required:
      - url
      type: object
    Subscription_filterOptions_includedApplications_inner:
      example:
        id: id
      maxItems: 10
      properties:
        id:
          type: string
      required:
      - id
      type: object
    Subscription_filterOptions:
      example:
        includedActionTypes:
        - includedActionTypes
        - includedActionTypes
        includedTags:
        - null
        - null
        userAgentExposed: false
        includedPopulations:
        - id: id
        - id: id
        ipAddressExposed: false
        includedApplications:
        - id: id
        - id: id
      properties:
        includedActionTypes:
          description: A non-empty array that specifies the list of action types that
            should be matched for the subscription. This is a required property.
          items:
            type: string
          type: array
        includedApplications:
          description: "An array that specifies the list of applications (by ID) whose\
            \ events are monitored by the subscription (maximum of 10 IDs in the array).\
            \ This is an optional property. If a list of applications is not provided,\
            \ events are monitored for all applications in the environment."
          items:
            $ref: '#/components/schemas/Subscription_filterOptions_includedApplications_inner'
          type: array
        includedPopulations:
          description: "An array that specifies the list of populations (by ID) whose\
            \ events are monitored by the subscription (maximum of 10 IDs in the array).\
            \ This property matches events for users in the specified populations,\
            \ as opposed to events generated in which the user in one of the populations\
            \ is the actor. This is an optional property."
          items:
            $ref: '#/components/schemas/Subscription_filterOptions_includedApplications_inner'
          type: array
        includedTags:
          description: "An array of tags that events must have to be monitored by\
            \ the subscription. If tags are not specified, all events are monitored.\
            \ Currently, the available tags are `adminIdentityEvent`. Identifies the\
            \ event as the action of an administrator on other administrators."
          items:
            $ref: '#/components/schemas/EnumSubscriptionFilterIncludedTags'
          type: array
        ipAddressExposed:
          default: false
          description: Whether the IP address of an actor should be present in the
            `source` section of the event.
          type: boolean
        userAgentExposed:
          default: false
          description: Whether the User-Agent HTTP header of an event should be present
            in the `source` section of the event.
          type: boolean
      required:
      - includedActionTypes
      type: object
    Subscription_httpEndpoint:
      example:
        headers:
          key: headers
        url: url
      properties:
        url:
          description: A string that specifies a valid HTTPS URL to which event messages
            are sent. This is a required property.
          type: string
        headers:
          additionalProperties:
            type: string
          description: "An object map of strings that specifies the headers applied\
            \ to the outbound request (for example, `Authorization` `Basic usernamepassword`.\
            \ The purpose of these headers is for the HTTPS endpoint to authenticate\
            \ the PingOne service, ensuring that the information from PingOne is from\
            \ a trusted source."
          type: object
      required:
      - url
      type: object
    Subscription_payloadOptions_maximumPayloadLimit:
      example:
        size: 4
        type: null
      properties:
        type:
          $ref: '#/components/schemas/EnumSubscriptionPayloadOptionsMaximumPayloadLimitType'
        size:
          description: The maximum size of the payload based on `type`. For `EVENTS_PER_PAYLOAD`
            this can be from `1` to `500` events (defaults to `500`). For `KB_PER_PAYLOAD`
            this can be from `1` to `4096` kilobytes.
          type: integer
      type: object
    Subscription_payloadOptions_payloadFormat_tcp:
      example:
        format: null
        additionalAttributes:
          key: additionalAttributes
      properties:
        format:
          $ref: '#/components/schemas/EnumSubscriptionPayloadFormatTcpFormat'
        additionalAttributes:
          additionalProperties:
            type: string
          type: object
      type: object
    Subscription_payloadOptions_payloadFormat_https:
      example:
        prettyPrint: true
        format: null
      properties:
        format:
          $ref: '#/components/schemas/EnumSubscriptionPayloadFormatHttpsFormat'
        prettyPrint:
          description: Only applicable when `format` is `JSON_ARRAY`. Pretty-print
            is enabled when `true`.
          type: boolean
      type: object
    Subscription_payloadOptions_payloadFormat:
      example:
        tcp:
          format: null
          additionalAttributes:
            key: additionalAttributes
        https:
          prettyPrint: true
          format: null
      properties:
        tcp:
          $ref: '#/components/schemas/Subscription_payloadOptions_payloadFormat_tcp'
        https:
          $ref: '#/components/schemas/Subscription_payloadOptions_payloadFormat_https'
      type: object
    Subscription_payloadOptions:
      example:
        maximumPayloadLimit:
          size: 4
          type: null
        payloadFormat:
          tcp:
            format: null
            additionalAttributes:
              key: additionalAttributes
          https:
            prettyPrint: true
            format: null
      properties:
        maximumPayloadLimit:
          $ref: '#/components/schemas/Subscription_payloadOptions_maximumPayloadLimit'
        payloadFormat:
          $ref: '#/components/schemas/Subscription_payloadOptions_payloadFormat'
      type: object
    Subscription_tlsClientAuthKeyPair:
      description: An onject that describes the TLS client authentication key pair
        to use for mTLS.
      example:
        id: id
      properties:
        id:
          description: "The ID of a key to be used for outbound mutual TLS (mTLS)\
            \ authentication. This key is used as a client credential to authenticate\
            \ the webhook. The key must have a `usageType` of `OUTBOUND_MTLS`. See\
            \ [Certificate management](https://apidocs.pingidentity.com/pingone/platform/v1/api/#certificate-management)\
            \ for information on creating a key. If this property is set, `verifyTlsCertificates`\
            \ must be set to `true`."
          type: string
      type: object
    TemplateContentEmail_allOf_from:
      properties:
        name:
          default: PingOne
          description: |
            The email's sender name.
            If the environment uses the Ping Identity email sender, the name "PingOne" is used.
            You can configure other email sender names per environment.
            See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#from-replyTo-note) for details.
          type: string
        address:
          default: noreply@pingidentity.com
          description: |
            The sender email address.
            If the environment uses the Ping Identity email sender, or if the address field is empty, the address "noreply@pingidentity.com" is used.
            You can configure other email sender addresses per environment.
            See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#from-replyTo-note) for details.
          type: string
      type: object
      example: null
    TemplateContentEmail_allOf_replyTo:
      properties:
        name:
          default: PingOne
          description: |
            The email's "reply to" name.
            If the environment uses the Ping Identity email sender, the name "PingOne" is used.
            You can configure other email "reply to" names per environment.
            See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#from-replyTo-note) for details.
          type: string
        address:
          default: noreply@pingidentity.com
          description: |
            The "reply to" email address.
            If the environment uses the Ping Identity email sender, or if the address field is empty, the address "noreply@pingidentity.com" is used.
            You can configure other email "reply to" addresses per environment.
            See [Note](https://apidocs.pingidentity.com/pingone/platform/v1/api/#from-replyTo-note) for details.
          type: string
      type: object
      example: null
    User_address:
      example:
        streetAddress: streetAddress
        countryCode: countryCode
        postalCode: postalCode
        locality: locality
        region: region
      properties:
        countryCode:
          description: "A string that specifies the country name component. When specified,\
            \ the value must be in ISO 3166-1 `alpha-2` code format [ISO3166]. For\
            \ example, the country codes for the United States and Sweden are `US`\
            \ and \"SE\", respectively. Valid characters consist of two upper-case\
            \ letters (regex `[A-Z]{2}`)."
          pattern: "^[A-Z]{2}$"
          type: string
        locality:
          description: "A string that specifies the city or locality component of\
            \ the address. The string can contain any letters, numbers, combining\
            \ characters, math and currency symbols, dingbats and drawing characters,\
            \ and invisible whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\\
            p{P}]*$`). It can have a length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        postalCode:
          description: "A string that specifies the zip code or postal code component\
            \ of the address. The string can contain any letters, numbers, combining\
            \ characters, math and currency symbols, dingbats and drawing characters,\
            \ and invisible whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\\
            p{P}]*$`). It can have a length of no more than 40 characters (min/max=1/40)."
          maxLength: 40
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        region:
          description: "A string that specifies the state or region component of the\
            \ address. The string can contain any letters, numbers, combining characters,\
            \ math and currency symbols, dingbats and drawing characters, and invisible\
            \ whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It\
            \ can have a length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        streetAddress:
          description: "A string that specifies the full street address component,\
            \ which may include house number, street name, P.O. box, and multi-line\
            \ extended street address information. This attribute may contain newlines\
            \ (regex `^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}\\n\\r]*$`). It can have a\
            \ length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{N}\\p{Zs}\\p{P}\\n\\r]*$"
          type: string
      type: object
    User_identityProvider:
      example:
        id: id
        type: null
      properties:
        id:
          description: "A mutable string that identifies the external identity provider\
            \ used to authenticate the user. If not provided, PingOne is the identity\
            \ provider. This attribute is required if the identity provider is authoritative\
            \ for just-in-time user provisioning."
          type: string
        type:
          $ref: '#/components/schemas/EnumIdentityProvider'
      type: object
    User_lastSignOn:
      example:
        at: 2000-01-23T04:56:07.000+00:00
        remoteIp: remoteIp
      properties:
        at:
          description: The time of the last successful login of the user through the
            PingOne flow API.
          format: date-time
          type: string
        remoteIp:
          description: The IP address of the last successful login of the user through
            the PingOne flow API.
          type: string
      readOnly: true
      type: object
    User_lifecycle:
      example:
        suppressVerificationCode: true
        status: null
      properties:
        status:
          $ref: '#/components/schemas/EnumUserLifecycleStatus'
        suppressVerificationCode:
          description: "Used when importing a user and the lifecycle.status is set\
            \ to VERIFICATION_REQUIRED. If this property is set to true, no verification\
            \ email is sent to the user. If this property is omitted or set to false,\
            \ a verification email is sent automatically to the user."
          type: boolean
      type: object
    User_name:
      example:
        given: given
        honorificSuffix: honorificSuffix
        middle: middle
        formatted: formatted
        honorificPrefix: honorificPrefix
        family: family
      properties:
        family:
          description: "A string that specifies the family name of the user, or Last\
            \ in most Western languages (for example, ‘Jensen’ given the full name\
            \ ‘Ms. Barbara J Jensen, III’). This may be explicitly set to null when\
            \ updating a name to unset it. Valid characters consist of any Unicode\
            \ letter, mark (for example, accent, umlaut), space, dot, apostrophe,\
            \ or hyphen (regex `^[\\p{L}\\p{M}\\p{N}' .-]*$`). It can have a length\
            \ of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{N}' .-]*$"
          type: string
        formatted:
          description: "A string that specifies the fully formatted name of the user\
            \ (for example ‘Ms. Barbara J Jensen, III’). This can be explicitly set\
            \ to null when updating a name to unset it. Valid characters consist of\
            \ any Unicode letter, mark (for example, accent, umlaut), space, dot,\
            \ apostrophe, or hyphen (regex `^[\\p{L}\\p{M}\\p{N}' .-]*$`). It can\
            \ have a length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{N}' .-]*$"
          type: string
        given:
          description: "A string that specifies the given name of the user, or First\
            \ in most Western languages (for example, ‘Barbara’ given the full name\
            \ ‘Ms. Barbara J Jensen, III’). This may be explicitly set to null when\
            \ updating a name to unset it. The string can contain any letters, numbers,\
            \ combining characters, math and currency symbols, dingbats and drawing\
            \ characters, and invisible whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\\
            p{S}\\p{N}\\p{P}]*$`). It can have a length of no more than 256 characters\
            \ (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
        honorificPrefix:
          description: "A string that specifies the honorific prefix(es) of the user,\
            \ or title in most Western languages (for example, ‘Ms.’ given the full\
            \ name ‘Ms. Barbara Jane Jensen, III’). This can be explicitly set to\
            \ null when updating a name to unset it."
          type: string
        honorificSuffix:
          description: "A string that specifies the honorific suffix(es) of the user,\
            \ or suffix in most Western languages (for example, ‘III’ given the full\
            \ name ‘Ms. Barbara Jane Jensen, III’). This can be explicitly set to\
            \ null when updating a name to unset it."
          type: string
        middle:
          description: "A string that specifies the the middle name(s) of the user\
            \ (for exmple, ‘Jane’ given the full name ‘Ms. Barbara Jane Jensen, III’\
            ). This can be explicitly set to null when updating a name to unset it.\
            \ The string can contain any letters, numbers, combining characters, math\
            \ and currency symbols, dingbats and drawing characters, and invisible\
            \ whitespace (regex `^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$`). It\
            \ can have a length of no more than 256 characters (min/max=1/256)."
          maxLength: 256
          minLength: 1
          pattern: "^[\\p{L}\\p{M}\\p{Zs}\\p{S}\\p{N}\\p{P}]*$"
          type: string
      type: object
    User_password_external_gateway_userType:
      description: A reference to a userType in the list of userTypes values for an
        LDAP gateway.
      example:
        id: id
      properties:
        id:
          description: The UUID of a user type in the list of userTypes for the LDAP
            gateway.
          type: string
      type: object
    User_password_external_gateway:
      description: "An object containing the gateway properties. When this is value\
        \ is specified, the user’s password is managed in an external directory. You\
        \ can set the user password using Create User (Import) or Update Password\
        \ (Set)."
      example:
        id: id
        userType:
          id: id
        correlationAttributes: "{}"
        type: null
      properties:
        id:
          description: The UUID of the linked gateway that references the remote directory.
          type: string
        type:
          $ref: '#/components/schemas/EnumGatewayType'
        userType:
          $ref: '#/components/schemas/User_password_external_gateway_userType'
        correlationAttributes:
          description: An object that maps the external LDAP directory attributes
            to PingOne attributes. We use the correlationAttributes values to read
            the attributes from the external LDAP directory and map them to the corresponding
            PingOne attributes.
          type: object
      type: object
    User_password_external:
      description: "An object that maps the information relevant to the user’s password,\
        \ and its association to external directories."
      example:
        gateway:
          id: id
          userType:
            id: id
          correlationAttributes: "{}"
          type: null
      properties:
        gateway:
          $ref: '#/components/schemas/User_password_external_gateway'
      type: object
    User_password:
      description: An object that specifies the user's password. This property is
        never returned in the response.
      example:
        external:
          gateway:
            id: id
            userType:
              id: id
            correlationAttributes: "{}"
            type: null
        forceChange: true
        value: value
      properties:
        forceChange:
          description: "A boolean that specifies whether the user is forced to change\
            \ the password on the next log in. If not provided, the property is set\
            \ to false."
          type: boolean
        value:
          description: A string that specifies the user's password value. The string
            is either in cleartext or pre-encoded format.
          format: password
          type: string
        external:
          $ref: '#/components/schemas/User_password_external'
      type: object
    User_photo:
      example:
        href: href
      properties:
        href:
          description: "A string that specifies the URI that is a uniform resource\
            \ locator (as defined in Section 1.1.3 of RFC 3986) that points to a resource\
            \ location representing the user’s image. This can be removed from a user\
            \ by setting the photo attribute to null. If provided, the resource must\
            \ be a file (for example, a GIF, JPEG, or PNG image file) rather than\
            \ a web page containing an image. It must be a valid URL that starts with\
            \ the HTTP or HTTPS scheme."
          type: string
      required:
      - href
      type: object
    User_population:
      example:
        id: id
      properties:
        id:
          description: "A string that specifies the identifier of the population resource\
            \ associated with the user. This property cannot be updated using PUT\
            \ {{apiPath}}/environments/{{environmentID}}/users/{{userID}}. However,\
            \ it can be updated using PUT /environments/{{environmentID}}/users/{{userID}}/population."
          type: string
      required:
      - id
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: OAuth bearer token (see documentation)
      scheme: bearer
      type: http