openapi: 3.2.0
info:
  title: Trust Protection Foundation WebSDK Access Management APIs…
  description: '# Introduction

    The Trust Protection Foundation Web SDK is a subset of REST APIs that allow you to:

    * Automate certificate management

    * Integrate with DevOps processes

    * Discover machine identities

    * Extract data to integrate with data warehouses

    * Perform bulk actions

    * Set up and administer Trust Protection Foundation

    * Onboard teams

    * Create custom, automated business logic and flows between internal systems


    All these use cases can be accomplished using the Trust Protection Foundation REST…'
  version: 26.1.1
servers:
- url: /
  description: Current Host
- url: https://REPLACEdnsnameME/
  description: System
- url: https://{dnsname}/
  description: Configurable Hostname
  variables:
    dnsname:
      default: localhost
      description: Production API Hostname
security:
- AccessToken: []
tags:
- name: Access Management APIs
  description: 'The endpoints in this section allow you to manage your OAuth environment.

    Using endpoints described in this section, you can configure your global OAuth properties, assign roles

    to identities, create and manage applications, and create grant rules. After these are in

    place, users can request grants using the authentication server. This section also includes

    descriptions of endpoints that allow you to view and revoke issued grants.'
paths:
  /vedsdk/oauth/grantrole:
    post:
      tags:
      - Access Management APIs
      summary: Assign a role
      description: 'Assigns an OAuth role to an identity


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GrantRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_grantrole'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_grantrole'
      security:
      - AccessToken: []
  /vedsdk/oauth/revokerole:
    post:
      tags:
      - Access Management APIs
      summary: Remove a role
      description: 'Removes a role assignment from an identity


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_RevokeRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_revokerole'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_revokerole'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/listroles:
    post:
      tags:
      - Access Management APIs
      summary: Get assigned roles
      description: 'Gets all identities with assigned roles


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_ListRoles
      requestBody:
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_listroles'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getrole:
    post:
      tags:
      - Access Management APIs
      summary: Get own role
      description: 'Returns the callers OAuth role


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetRole
      requestBody:
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getrole'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getconfiguration:
    post:
      tags:
      - Access Management APIs
      summary: Get configuration
      description: 'Gets the OAuth subsystem configuration


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetConfiguration
      requestBody:
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getconfiguration'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/setconfiguration:
    post:
      tags:
      - Access Management APIs
      summary: Set configuration
      description: 'Updates the OAuth subsystem configuration


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_SetConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_setconfiguration'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_setconfiguration'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/createapplication:
    post:
      tags:
      - Access Management APIs
      summary: Create an application
      description: 'Creates a new OAuth application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_CreateApplication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createapplication'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createapplication'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/enumerateapplications:
    post:
      tags:
      - Access Management APIs
      summary: Enumerate all applications
      description: 'Enumerates all applications


        For paging, use the _Start_ and _Count_ parameters. _Start_ indicates the number of applications to skip, _Count_ indicates the number of applications to return.


        Optionally, use _OrderBy_ and _Descending_ to determine how the applications are ordered.


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_EnumerateApplications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumerateapplications'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumerateapplications'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getapplications:
    post:
      tags:
      - Access Management APIs
      summary: Search applications
      description: 'Searches for OAuth applications based on provided criteria


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetApplications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getapplications'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getapplications'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getapplication:
    post:
      tags:
      - Access Management APIs
      summary: Get an application
      description: 'Returns a specific OAuth application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetApplication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getapplication'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getapplication'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/updateapplication:
    post:
      tags:
      - Access Management APIs
      summary: Update an application
      description: 'Updates an OAuth application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_UpdateApplication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updateapplication'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updateapplication'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/deleteapplication:
    post:
      tags:
      - Access Management APIs
      summary: Delete an application
      description: 'Deletes an OAuth application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_DeleteApplication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleteapplication'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleteapplication'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getscopes:
    post:
      tags:
      - Access Management APIs
      summary: Get all scopes
      description: 'Returns all scopes that are defined by applications


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetScopes
      requestBody:
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getscopes'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getgrants:
    post:
      tags:
      - Access Management APIs
      summary: Get grants issued to an identity
      description: 'Returns all grants issued to an identity, optionally filtering by application.


        When enumerating application grants, use the _Start_ and _Count_ parameters. _Start_ indicates the number of grants to skip, _Count_ indicates the number of grants to return.


        Optionally, use _OrderBy_ and _Descending_ to determine in what order the grants are returned.


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetGrants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getgrants'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getgrants'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/enumerategrants:
    post:
      tags:
      - Access Management APIs
      summary: Enumerate all application grants
      description: 'Enumerate all grants giving access to the application specified with the _ApplicationId_ parameter.


        When enumerating application grants, use the _Start_ and _Count_ parameters. _Start_ indicates the number of grants to skip, _Count_ indicates the number of grants to return.


        Optionally, use _OrderBy_ and _Descending_ to determine in what order the grants are returned.


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateGrants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumerategrants'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumerategrants'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/revokegrants:
    post:
      tags:
      - Access Management APIs
      summary: Revoke grants
      description: 'Revokes all grants issued for an application or for an identity.


        To revoke grants for an application, specify the _ApplicationId_. To revoke grants for a user, specify the _GranteePrefixedUniversal_


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_RevokeGrants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_revokegrants'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_revokegrants'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/createrule:
    post:
      tags:
      - Access Management APIs
      summary: Create a rule
      description: 'Creates a new rule


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_CreateRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createrule'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createrule'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getrules:
    post:
      tags:
      - Access Management APIs
      summary: Search rules
      description: 'Finds rules that match all of the provided criteria


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getrules'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getrules'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/enumeraterules:
    post:
      tags:
      - Access Management APIs
      summary: Enumerate all rules
      description: 'Enumerates all rules


        For paging, use the _Start_ and _Count_ parameters. _Start_ indicates the number of rules to skip, _Count_ indicates the number of rules to return.


        Optionally, use _OrderBy_ and _Descending_ to determine how the rules are ordered.


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumeraterules'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumeraterules'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/updaterule:
    post:
      tags:
      - Access Management APIs
      summary: Update a rule
      description: 'Updates an existing rule


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_UpdateRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updaterule'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updaterule'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/deleterule:
    post:
      tags:
      - Access Management APIs
      summary: Delete a rule
      description: 'Delete a rule


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_DeleteRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleterule'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleterule'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/deleterules:
    post:
      tags:
      - Access Management APIs
      summary: Deletes rules
      description: 'Delete all rules for:


        *

        An application. Specify

        _ApplicationId_*

        An identity. Specify

        _TrusteePrefixedUniversal_*

        An application and identity pair. Specify both

        _ApplicationId_* and

        _TrusteePrefixedUniversal_


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_DeleteRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleterules'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleterules'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/grantcount:
    post:
      tags:
      - Access Management APIs
      summary: Get grant count
      description: 'Return the number of grants issued for an application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GrantCount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_grantcount'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_grantcount'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/usercount:
    post:
      tags:
      - Access Management APIs
      summary: Get user count
      description: 'Return the number of users holding grants issued for an application


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_UserCount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_usercount'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_usercount'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/createjwtmapping:
    post:
      tags:
      - Access Management APIs
      summary: Create JWT mapping
      description: 'Creates a new OAuth JWT mapping


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_CreateJwtMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createjwtmapping'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createjwtmapping'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/enumeratejwtmappings:
    post:
      tags:
      - Access Management APIs
      summary: Enumerate JWT mappings
      description: 'Enumerates all JWT mappings


        For paging, use the _Start_ and _Count_ parameters. _Start_ indicates the number of mappings to skip, _Count_ indicates the number of mappings to return.


        Optionally, use _OrderBy_ and _Descending_ to determine how the mappings are ordered.


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_EnumerateJwtMappings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumeratejwtmappings'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumeratejwtmappings'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getjwtmappings:
    post:
      tags:
      - Access Management APIs
      summary: Search JWT mappings
      description: 'Searches for JWT mappings matching provided criteria


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetJwtMappings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getjwtmappings'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getjwtmappings'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/getjwtmapping:
    post:
      tags:
      - Access Management APIs
      summary: Get JWT mapping
      description: 'Returns a specific JWT mapping


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_GetJwtMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getjwtmapping'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getjwtmapping'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/updatejwtmapping:
    post:
      tags:
      - Access Management APIs
      summary: Update JWT mapping
      description: 'Updates an existing JWT mapping


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_UpdateJwtMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updatejwtmapping'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updatejwtmapping'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/oauth/deletejwtmapping:
    post:
      tags:
      - Access Management APIs
      summary: Delete JWT mapping
      description: 'Deletes a JWT mapping


        _Required scope: admin_'
      operationId: Venafi_Core_WebSDK_OAuthRest_DeleteJwtMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deletejwtmapping'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deletejwtmapping'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/rights/grantsystemrole:
    post:
      tags:
      - Access Management APIs
      summary: Grant a system role to a user or group
      description: 'Grants one of the following system roles [to a user or group]:

        "Owner|Master","Auditor","AccessAdmin","RecycleBinAdmin","SchemaAdmin"


        Note: Owner|Master refers to the Master Admin role.


        The caller must have the Security scope with Manage restriction.


        _Required scope: security_'
      operationId: Venafi_Core_WebSDK_RightsRest_GrantSystemRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_RightsWebRequest_grantsystemrole'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_RightsWebResponse_grantsystemrole'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
  /vedsdk/rights/revokesystemrole:
    post:
      tags:
      - Access Management APIs
      summary: Revoke a system role from a user or group
      description: 'Revokes one of the following system roles [from a user or group] :

        "Owner|Master","Auditor","AccessAdmin","RecycleBinAdmin","SchemaAdmin"


        Note: Owner|Master refers to the Master Admin role.


        The caller must have the Security scope with Manage restriction.

        Note: You cannot revoke Master Admin rights from your own account.


        _Required scope: security_'
      operationId: Venafi_Core_WebSDK_RightsRest_RevokeSystemRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Core_WebSDK_RightsWebRequest_revokesystemrole'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Core_WebSDK_RightsWebResponse_revokesystemrole'
        '403':
          description: ' The API requires a scope not granted to the provided access token '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '400':
          description: ' Missing or invalid request property. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
        '401':
          description: ' A valid access token is required. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError'
      security:
      - AccessToken: []
