Ory

Ory oAuth2 API

OAuth 2.0

OpenAPI Specification

ory-oauth2-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  contact:
    email: hi@ory.sh
  description: 'Documentation for all of Ory Hydra''s APIs.

    '
  license:
    name: Apache 2.0
  title: Ory Hydra api oAuth2 API
  version: ''
tags:
- description: OAuth 2.0
  name: oAuth2
paths:
  /admin/clients:
    get:
      description: 'This endpoint lists all clients in the database, and never returns client secrets.

        As a default it lists the first 100 clients.'
      operationId: listOAuth2Clients
      parameters:
      - description: 'Items per Page


          This is the number of items per page to return.

          For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).'
        in: query
        name: page_size
        schema:
          default: 250
          format: int64
          maximum: 1000
          minimum: 1
          type: integer
      - description: 'Next Page Token


          The next page token.

          For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).'
        in: query
        name: page_token
        schema:
          type: string
      - description: The name of the clients to filter by.
        in: query
        name: client_name
        schema:
          type: string
      - description: The owner of the clients to filter by.
        in: query
        name: owner
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/listOAuth2Clients'
        default:
          $ref: '#/components/responses/errorOAuth2Default'
      summary: List OAuth 2.0 Clients
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-medium
    post:
      description: 'Create a new OAuth 2.0 client. If you pass `client_secret` the secret is used, otherwise a random secret

        is generated. The secret is echoed in the response. It is not possible to retrieve it later on.'
      operationId: createOAuth2Client
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/oAuth2Client'
        description: OAuth 2.0 Client Request Body
        required: true
        x-originalParamName: Body
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2Client'
          description: oAuth2Client
        '400':
          $ref: '#/components/responses/errorOAuth2BadRequest'
        default:
          $ref: '#/components/responses/errorOAuth2Default'
      summary: Create OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
  /admin/clients/{id}:
    delete:
      description: 'Delete an existing OAuth 2.0 Client by its ID.


        OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are

        generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.


        Make sure that this endpoint is well protected and only callable by first-party components.'
      operationId: deleteOAuth2Client
      parameters:
      - description: The id of the OAuth 2.0 Client.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/emptyResponse'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: genericError
      summary: Delete OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
    get:
      description: 'Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret.


        OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are

        generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.'
      operationId: getOAuth2Client
      parameters:
      - description: The id of the OAuth 2.0 Client.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2Client'
          description: oAuth2Client
        default:
          $ref: '#/components/responses/errorOAuth2Default'
      summary: Get an OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
    patch:
      description: 'Patch an existing OAuth 2.0 Client using JSON Patch. If you pass `client_secret`

        the secret will be updated and returned via the API. This is the

        only time you will be able to retrieve the client secret, so write it down and keep it safe.


        OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are

        generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.'
      operationId: patchOAuth2Client
      parameters:
      - description: The id of the OAuth 2.0 Client.
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/jsonPatchDocument'
        description: OAuth 2.0 Client JSON Patch Body
        required: true
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2Client'
          description: oAuth2Client
        '404':
          $ref: '#/components/responses/errorOAuth2NotFound'
        default:
          $ref: '#/components/responses/errorOAuth2Default'
      summary: Patch OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
    put:
      description: 'Replaces an existing OAuth 2.0 Client with the payload you send. If you pass `client_secret` the secret is used,

        otherwise the existing secret is used.


        If set, the secret is echoed in the response. It is not possible to retrieve it later on.


        OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are

        generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.'
      operationId: setOAuth2Client
      parameters:
      - description: OAuth 2.0 Client ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/oAuth2Client'
        description: OAuth 2.0 Client Request Body
        required: true
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2Client'
          description: oAuth2Client
        '400':
          $ref: '#/components/responses/errorOAuth2BadRequest'
        '404':
          $ref: '#/components/responses/errorOAuth2NotFound'
        default:
          $ref: '#/components/responses/errorOAuth2Default'
      summary: Set OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
  /admin/clients/{id}/lifespans:
    put:
      description: Set lifespans of different token types issued for this OAuth 2.0 client. Does not modify other fields.
      operationId: setOAuth2ClientLifespans
      parameters:
      - description: OAuth 2.0 Client ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/oAuth2ClientTokenLifespans'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2Client'
          description: oAuth2Client
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: genericError
      summary: Set OAuth2 Client Token Lifespans
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
  /admin/oauth2/auth/requests/consent:
    get:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell Ory now about it. If the subject authenticated, he/she must now be asked if

        the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject''s behalf.


        The consent challenge is appended to the consent provider''s URL to which the subject''s user-agent (browser) is redirected to. The consent

        provider uses that challenge to fetch information on the OAuth2 request and then tells Ory if the subject accepted

        or rejected the request.


        The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please

        head over to the OAuth 2.0 documentation.'
      operationId: getOAuth2ConsentRequest
      parameters:
      - description: OAuth 2.0 Consent Request Challenge
        in: query
        name: consent_challenge
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2ConsentRequest'
          description: oAuth2ConsentRequest
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Get OAuth 2.0 Consent Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/consent/accept:
    put:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell Ory now about it. If the subject authenticated, he/she must now be asked if

        the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject''s behalf.


        The consent challenge is appended to the consent provider''s URL to which the subject''s user-agent (browser) is redirected to. The consent

        provider uses that challenge to fetch information on the OAuth2 request and then tells Ory if the subject accepted

        or rejected the request.


        This endpoint tells Ory that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf.

        The consent provider includes additional information, such as session data for access and ID tokens, and if the

        consent request should be used as basis for future requests.


        The response contains a redirect URL which the consent provider should redirect the user-agent to.


        The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please

        head over to the OAuth 2.0 documentation.'
      operationId: acceptOAuth2ConsentRequest
      parameters:
      - description: OAuth 2.0 Consent Request Challenge
        in: query
        name: consent_challenge
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/acceptOAuth2ConsentRequest'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Accept OAuth 2.0 Consent Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/consent/reject:
    put:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell Ory now about it. If the subject authenticated, he/she must now be asked if

        the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject''s behalf.


        The consent challenge is appended to the consent provider''s URL to which the subject''s user-agent (browser) is redirected to. The consent

        provider uses that challenge to fetch information on the OAuth2 request and then tells Ory if the subject accepted

        or rejected the request.


        This endpoint tells Ory that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf.

        The consent provider must include a reason why the consent was not granted.


        The response contains a redirect URL which the consent provider should redirect the user-agent to.


        The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please

        head over to the OAuth 2.0 documentation.'
      operationId: rejectOAuth2ConsentRequest
      parameters:
      - description: OAuth 2.0 Consent Request Challenge
        in: query
        name: consent_challenge
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rejectOAuth2Request'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Reject OAuth 2.0 Consent Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/device/accept:
    put:
      description: Accepts a device grant user_code request
      operationId: acceptUserCodeRequest
      parameters:
      - in: query
        name: device_challenge
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/acceptDeviceUserCodeRequest'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Accepts a device grant user_code request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/login:
    get:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell the Ory OAuth2 Service about it.


        Per default, the login provider is Ory itself. You may use a different login provider which needs to be a web-app

        you write and host, and it must be able to authenticate ("show the subject a login screen")

        a subject (in OAuth2 the proper name for subject is "resource owner").


        The authentication challenge is appended to the login provider URL to which the subject''s user-agent (browser) is redirected to. The login

        provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.'
      operationId: getOAuth2LoginRequest
      parameters:
      - description: OAuth 2.0 Login Request Challenge
        in: query
        name: login_challenge
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2LoginRequest'
          description: oAuth2LoginRequest
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Get OAuth 2.0 Login Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/login/accept:
    put:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell the Ory OAuth2 Service about it.


        The authentication challenge is appended to the login provider URL to which the subject''s user-agent (browser) is redirected to. The login

        provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.


        This endpoint tells Ory that the subject has successfully authenticated and includes additional information such as

        the subject''s ID and if Ory should remember the subject''s subject agent for future authentication attempts by setting

        a cookie.


        The response contains a redirect URL which the login provider should redirect the user-agent to.'
      operationId: acceptOAuth2LoginRequest
      parameters:
      - description: OAuth 2.0 Login Request Challenge
        in: query
        name: login_challenge
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/acceptOAuth2LoginRequest'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Accept OAuth 2.0 Login Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/login/reject:
    put:
      description: 'When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider

        to authenticate the subject and then tell the Ory OAuth2 Service about it.


        The authentication challenge is appended to the login provider URL to which the subject''s user-agent (browser) is redirected to. The login

        provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.


        This endpoint tells Ory that the subject has not authenticated and includes a reason why the authentication

        was denied.


        The response contains a redirect URL which the login provider should redirect the user-agent to.'
      operationId: rejectOAuth2LoginRequest
      parameters:
      - description: OAuth 2.0 Login Request Challenge
        in: query
        name: login_challenge
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rejectOAuth2Request'
        x-originalParamName: Body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Reject OAuth 2.0 Login Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/logout:
    get:
      description: Use this endpoint to fetch an Ory OAuth 2.0 logout request.
      operationId: getOAuth2LogoutRequest
      parameters:
      - in: query
        name: logout_challenge
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2LogoutRequest'
          description: oAuth2LogoutRequest
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Get OAuth 2.0 Session Logout Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/logout/accept:
    put:
      description: 'When a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to confirm that logout request.


        The response contains a redirect URL which the consent provider should redirect the user-agent to.'
      operationId: acceptOAuth2LogoutRequest
      parameters:
      - description: OAuth 2.0 Logout Request Challenge
        in: query
        name: logout_challenge
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2RedirectTo'
          description: oAuth2RedirectTo
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Accept OAuth 2.0 Session Logout Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/requests/logout/reject:
    put:
      description: 'When a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to deny that logout request.

        No HTTP request body is required.


        The response is empty as the logout provider has to chose what action to perform next.'
      operationId: rejectOAuth2LogoutRequest
      parameters:
      - in: query
        name: logout_challenge
        required: true
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/emptyResponse'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Reject OAuth 2.0 Session Logout Request
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/sessions/consent:
    delete:
      description: 'This endpoint revokes a subject''s granted consent sessions and invalidates all

        associated OAuth 2.0 Access Tokens. You may also only revoke sessions for a specific OAuth 2.0 Client ID.'
      operationId: revokeOAuth2ConsentSessions
      parameters:
      - description: 'OAuth 2.0 Consent Subject


          The subject whose consent sessions should be deleted.'
        in: query
        name: subject
        schema:
          type: string
      - description: 'OAuth 2.0 Client ID


          If set, deletes only those consent sessions that have been granted to the specified OAuth 2.0 Client ID.'
        in: query
        name: client
        schema:
          type: string
      - description: 'Consent Request ID


          If set, revoke all token chains derived from this particular consent request ID.'
        in: query
        name: consent_request_id
        schema:
          type: string
      - description: 'Revoke All Consent Sessions


          If set to `true` deletes all consent sessions by the Subject that have been granted.'
        in: query
        name: all
        schema:
          type: boolean
      responses:
        '204':
          $ref: '#/components/responses/emptyResponse'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Revoke OAuth 2.0 Consent Sessions of a Subject
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
    get:
      description: 'This endpoint lists all subject''s granted consent sessions, including client and granted scope.

        If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an

        empty JSON array with status code 200 OK.'
      operationId: listOAuth2ConsentSessions
      parameters:
      - description: 'Items per Page


          This is the number of items per page to return.

          For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).'
        in: query
        name: page_size
        schema:
          default: 250
          format: int64
          maximum: 500
          minimum: 1
          type: integer
      - description: 'Next Page Token


          The next page token.

          For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).'
        in: query
        name: page_token
        schema:
          type: string
      - description: The subject to list the consent sessions for.
        in: query
        name: subject
        required: true
        schema:
          type: string
      - description: The login session id to list the consent sessions for.
        in: query
        name: login_session_id
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oAuth2ConsentSessions'
          description: oAuth2ConsentSessions
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: List OAuth 2.0 Consent Sessions of a Subject
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/auth/sessions/login:
    delete:
      description: 'This endpoint invalidates authentication sessions. After revoking the authentication session(s), the subject

        has to re-authenticate at the Ory OAuth2 Provider. This endpoint does not invalidate any tokens.


        If you send the subject in a query param, all authentication sessions that belong to that subject are revoked.

        No OpenID Connect Front- or Back-channel logout is performed in this case.


        Alternatively, you can send a SessionID via `sid` query param, in which case, only the session that is connected

        to that SessionID is revoked. OpenID Connect Back-channel logout is performed in this case.


        When using Ory for the identity provider, the login provider will also invalidate the session cookie.'
      operationId: revokeOAuth2LoginSessions
      parameters:
      - description: 'OAuth 2.0 Subject


          The subject to revoke authentication sessions for.'
        in: query
        name: subject
        schema:
          type: string
      - description: 'Login Session ID


          The login session to revoke.'
        in: query
        name: sid
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/emptyResponse'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
  /admin/oauth2/introspect:
    post:
      description: 'The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token

        is neither expired nor revoked. If a token is active, additional information on the token will be included. You can

        set additional data for a token by setting `session.access_token` during the consent flow.'
      operationId: introspectOAuth2Token
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                scope:
                  description: 'An optional, space separated list of required scopes. If the access token was not granted one of the

                    scopes, the result of active will be false.'
                  type: string
                  x-formData-name: scope
                token:
                  description: 'The string value of the token. For access tokens, this

                    is the "access_token" value returned from the token endpoint

                    defined in OAuth 2.0. For refresh tokens, this is the "refresh_token"

                    value returned.'
                  required:
                  - token
                  type: string
                  x-formData-name: token
              required:
              - token
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/introspectedOAuth2Token'
          description: introspectedOAuth2Token
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Introspect OAuth2 Access and Refresh Tokens
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-high
  /admin/oauth2/tokens:
    delete:
      description: This endpoint deletes OAuth2 access tokens issued to an OAuth 2.0 Client from the database.
      operationId: deleteOAuth2Token
      parameters:
      - description: OAuth 2.0 Client ID
        in: query
        name: client_id
        required: true
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/emptyResponse'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorOAuth2'
          description: errorOAuth2
      summary: Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
      tags:
      - oAuth2
      x-ory-ratelimit-bucket: hydra-admin-low
  /admin/trust/grants/jwt-bearer/issuers:
    get:
      description: Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.
      operationId: listTrustedOAuth2JwtGrantIssuers
      parameters:
      - description: 'Items per Page


          This is the number of items per page to return.

          For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).'
        in: query
        name: page_size
        schema:
          default: 250
          format: int64
          maximum: 1000
          mi

# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ory/refs/heads/main/openapi/ory-oauth2-api-openapi.yml