ROOK User Id API

openapi: 3.2.0
info:
  title: ROOK User Id API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 6 operation(s) read from 4 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; ROOK has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 3
    pages-with-code: 2
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.tryrook.io/docs/rookconnect/data-authorization
  - https://docs.tryrook.io/docs/rookconnect/add-ons
  - https://docs.tryrook.io/docs/ROOKExtractionApp/implementation
  - https://tryrook.io/rook-app
servers:
- url: https://api.rook-connect.com
security:
- basic: []
tags:
- name: User Id
paths:
  /api/v1/user_id/{userId}/data_source/{dataSource}/authorizer:
    get:
      operationId: get_api_v1_user_id_userId_data_source_dataSource_authorizer
      tags:
      - User Id
      summary: Returns the user’s authorization status and, if not authorized, an…
      x-source: https://docs.tryrook.io/docs/rookconnect/data-authorization
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: dataSource
        in: path
        required: true
        schema:
          type: string
      - name: redirect_url
        in: query
        required: false
        schema:
          type: string
        description: A custom URL for redirecting users after authorization.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Basic {Base64Encoded(client_uuid:secret_key)}
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1UserIdUseridDataSourceDatasourceAuthorizerResponse'
      x-evidence:
        kind: documentation
  /api/v1/user_id/{userId}/data_sources/revoke_auth:
    post:
      operationId: post_api_v1_user_id_userId_data_sources_revoke_auth
      tags:
      - User Id
      summary: Revoke User Authorization
      x-source: https://docs.tryrook.io/docs/rookconnect/data-authorization
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Basic {Base64Encoded(client_uuid:secret_key)}
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1UserIdUseridDataSourceDatasourceAuthorizerResponse:
      type: object
      properties:
        data_source:
          type: string
          description: The data source name.
        authorized:
          type: boolean
          description: Authorization status.
        authorization_url:
          type: string
          description: URL to start the authorization flow (present when authorized is false).
  securitySchemes:
    basic:
      type: http
      scheme: basic