components:
  schemas:
    Core_WebSDK_OAuthWebResponse_usercount:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Count:
          type: integer
          description: Gets or sets the requested count
          format: int32
    Core_WebSDK_OAuthWebRequest_revokerole:
      type: object
      properties:
        GranteePrefixedUniversal:
          type: string
          description: Grantee Prefixed Universal Identity
        Role:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole'
    Core_WebSDK_OAuthWebRequest_grantcount:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebRequest_getjwtmappings:
      type: object
      properties:
        Filter:
          type: string
          description: Gets or sets a generic filter string
        IssuerUris:
          type: array
          items:
            type: string
          description: Gets or sets a list of Issuer URIs
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Core_WebSDK_OAuthWebRequest_setconfiguration:
      type: object
      properties:
        Configuration:
          type: object
          properties:
            SessionPoolSize:
              type: integer
              description: Gets or sets the WebSDK Session Pool (Cache) size, in number of entries
              format: int32
            SessionPoolAge:
              type: integer
              description: Gets or sets the maximum time an entry can be kept in the sesion pool, in seconds
              format: int32
            SessionPoolExpirationInterval:
              type: integer
              description: Gets or sets how often the session expiration process runs
              format: int32
            SessionRightsRefreshInterval:
              type: integer
              description: Gets or sets the maximum number of seconds since the last request after which the stored rights of a session are refreshed from the database
              format: int32
            StrictExpiration:
              type: boolean
              description: Gets or sets the session cache expiration strategy
            StatisticsApiTracking:
              type: boolean
              description: Gets or sets the if API usage is tracked via statistics
            StatisticsTrackingIncludesTime:
              type: boolean
              description: Gets or sets the if API usage statistics track API execution times
            OpenApiEnabled:
              type: boolean
              description: Gets or sets the OpenAPI documentation is accessible
            OpenApiUi:
              type: string
              description: Gets or sets the UI to use for OpenAPI documentation
            DefaultAccessTokenValidity:
              type: integer
              description: Gets or sets the number of seconds an access token is valid if not overriden by application or rule
              format: int32
            DefaultGrantValidity:
              type: integer
              description: Gets or sets the number of seconds a grant is valid if not overriden by application or rule
              format: int32
            DefaultGrantRefreshable:
              type: boolean
              description: Gets or sets whether or not a grant can be refreshed, if not override by application or rule
            UnusedAccessTokenExpiration:
              type: integer
              description: Gets or sets the number of seconds an access token must be expired to consider the grant expired, even if the actual grant expiration is further out
              format: int32
            RefreshEndpointEnabled:
              type: boolean
              description: Gets or sets whether the token refresh endpoint is enabled
            AuthorizeByPassword:
              type: boolean
              description: Gets or sets whether the authentication server accepts username/password as authentication credentials
            AuthorizeByCertificate:
              type: boolean
              description: Gets or sets whether the authentication server accepts certificates as authentication credentials
            AuthorizeByIntegrated:
              type: boolean
              description: Gets or sets whether the authentication server accepts integrated (Windows) authentication
            AuthorizeByJwt:
              type: boolean
              description: Gets or sets whether the authentication server accepts JWT authentication
            AuthorizeDevice:
              type: boolean
              description: Gets or sets whether the authentication server accepts device authentication requests
            DeviceConfiguration:
              type: object
              properties:
                VerificationUri:
                  type: string
                  description: Gets or sets the Uri to verify (confirm) a device authorization request
                VerificationUriCompleteFormat:
                  type: string
                  description: Gets or sets the Uri to verify (confirm) a device authorization request, with a {0} placeholder for string.format use to hold the unique request id
              description: Gets or sets device authorization specific settings
            CertificateConfiguration:
              type: object
              properties:
                AttemptSIDExtensionBeforeSourceField:
                  type: boolean
                  description: Gets or sets whether we should first check and use SID extension from certificate prior to fallback to other source field
                SourceField:
                  type: string
                  description: Gets or sets the certificate field to use to determine identity
                AuthorizedIssuerDns:
                  type: array
                  items:
                    type: string
                  description: Gets or sets the vault IDs of the certificates trusted as issuers of certificates used to authenticate
              description: Gets or sets device authorization specific settings
            JwtConfiguration:
              type: object
              properties:
                ClockSkew:
                  type: integer
                  description: Gets or sets how much time drift is allowed for checking iat and nbf fields
                  format: int32
                CacheConfiguration:
                  type: object
                  properties:
                    DegreeOfParallelism:
                      type: integer
                      description: Maximum number of threads that can fetch keys concurrently
                      format: int32
                    RefreshDelay:
                      type: integer
                      description: Refresh mappings / keys delay in seconds; throttles refresh attempts
                      format: int32
                    MinTtl:
                      type: integer
                      description: Keys minimum TTL (seconds) in the cache; after they fetched, they will live in the cache at least this amount of time
                      format: int32
                    MaxTtl:
                      type: integer
                      description: Keys maximum TTL (seconds) in the cache; even if the keys are valid, after this amount of time they will be refreshed
                      format: int32
                    Timeout:
                      type: integer
                      description: HTTP request timeout (for accessing JWKS URI, OIDC discovery endpoint, etc).
                      format: int32
                    NoHttps:
                      type: boolean
                      description: If true, AuthServer allows HTTP for OIDC / JWKS endpoints. Use this option ONLY for testing purposes.
                    NoOidcIssuerCheck:
                      type: boolean
                      description: If true, AuthServer skips issuer check for OpenID provider metadata. Use this option ONLY for testing purposes.
                    AutoRefresh:
                      type: integer
                      description: Automatic configuration refresh interval (in seconds). AuthServer re-queries mappings from the DB and downloads keys again for each issuer.
                      format: int32
                  description: JWT cache configuration
              description: Gets or sets JWT authorization specific settings
          description: Gets or sets OAuth configuration
    Core_WebSDK_OAuthWebRequest_usercount:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebResponse_createapplication:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Application:
          type: object
          properties:
            Name:
              type: string
              description: Gets or sets the name of the application
            Description:
              type: string
              description: Gets or sets the description of the application
            Vendor:
              type: string
              description: Gets or sets the vendor that created the application
            Url:
              type: string
              description: Gets or sets the URL to get more information about the application
            Scope:
              type: string
              description: Gets or sets the scope the application requires
            MaximumScope:
              type: string
              description: Gets or sets the maximum scope the application knows to use
            AccessValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets the amount of time grant rules using this application should have their access token valid for
              format: int64
            GrantValidity:
              type:
              - integer
              - 'null'
              description: '**null** means the grant never expires'
              format: int64
            Renewable:
              type:
              - boolean
              - 'null'
              description: Gets or sets if grant rules created under this application should be marked for renewal
            GrantCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of grants issued for the application
              format: int32
            UserCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of users having grants issued for the application
              format: int32
            UnusedExpiration:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired
              format: int64
            ID:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets an _OAuthApplication_
    Core_WebSDK_OAuthWebRequest_getgrants:
      type: object
      properties:
        GranteePrefixedUniversal:
          type: string
          description: Grantee Prefixed Universal Identity
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        Start:
          type: integer
          description: Gets or sets the start index for paged APIs
          format: int32
        Count:
          type: integer
          description: Gets or sets the maximum number of results to return for paged APIs
          format: int32
        OrderBy:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField'
        Descending:
          type: boolean
          description: Gets or sets ordering direction for query APIs
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Web_SDK_Authentication_OAuthRole:
      title: Roles associated with OAuth APIs
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: "\n\n**0**: **User**  \nUser can see only his/her own items (ie, anything related to grants issued to a specific verified identity)\n\n**1**: **Auditor**  \nUser can see everything but change nothing\n\n**2**: **Maintainer**  \nUser may:\n- Modify application settings for specific applications\nUse _PermittedApplications_ for to get the list of applications for which the user is a _Maintainer_\n\n**3**: **Owner**  \nUser may:\n- Modify application settings for specific applications\n- Modify/delete rules related to specific applications\n- Delete specific applications\n- Can grant/revoke application maintainer for specific applications (delegate Maintainer to new users)\n- Can grant/revoke application admin for specific applications (delegate Owner to new users)\n- Revoke grants issued by application rules\nUse _PermittedApplications_ for to get the list of applications for which the user is an _Owner_\n\n**4**: **MixedOwnerMaintainer**  \nUser is _Maintainer_ for some applications, and _Owner_ for others. To determine\npermissions for specific applications, use the OAuthRights.HasXxxRights(application_id) methods and provide the application ID\nUse _PermittedApplications_ for to get the list of applications for which the user is either an _Owner_ or _Maintainer_\n\n**5**: **GrantAdmin**  \nUser may:\n- Read all applications\n- Read all rules\n- Read/revoke all grants\n\n**6**: **Admin**  \nUser may:\n- Create/modify/delete of all applications\n- Create/modify/delete of rules\n- Create/delete of grants\n- Can grant/revoke application maintainer and admin role (delegate Owner/Maintainer to new users)\n- Can configure global settings (session parameters, auth parameters, etc)\n"
      format: int32
    Web_SDK_Authentication_OAuthResult:
      title: Enumeration providing result codes for OAuth API
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      type: integer
      description: "\n\n**0**: **Success**  \nThe request completed successfully\n\n**1**: **Failure**  \nThe request could not be completed successfully\n\n**2**: **ApplicationNotFound**  \nThe requested application could not be found\n\n**3**: **GrantNotFound**  \nThe requested grant could not be found\n\n**4**: **RuleNotFound**  \nThe requested rule could not be found\n\n**5**: **DriverError**  \nA driver error was encountered while processing the request\n\n**6**: **InvalidParameters**  \nInvalid parameters were provided\n\n**7**: **TokenHashError**  \nA token hash error was encountered while processing the request\n\n**8**: **ExceptionThrown**  \nAn exception was thrown while processing the request\n\n**9**: **InsufficientPrivileges**  \nThe caller has insufficient permissions to perform an operation\n\n**10**: **ObjectInvalid**  \nThe object is not properly configured to process the request\n\n**11**: **AccessTokenExpired**  \nThe access token used has expired\n\n**12**: **AuthenticationMissing**  \nMissing authentication information\n\n**13**: **AuthenticationInvalid**  \nAuthentication information is not in a valid format\n\n**14**: **UnsignedCodeForbidden**  \nOperation forbidden for unsigned code\n\n**15**: **RemoteTransportFailure**  \nA request could not be submitted to the remote system due to a transport/network failure\n\n**16**: **RightsAssignmentError**  \nA rights assignment request failed\n\n**17**: **InvalidScope**  \nA requested scope was invalid\n\n**18**: **RemoteIdentityRequired**  \nA valid identity object was not supplied\n\n**19**: **ApplicationAlreadyExists**  \nThe application already exists\n\n**20**: **RuleAlreadyExists**  \nThe rule already exists\n\n**21**: **JwtMappingNotFound**  \nThe JWT mapping could not be found\n\n**22**: **JwtMappingAlreadyExists**  \nA JWT mapping with the same name already exists\n\n**23**: **ScopeMismatch**  \nA provided scope doesn't meet given constraints\n"
      format: int32
    Core_WebSDK_OAuthWebRequest_createjwtmapping:
      type: object
      properties:
        Name:
          type: string
          description: Gets or sets the name of an application
        IssuerUri:
          type: string
          description: Gets or sets the Issuer URI
        PurposeField:
          type: string
          description: Gets or sets the name of the JWT field indicating the purpose
        PurposeMatch:
          type: string
          description: Gets or sets the value that the _PurposeField_ must have to accept the token
        IdField:
          type: string
          description: Gets or sets the name of the JWT field indicating the identity owning the token
        IdMatch:
          type: string
          description: "Gets or sets the regular expression to apply against the _IdField_ to obtain the identity. \nIf _GranteePrefixedUniversal_ is null, the first matching group of the expression will be used to obtain an identity"
        GranteePrefixedUniversal:
          type: string
          description: Grantee Prefixed Universal Identity
        JwksUri:
          type: string
          description: Optional alternate JWKS endpoint when key discovery location differs from IssuerUri.
    Core_WebSDK_OAuthWebResponse_deletejwtmapping:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_enumeraterules:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Rules:
          type: array
          items:
            type: object
            properties:
              Description:
                type: string
                description: Gets or sets the application the description of the rule
              MaximumScope:
                type: string
                description: Gets or sets the maximum scope this rule will grant
              AccessValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets the time an access token issued under this rule is valid
                format: int64
              GrantValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed
                format: int64
              Renewable:
                type:
                - boolean
                - 'null'
                description: Gets or sets if a grant issued under this rule is renewable
              TrusteePrefixedUniversal:
                type: string
                description: Gets or sets the identity (user/group) this rule applies to
              ApplicationId:
                type: string
                description: Gets or sets the application that can request access under this rule
            description: Data class holding properties describing a rule used to obtain an OAuth grant automatically
          description: Gets or sets a list of _OAuthRule_ objects
    Core_WebSDK_OAuthWebRequest_deleterules:
      type: object
      properties:
        TrusteePrefixedUniversal:
          type: string
          description: Gets or sets the prefixed universal for the trustee
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebRequest_deleterule:
      type: object
      properties:
        TrusteePrefixedUniversal:
          type: string
          description: Gets or sets the prefixed universal for the trustee
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebResponse_getapplications:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Applications:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                description: Gets or sets the name of the application
              Description:
                type: string
                description: Gets or sets the description of the application
              Vendor:
                type: string
                description: Gets or sets the vendor that created the application
              Url:
                type: string
                description: Gets or sets the URL to get more information about the application
              Scope:
                type: string
                description: Gets or sets the scope the application requires
              MaximumScope:
                type: string
                description: Gets or sets the maximum scope the application knows to use
              AccessValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets the amount of time grant rules using this application should have their access token valid for
                format: int64
              GrantValidity:
                type:
                - integer
                - 'null'
                description: '**null** means the grant never expires'
                format: int64
              Renewable:
                type:
                - boolean
                - 'null'
                description: Gets or sets if grant rules created under this application should be marked for renewal
              GrantCount:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of grants issued for the application
                format: int32
              UserCount:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of users having grants issued for the application
                format: int32
              UnusedExpiration:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired
                format: int64
              ID:
                type: string
                description: Gets or sets the identifier of the application
            description: Holds information about a particular OAuth application
          description: Gets or sets a collection of _OAuthApplication_
    Core_WebSDK_OAuthWebRequest_getapplications:
      type: object
      properties:
        Filter:
          type: string
          description: Gets or sets a generic filter string
        ApplicationIds:
          type: array
          items:
            type: string
          description: Gets or sets a list of the application identifiers
    Core_WebSDK_OAuthWebResponse_getscopes:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Scopes:
          type: array
          items:
            type: object
            properties:
              Scope:
                type: string
                description: Gets/sets the scope value
              RestrictionList:
                type: array
                items:
                  type: string
                description: Gets/sets restrictions to the scope
            description: Data class to hold a single scope and its restrictions
          description: Gets or sets a list of scopes
    Core_WebSDK_OAuthWebRequest_getjwtmapping:
      type: object
      properties:
        Name:
          type: string
          description: Gets or sets the name of an application
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Web_SDK_Authentication_OAuthOrderByField:
      title: Enumeration providing ordering options for OAuth results
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: "\n\n**0**: **Default**  \nNo order specified\n\n**1**: **Name**  \nOrder results by name\n\n**2**: **Vendor**  \nOrder results by vendor\n\n**3**: **AccessValidity**  \nOrder results by access validity\n\n**4**: **GrantValidity**  \nOrder results by grant validity\n"
      format: int32
    Core_WebSDK_OAuthWebRequest_createapplication:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        Scope:
          type: string
          description: Gets or sets the scope for an application
        MaximumScope:
          type: string
          description: Gets or sets the maximum scope for an application
        Name:
          type: string
          description: Gets or sets the name of an application
        Vendor:
          type: string
          description: Gets or sets the vendor of an application
        Description:
          type: string
          description: Gets or sets the description for an application or rule
        Url:
          type: string
          description: Gets or sets a url to learn more about the application
        AccessValidity:
          type:
          - integer
          - 'null'
          description: Gets or sets the duration (in seconds) access tokens should be available for
          format: int64
        GrantValidity:
          type:
          - integer
          - 'null'
          description: Gets or sets the duration (in seconds) grants should be available for
          format: int64
        Renewable:
          type:
          - boolean
          - 'null'
          description: Gets or sets whether grants for an application should be renewable
    Core_WebSDK_OAuthWebRequest_enumerategrants:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        Start:
          type: integer
          description: Gets or sets the start index for paged APIs
          format: int32
        Count:
          type: integer
          description: Gets or sets the maximum number of results to return for paged APIs
          format: int32
        OrderBy:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField'
        Descending:
          type: boolean
          description: Gets or sets ordering direction for query APIs
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Core_WebSDK_OAuthWebResponse_deleteapplication:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_getgrants:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Grants:
          type: array
          items:
            type: object
            properties:
              Scope:
                type: string
                description: Gets or sets the scope (WebSDK, CSP, etc) this grant applies to
              AccessToken:
                type: string
                description: Gets or sets the token to use to get the rights of this grant
              ValidFor:
                type: integer
                description: Gets or sets the number of seconds the access token is valid
                format: int64
              AccessIssuedOn:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last
              AccessIssuedOnUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              AccessIssuedOnISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              RefreshToken:
                type: string
                description: Gets or sets the token to use to get an updated access token
              Expires:
                type:
                - string
                - 'null'
                description: Gets or sets the date and time (UTC) when the grant expires and cannot be refreshed, **null** if it does not expire
              ExpiresUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              ExpiresISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              GrantIssuedOn:
                type: string
                description: Gets or sets the date and time (UTC) when the grant was issued
              GrantIssuedOnUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              GrantIssuedOnISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              Application:
                type: string
                description: Gets or sets the application this grant applies to
              GranteePrefixedUniversal:
                type: string
                description: Gets or sets the prefixed universal of the identity that was used to obtain the grant and/or grants
              GrantedToPrefixedUniversal:
                type: string
                description: Gets or sets the identity that the permission to obtain a grant was issued to.  if the permission was assigned to the user directly)
            description: Holds information about a particular access grant
          description: Gets or sets a list of _OAuthGrant_ items
    Core_WebSDK_OAuthWebRequest_grantrole:
      type: object
      properties:
        GranteePrefixedUniversal:
          type: string
          description: Grantee Prefixed Universal Identity
        Role:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole'
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebRequest_deletejwtmapping:
      type: object
      properties:
        Name:
          type: string
          description: Gets or sets the name of an application
    Core_WebSDK_OAuthWebResponse_createrule:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Rule:
          type: object
          properties:
            Description:
              type: string
              description: Gets or sets the application the description of the rule
            MaximumScope:
              type: string
              description: Gets or sets the maximum scope this rule will grant
            AccessValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets the time an access token issued under this rule is valid
              format: int64
            GrantValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed
              format: int64
            Renewable:
              type:
              - boolean
              - 'null'
              description: Gets or sets if a grant issued under this rule is renewable
            TrusteePrefixedUniversal:
              type: string
              description: Gets or sets the identity (user/group) this rule applies to
            ApplicationId:
              type: string
              description: Gets or sets the application that can request access under this rule
          description: Gets or sets the _OAuthRule_
    Core_WebSDK_RightsWebRequest_revokesystemrole:
      type: object
      properties:
        UniversalID:
          type: string
          description: The universal ID.
        Role:
          type: string
          description: The Role
    Core_WebSDK_OAuthWebRequest_enumeratejwtmappings:
      type: object
      properties:
        Start:
          type: integer
          description: Gets or sets the start index for paged APIs
          format: int32
        Count:
          type: integer
          description: Gets or sets the maximum number of results to return for paged APIs
          format: int32
        OrderBy:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField'
        Descending:
          type: boolean
          description: Gets or sets ordering direction for query APIs
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Core_WebSDK_OAuthWebRequest_deleteapplication:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_RightsWebResponse_grantsystemrole:
      type: object
      properties:
        Success:
          type: boolean
          description: The subsystem.
    Core_WebSDK_OAuthWebResponse_grantcount:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Count:
          type: integer
          description: Gets or sets the requested count
          format: int32
    Core_WebSDK_OAuthWebResponse_listroles:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Roles:
          type: array
          items:
            type: object
            properties:
              Role:
                $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole'
              Grantee:
                type: string
                description: The identity this role applies to
              ApplicationId:
                type: string
                description: The application this role applies to (or **null** if the role isn't application-specific)
            description: Data class representing rights for a particular role
          description: Gets or sets a list roles
    Core_WebSDK_OAuthWebResponse_createjwtmapping:
      type: object
      properties:
        JwtMapping:
          type: object
          properties:
            IssuerUri:
              type: string
              description: The Issuer URI for the mapping
            JwksUri:
              type: string
              description: 'Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.

                When supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.

                Nullable and not required for legacy mappings.'
            PurposeField:
              type: string
              description: The JWT field to determine the purpose
            PurposeMatch:
              type: string
              description: The value that must match the purpose field to accept the JWT
            IdField:
              type: string
              description: The JWT field to determine the identity
            IdMatch:
              type: string
              description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used
            GranteePrefixedUniversal:
              type: string
              description: The fixed prefixed universal identity to use as grant identity
            Name:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets the _OAuthJwtMapping_
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_revokegrants:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_enumerategrants:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Grants:
          type: array
          items:
            type: object
            properties:
              Scope:
                type: string
                description: Gets or sets the scope (WebSDK, CSP, etc) this grant applies to
              AccessToken:
                type: string
                description: Gets or sets the token to use to get the rights of this grant
              ValidFor:
                type: integer
                description: Gets or sets the number of seconds the access token is valid
                format: int64
              AccessIssuedOn:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last
              AccessIssuedOnUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              AccessIssuedOnISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              RefreshToken:
                type: string
                description: Gets or sets the token to use to get an updated access token
              Expires:
                type:
                - string
                - 'null'
                description: Gets or sets the date and time (UTC) when the grant expires and cannot be refreshed, **null** if it does not expire
              ExpiresUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              ExpiresISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              GrantIssuedOn:
                type: string
                description: Gets or sets the date and time (UTC) when the grant was issued
              GrantIssuedOnUnixTime:
                type: integer
                description: Gets or sets the Unixtime when the access token was issued last
                format: int64
              GrantIssuedOnISO8601:
                type: string
                description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format
              Application:
                type: string
                description: Gets or sets the application this grant applies to
              GranteePrefixedUniversal:
                type: string
                description: Gets or sets the prefixed universal of the identity that was used to obtain the grant and/or grants
              GrantedToPrefixedUniversal:
                type: string
                description: Gets or sets the identity that the permission to obtain a grant was issued to.  if the permission was assigned to the user directly)
            description: Holds information about a particular access grant
          description: Gets or sets a list of _OAuthGrant_ items
    Core_WebSDK_OAuthWebResponse_enumerateapplications:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Application:
          type: object
          properties:
            Name:
              type: string
              description: Gets or sets the name of the application
            Description:
              type: string
              description: Gets or sets the description of the application
            Vendor:
              type: string
              description: Gets or sets the vendor that created the application
            Url:
              type: string
              description: Gets or sets the URL to get more information about the application
            Scope:
              type: string
              description: Gets or sets the scope the application requires
            MaximumScope:
              type: string
              description: Gets or sets the maximum scope the application knows to use
            AccessValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets the amount of time grant rules using this application should have their access token valid for
              format: int64
            GrantValidity:
              type:
              - integer
              - 'null'
              description: '**null** means the grant never expires'
              format: int64
            Renewable:
              type:
              - boolean
              - 'null'
              description: Gets or sets if grant rules created under this application should be marked for renewal
            GrantCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of grants issued for the application
              format: int32
            UserCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of users having grants issued for the application
              format: int32
            UnusedExpiration:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired
              format: int64
            ID:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets an _OAuthApplication_
    Core_WebSDK_OAuthWebRequest_updateapplication:
      type: object
      properties:
        Application:
          type: object
          properties:
            Name:
              type: string
              description: Gets or sets the name of the application
            Description:
              type: string
              description: Gets or sets the description of the application
            Vendor:
              type: string
              description: Gets or sets the vendor that created the application
            Url:
              type: string
              description: Gets or sets the URL to get more information about the application
            Scope:
              type: string
              description: Gets or sets the scope the application requires
            MaximumScope:
              type: string
              description: Gets or sets the maximum scope the application knows to use
            AccessValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets the amount of time grant rules using this application should have their access token valid for
              format: int64
            GrantValidity:
              type:
              - integer
              - 'null'
              description: '**null** means the grant never expires'
              format: int64
            Renewable:
              type:
              - boolean
              - 'null'
              description: Gets or sets if grant rules created under this application should be marked for renewal
            GrantCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of grants issued for the application
              format: int32
            UserCount:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of users having grants issued for the application
              format: int32
            UnusedExpiration:
              type:
              - integer
              - 'null'
              description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired
              format: int64
            ID:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets the _OAuthApplication_ to update
    Core_WebSDK_OAuthWebRequest_updatejwtmapping:
      type: object
      properties:
        JwtMapping:
          type: object
          properties:
            IssuerUri:
              type: string
              description: The Issuer URI for the mapping
            JwksUri:
              type: string
              description: 'Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.

                When supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.

                Nullable and not required for legacy mappings.'
            PurposeField:
              type: string
              description: The JWT field to determine the purpose
            PurposeMatch:
              type: string
              description: The value that must match the purpose field to accept the JWT
            IdField:
              type: string
              description: The JWT field to determine the identity
            IdMatch:
              type: string
              description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used
            GranteePrefixedUniversal:
              type: string
              description: The fixed prefixed universal identity to use as grant identity
            Name:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets the _OAuthJwtMapping_
    Core_WebSDK_OAuthWebRequest_enumeraterules:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        Start:
          type: integer
          description: Gets or sets the start index for paged APIs
          format: int32
        Count:
          type: integer
          description: Gets or sets the maximum number of results to return for paged APIs
          format: int32
        OrderBy:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField'
        Descending:
          type: boolean
          description: Gets or sets ordering direction for query APIs
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Core_WebSDK_OAuthWebResponse_getapplication:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Applications:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                description: Gets or sets the name of the application
              Description:
                type: string
                description: Gets or sets the description of the application
              Vendor:
                type: string
                description: Gets or sets the vendor that created the application
              Url:
                type: string
                description: Gets or sets the URL to get more information about the application
              Scope:
                type: string
                description: Gets or sets the scope the application requires
              MaximumScope:
                type: string
                description: Gets or sets the maximum scope the application knows to use
              AccessValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets the amount of time grant rules using this application should have their access token valid for
                format: int64
              GrantValidity:
                type:
                - integer
                - 'null'
                description: '**null** means the grant never expires'
                format: int64
              Renewable:
                type:
                - boolean
                - 'null'
                description: Gets or sets if grant rules created under this application should be marked for renewal
              GrantCount:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of grants issued for the application
                format: int32
              UserCount:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of users having grants issued for the application
                format: int32
              UnusedExpiration:
                type:
                - integer
                - 'null'
                description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired
                format: int64
              ID:
                type: string
                description: Gets or sets the identifier of the application
            description: Holds information about a particular OAuth application
          description: Gets or sets a collection of _OAuthApplication_
    Web_SDK_Authentication_OAuthError:
      type: object
      properties:
        error:
          type: string
          description: Gets or sets the short error name
        error_description:
          type: string
          description: Gets or sets the description of the error
      description: REST OAuth Error Response
    Core_WebSDK_OAuthWebRequest_getrules:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        TrusteePrefixedUniversal:
          type: string
          description: Gets or sets the prefixed universal for the trustee
        TrusteePrefixedUniversals:
          type: array
          items:
            type: string
          description: Gets or sets a list of trustee universals to search on
        MaximumScope:
          type: string
          description: Gets or sets the maximum scope for an application
        Renewable:
          type:
          - boolean
          - 'null'
          description: Gets or sets whether grants for an application should be renewable
        NoExpire:
          type:
          - boolean
          - 'null'
          description: Gets or sets filtering rules that have no expiration. **true** to find rules that don't expire.
        ResolveIdentities:
          type: boolean
          description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field
    Core_WebSDK_OAuthWebResponse_getconfiguration:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Configuration:
          type: object
          properties:
            SessionPoolSize:
              type: integer
              description: Gets or sets the WebSDK Session Pool (Cache) size, in number of entries
              format: int32
            SessionPoolAge:
              type: integer
              description: Gets or sets the maximum time an entry can be kept in the sesion pool, in seconds
              format: int32
            SessionPoolExpirationInterval:
              type: integer
              description: Gets or sets how often the session expiration process runs
              format: int32
            SessionRightsRefreshInterval:
              type: integer
              description: Gets or sets the maximum number of seconds since the last request after which the stored rights of a session are refreshed from the database
              format: int32
            StrictExpiration:
              type: boolean
              description: Gets or sets the session cache expiration strategy
            StatisticsApiTracking:
              type: boolean
              description: Gets or sets the if API usage is tracked via statistics
            StatisticsTrackingIncludesTime:
              type: boolean
              description: Gets or sets the if API usage statistics track API execution times
            OpenApiEnabled:
              type: boolean
              description: Gets or sets the OpenAPI documentation is accessible
            OpenApiUi:
              type: string
              description: Gets or sets the UI to use for OpenAPI documentation
            DefaultAccessTokenValidity:
              type: integer
              description: Gets or sets the number of seconds an access token is valid if not overriden by application or rule
              format: int32
            DefaultGrantValidity:
              type: integer
              description: Gets or sets the number of seconds a grant is valid if not overriden by application or rule
              format: int32
            DefaultGrantRefreshable:
              type: boolean
              description: Gets or sets whether or not a grant can be refreshed, if not override by application or rule
            UnusedAccessTokenExpiration:
              type: integer
              description: Gets or sets the number of seconds an access token must be expired to consider the grant expired, even if the actual grant expiration is further out
              format: int32
            RefreshEndpointEnabled:
              type: boolean
              description: Gets or sets whether the token refresh endpoint is enabled
            AuthorizeByPassword:
              type: boolean
              description: Gets or sets whether the authentication server accepts username/password as authentication credentials
            AuthorizeByCertificate:
              type: boolean
              description: Gets or sets whether the authentication server accepts certificates as authentication credentials
            AuthorizeByIntegrated:
              type: boolean
              description: Gets or sets whether the authentication server accepts integrated (Windows) authentication
            AuthorizeByJwt:
              type: boolean
              description: Gets or sets whether the authentication server accepts JWT authentication
            AuthorizeDevice:
              type: boolean
              description: Gets or sets whether the authentication server accepts device authentication requests
            DeviceConfiguration:
              type: object
              properties:
                VerificationUri:
                  type: string
                  description: Gets or sets the Uri to verify (confirm) a device authorization request
                VerificationUriCompleteFormat:
                  type: string
                  description: Gets or sets the Uri to verify (confirm) a device authorization request, with a {0} placeholder for string.format use to hold the unique request id
              description: Gets or sets device authorization specific settings
            CertificateConfiguration:
              type: object
              properties:
                AttemptSIDExtensionBeforeSourceField:
                  type: boolean
                  description: Gets or sets whether we should first check and use SID extension from certificate prior to fallback to other source field
                SourceField:
                  type: string
                  description: Gets or sets the certificate field to use to determine identity
                AuthorizedIssuerDns:
                  type: array
                  items:
                    type: string
                  description: Gets or sets the vault IDs of the certificates trusted as issuers of certificates used to authenticate
              description: Gets or sets device authorization specific settings
            JwtConfiguration:
              type: object
              properties:
                ClockSkew:
                  type: integer
                  description: Gets or sets how much time drift is allowed for checking iat and nbf fields
                  format: int32
                CacheConfiguration:
                  type: object
                  properties:
                    DegreeOfParallelism:
                      type: integer
                      description: Maximum number of threads that can fetch keys concurrently
                      format: int32
                    RefreshDelay:
                      type: integer
                      description: Refresh mappings / keys delay in seconds; throttles refresh attempts
                      format: int32
                    MinTtl:
                      type: integer
                      description: Keys minimum TTL (seconds) in the cache; after they fetched, they will live in the cache at least this amount of time
                      format: int32
                    MaxTtl:
                      type: integer
                      description: Keys maximum TTL (seconds) in the cache; even if the keys are valid, after this amount of time they will be refreshed
                      format: int32
                    Timeout:
                      type: integer
                      description: HTTP request timeout (for accessing JWKS URI, OIDC discovery endpoint, etc).
                      format: int32
                    NoHttps:
                      type: boolean
                      description: If true, AuthServer allows HTTP for OIDC / JWKS endpoints. Use this option ONLY for testing purposes.
                    NoOidcIssuerCheck:
                      type: boolean
                      description: If true, AuthServer skips issuer check for OpenID provider metadata. Use this option ONLY for testing purposes.
                    AutoRefresh:
                      type: integer
                      description: Automatic configuration refresh interval (in seconds). AuthServer re-queries mappings from the DB and downloads keys again for each issuer.
                      format: int32
                  description: JWT cache configuration
              description: Gets or sets JWT authorization specific settings
          description: Gets or sets OAuth configuration
    Core_WebSDK_OAuthWebResponse_revokerole:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebRequest_createrule:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        TrusteePrefixedUniversal:
          type: string
          description: Gets or sets the prefixed universal for the trustee
        MaximumScope:
          type: string
          description: Gets or sets the maximum scope for an application
        Description:
          type: string
          description: Gets or sets the description for an application or rule
        AccessValidity:
          type:
          - integer
          - 'null'
          description: Gets or sets the duration (in seconds) access tokens should be available for
          format: int64
        GrantValidity:
          type:
          - integer
          - 'null'
          description: Gets or sets the duration (in seconds) grants should be available for
          format: int64
        Renewable:
          type:
          - boolean
          - 'null'
          description: Gets or sets whether grants for an application should be renewable
    Core_WebSDK_OAuthWebResponse_getjwtmapping:
      type: object
      properties:
        JwtMapping:
          type: object
          properties:
            IssuerUri:
              type: string
              description: The Issuer URI for the mapping
            JwksUri:
              type: string
              description: 'Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.

                When supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.

                Nullable and not required for legacy mappings.'
            PurposeField:
              type: string
              description: The JWT field to determine the purpose
            PurposeMatch:
              type: string
              description: The value that must match the purpose field to accept the JWT
            IdField:
              type: string
              description: The JWT field to determine the identity
            IdMatch:
              type: string
              description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used
            GranteePrefixedUniversal:
              type: string
              description: The fixed prefixed universal identity to use as grant identity
            Name:
              type: string
              description: Gets or sets the identifier of the application
          description: Gets or sets the _OAuthJwtMapping_
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_enumeratejwtmappings:
      type: object
      properties:
        JwtMappings:
          type: array
          items:
            type: object
            properties:
              IssuerUri:
                type: string
                description: The Issuer URI for the mapping
              JwksUri:
                type: string
                description: 'Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.

                  When supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.

                  Nullable and not required for legacy mappings.'
              PurposeField:
                type: string
                description: The JWT field to determine the purpose
              PurposeMatch:
                type: string
                description: The value that must match the purpose field to accept the JWT
              IdField:
                type: string
                description: The JWT field to determine the identity
              IdMatch:
                type: string
                description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used
              GranteePrefixedUniversal:
                type: string
                description: The fixed prefixed universal identity to use as grant identity
              Name:
                type: string
                description: Gets or sets the identifier of the application
            description: Holds information about a particular OAuth application
          description: Gets or sets a collection of _OAuthJwtMapping_
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_updateapplication:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebRequest_getapplication:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
    Core_WebSDK_OAuthWebRequest_updaterule:
      type: object
      properties:
        Rule:
          type: object
          properties:
            Description:
              type: string
              description: Gets or sets the application the description of the rule
            MaximumScope:
              type: string
              description: Gets or sets the maximum scope this rule will grant
            AccessValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets the time an access token issued under this rule is valid
              format: int64
            GrantValidity:
              type:
              - integer
              - 'null'
              description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed
              format: int64
            Renewable:
              type:
              - boolean
              - 'null'
              description: Gets or sets if a grant issued under this rule is renewable
            TrusteePrefixedUniversal:
              type: string
              description: Gets or sets the identity (user/group) this rule applies to
            ApplicationId:
              type: string
              description: Gets or sets the application that can request access under this rule
          description: Gets or sets the _OAuthRule_ to update
    Core_WebSDK_OAuthWebResponse_getrules:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Rules:
          type: array
          items:
            type: object
            properties:
              Description:
                type: string
                description: Gets or sets the application the description of the rule
              MaximumScope:
                type: string
                description: Gets or sets the maximum scope this rule will grant
              AccessValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets the time an access token issued under this rule is valid
                format: int64
              GrantValidity:
                type:
                - integer
                - 'null'
                description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed
                format: int64
              Renewable:
                type:
                - boolean
                - 'null'
                description: Gets or sets if a grant issued under this rule is renewable
              TrusteePrefixedUniversal:
                type: string
                description: Gets or sets the identity (user/group) this rule applies to
              ApplicationId:
                type: string
                description: Gets or sets the application that can request access under this rule
            description: Data class holding properties describing a rule used to obtain an OAuth grant automatically
          description: Gets or sets a list of _OAuthRule_ objects
    Core_WebSDK_RightsWebRequest_grantsystemrole:
      type: object
      properties:
        UniversalID:
          type: string
          description: The universal ID.
        Role:
          type: string
          description: The Role
    Core_WebSDK_OAuthWebResponse_deleterule:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebRequest_revokegrants:
      type: object
      properties:
        ApplicationId:
          type: string
          description: Gets or sets the application identifier
        GranteePrefixedUniversal:
          type: string
          description: Grantee Prefixed Universal Identity
    Core_WebSDK_OAuthWebResponse_getjwtmappings:
      type: object
      properties:
        JwtMappings:
          type: array
          items:
            type: object
            properties:
              IssuerUri:
                type: string
                description: The Issuer URI for the mapping
              JwksUri:
                type: string
                description: 'Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.

                  When supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.

                  Nullable and not required for legacy mappings.'
              PurposeField:
                type: string
                description: The JWT field to determine the purpose
              PurposeMatch:
                type: string
                description: The value that must match the purpose field to accept the JWT
              IdField:
                type: string
                description: The JWT field to determine the identity
              IdMatch:
                type: string
                description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used
              GranteePrefixedUniversal:
                type: string
                description: The fixed prefixed universal identity to use as grant identity
              Name:
                type: string
                description: Gets or sets the identifier of the application
            description: Holds information about a particular OAuth application
          description: Gets or sets a collection of _OAuthJwtMapping_
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_getrole:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
        Role:
          type: object
          properties:
            PermittedApplications:
              type: array
              items:
                type: string
              description: Gets the list of applications the user has rights to
            OwnedApplications:
              type: array
              items:
                type: object
                properties:
                  ApplicationId:
                    type: string
                    description: Application ID
                  Role:
                    $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole'
                description: Clean serialization for the wire
              description: Gets the list of applications the user owns
            Role:
              $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole'
          description: Gets or sets an OAuth role
    Core_WebSDK_OAuthWebResponse_updaterule:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_grantrole:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebRequest_enumerateapplications:
      type: object
      properties:
        Start:
          type: integer
          description: Gets or sets the start index for paged APIs
          format: int32
        Count:
          type: integer
          description: Gets or sets the maximum number of results to return for paged APIs
          format: int32
        OrderBy:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField'
        Descending:
          type: boolean
          description: Gets or sets ordering direction for query APIs
    Core_WebSDK_OAuthWebResponse_setconfiguration:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_RightsWebResponse_revokesystemrole:
      type: object
      properties:
        Success:
          type: boolean
          description: The subsystem.
    Core_WebSDK_OAuthWebResponse_updatejwtmapping:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
    Core_WebSDK_OAuthWebResponse_deleterules:
      type: object
      properties:
        Success:
          type: boolean
          description: 'All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response code. The

            Success variable in the response body will indicate if the **API** call itself was successful.'
        Result:
          $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult'
        Error:
          type: string
          description: Gets or sets the error
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer