Pocket ID API

openapi: 3.1.0
info:
  title: Pocket ID API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 7 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Pocket ID has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 3
    pages-with-code: 5
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://pocket-id.org/docs/api
  - https://pocket-id.org/docs/guides/apis
  - https://pocket-id.org/docs/guides/oidc-client-authentication
  - https://pocket-id.org/docs/setup/installation
  - https://pocket-id.org/docs/setup/user-management
  - https://pocket-id.org/docs/setup/upgrading
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://pocket-id.org/docs/guides/oidc-client-authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl jq - responsefile=$(mktemp) - | curl -SsfX POST --url "$POCKET_ID_URL/api/oidc/token" \ -F "grant_type=client_credentials"
          \ -F "client_id=$POCKET_ID_CLIENT_ID" \ -F "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \ -F "client_assertion=$GL_PIPELINE_TOKEN"
          \ -o "$responsefile" - access_token=$(jq '.access_token' -r < "$responsefile") - echo "Successfully obtaine
  /api/oidc/token:
    post:
      operationId: post_api_oidc_token
      tags:
      - Api
      summary: POST /api/oidc/token
      x-source: https://pocket-id.org/docs/guides/apis
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request POST \" https://id.example.com/api/oidc/token \" \\ --form \" grant_type=client_credentials \" \\ --form \" client_id=<client-id>\
          \ \" \\ --form \" client_secret=<client-secret> \" \\ --form \" resource=https://api.orders.example.com \" \\ --form \" scope=read:orders\
          \ \" \" \\\x7F --form \"client_secret= \" \\\x7F --form \"resource=https://api.orders.example.com\" \\\x7F --form \"scope=read:orders\"\
          \"> \n Replace the URL a"
  /api/users:
    get:
      operationId: get_api_users
      tags:
      - Api
      summary: GET /api/users
      x-source: https://pocket-id.org/docs/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \" X-API-KEY: <api key> \" https://id.example.com/api/users \" https://id.example.com/api/users\"> \n List endpoints\
          \ take pagination[page] and pagination[limit] query parameters and answer with the items under data and the totals under pagination\
          \ . \n Errors Section titled “Errors” \n Failed requests answer with an HTTP error status and a JSON body: \n { \"error\" : \" User\
          \ not found \" , \"code\" : \" u"
    post:
      operationId: post_api_users
      tags:
      - Api
      summary: Create users
      x-source: https://pocket-id.org/docs/setup/user-management
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /pocket-id/pocket-id/main/.env.example:
    get:
      operationId: get_pocket_id_pocket_id_main_env_example
      tags:
      - Pocket Id
      summary: Download the Compose file and the example .env file
      x-source: https://pocket-id.org/docs/setup/installation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /pocket-id/pocket-id/main/docker-compose.yml:
    get:
      operationId: get_pocket_id_pocket_id_main_docker_compose_yml
      tags:
      - Pocket Id
      summary: GET /pocket-id/pocket-id/main/docker-compose.yml
      x-source: https://pocket-id.org/docs/setup/installation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -O https://raw.githubusercontent.com/pocket-id/pocket-id/main/docker-compose.yml curl -o .env https://raw.githubusercontent.com/pocket-id/pocket-id/main/.env.example\
          \ \n Set the address you’ll open Pocket ID at and an encryption key in .env : \n .env APP_URL =https://id.example.com # Generate one\
          \ with: openssl rand -base64 32 ENCRYPTION_KEY =<random string of at least 16 characters> \"> \n Environ"
  /pocket-id/pocket-id/releases/latest/download/pocket-id_linux_amd64:
    get:
      operationId: get_pocket_id_pocket_id_releases_latest_download_pocket_id_linux_amd64
      tags:
      - Pocket Id
      summary: Download the binary for your system from the latest release
      x-source: https://pocket-id.org/docs/setup/installation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
security:
- apiKey: []
tags:
- name: Api
- name: Pocket Id