> ## Documentation Index
> Fetch the complete documentation index at: https://docs.2501.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the OAuth account status of a plugin for an organization

> Returns whether an account is connected for the organization, with its expiry and scopes, and never any token; whether an expired access token is renewed at the next use (renewable: a refresh token or a service account), since nothing renews it in the background; why its last renewal failed, if it did; the missing scopes the plugin's own scope list leaves out; what stops the plugin from using the account, such as a client secret the organization cannot read; and the authorization server the plugin trusts. An org-scoped plugin answers for its own organization; a tenant-wide plugin needs org_id.



## OpenAPI

````yaml /0.17/openapi.json get /api/v1/plugins/{id}/oauth
openapi: 3.0.3
info:
  title: 2501 Public API
  version: v1
  description: >-
    The stable, versioned HTTP API for driving 2501 as code. See the API
    Overview for authentication, the org_id rule, cursor pagination, and the
    error envelope.
servers:
  - url: https://{command_center_host}
    variables:
      command_center_host:
        default: your-command-center-host
        description: Your Command Center host
security:
  - bearerAuth: []
paths:
  /api/v1/plugins/{id}/oauth:
    get:
      tags:
        - Plugins
      summary: Read the OAuth account status of a plugin for an organization
      description: >-
        Returns whether an account is connected for the organization, with its
        expiry and scopes, and never any token; whether an expired access token
        is renewed at the next use (renewable: a refresh token or a service
        account), since nothing renews it in the background; why its last
        renewal failed, if it did; the missing scopes the plugin's own scope
        list leaves out; what stops the plugin from using the account, such as a
        client secret the organization cannot read; and the authorization server
        the plugin trusts. An org-scoped plugin answers for its own
        organization; a tenant-wide plugin needs org_id.
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: string
          required: false
          name: org_id
          in: query
      responses:
        '200':
          description: >-
            Connected account expiry and scopes, or null, and the trusted
            authorization server
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorization:
                    type: object
                    nullable: true
                    properties:
                      account_name:
                        type: string
                        nullable: true
                        description: >-
                          Who the account signs in as: the provider's user name,
                          email or subject, or a service account's client id.
                          Null when the provider did not say.
                      expires_at:
                        type: string
                        nullable: true
                        format: date-time
                      scopes:
                        type: array
                        items:
                          type: string
                      missing_scopes:
                        type: array
                        items:
                          type: string
                      renewal_failed_at:
                        type: string
                        nullable: true
                        format: date-time
                      renewal_failure_reason:
                        type: string
                        nullable: true
                        enum:
                          - provider_refused
                          - provider_unreachable
                          - invalid_token_response
                          - issuer_changed
                          - refresh_token_missing
                          - client_secret_unavailable
                          - internal_error
                          - client_rejected
                          - issuer_untrusted
                          - provider_private
                          - configuration_invalid
                          - provider_unsupported
                          - client_key_unusable
                          - null
                      missing_scopes_outside_plugin:
                        type: array
                        items:
                          type: string
                      renewable:
                        type: boolean
                    required:
                      - account_name
                      - expires_at
                      - scopes
                      - missing_scopes
                      - renewal_failed_at
                      - renewal_failure_reason
                      - missing_scopes_outside_plugin
                      - renewable
                  problem:
                    type: string
                    nullable: true
                  problem_reason:
                    type: string
                    nullable: true
                    enum:
                      - client_secret_unavailable
                      - null
                    description: The reason behind problem, for a client that acts on it.
                  trusted_issuer:
                    type: string
                    nullable: true
                required:
                  - authorization
                  - problem
                  - problem_reason
                  - trusted_issuer
        '400':
          description: >-
            Bad request - a field is missing, malformed, or not allowed
            (VALIDATION_FAILED, BAD_REQUEST, INVALID_CURSOR)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            No credentials, or a key that is invalid, revoked, or expired
            (UNAUTHORIZED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Authenticated but not allowed (FORBIDDEN, ORG_ACCESS_DENIED,
            STEP_UP_REFUSED, TWO_FACTOR_ENROLLMENT_REQUIRED,
            LICENSE_CAP_REACHED, LICENSE_EXPIRED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such row that this caller can see (NOT_FOUND)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: VALIDATION_FAILED
        message:
          type: string
          example: Validation failed
        request_id:
          type: string
          example: req_3702b7e7-...
        field:
          type: string
          description: Set when one input is at fault
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
              - field
              - message
          description: Set when several inputs are at fault
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - message
        - request_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key minted in Command Center (Settings -> API Keys), sent as
        `Authorization: Bearer 2501_ak_...`. A Command Center session cookie is
        also accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.