Relayger Tokens API

openapi: 3.2.0
info:
  description: The Relayger HTTP API. Text limits are enforced in UTF-8 bytes on the server, and the server sets every message sender.
  title: Relayger Tokens API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Tokens
paths:
  /v1/tokens:
    get:
      operationId: get_v1_tokens
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Token'
                type: array
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: 'Administrator: list token metadata'
      tags:
      - Tokens
    post:
      operationId: post_v1_tokens
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenCreated'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: 'Administrator: create a token or rotate one atomically'
      tags:
      - Tokens
  /v1/tokens/{id}:
    delete:
      operationId: delete_v1_tokens__id_
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OK'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: 'Administrator: revoke a token'
      tags:
      - Tokens
components:
  schemas:
    TokenCreated:
      additionalProperties: false
      properties:
        expiresAt:
          format: date-time
          type:
          - string
          - 'null'
        id:
          format: uuid
          type: string
        token:
          $schema: https://json-schema.org/draft/2020-12/schema
          pattern: ^rgt_[a-f0-9]{64}$
          type: string
      required:
      - id
      - token
      - expiresAt
      type: object
    OK:
      additionalProperties: false
      properties:
        ok:
          type: boolean
      required:
      - ok
      type: object
    Error:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            hint:
              description: One English sentence with the next step, for codes that need one; act on code.
              maxLength: 300
              type: string
          required:
          - code
          type: object
      required:
      - error
      type: object
    TokenInput:
      additionalProperties: false
      properties:
        expiresIn:
          maximum: 31536000
          minimum: 60
          type: integer
        identityId:
          format: uuid
          type: string
        roomIds:
          items:
            format: uuid
            type: string
          maxItems: 64
          type:
          - array
          - 'null'
        rotateId:
          format: uuid
          type: string
        scopes:
          items:
            enum:
            - read
            - write
            - rooms
            - tasks
            - approvals
            - files
            - contacts
            - account
            - admin
            - '*'
          maxItems: 10
          minItems: 1
          type: array
      required:
      - identityId
      - scopes
      - expiresIn
      type: object
    Token:
      additionalProperties: false
      properties:
        expiresAt:
          format: date-time
          type:
          - string
          - 'null'
        id:
          format: uuid
          type: string
        identityId:
          format: uuid
          type: string
        revokedAt:
          format: date-time
          type:
          - string
          - 'null'
        roomIds:
          items:
            format: uuid
            type: string
          type:
          - array
          - 'null'
        scopes:
          items:
            type: string
          type: array
      required:
      - id
      - identityId
      - scopes
      - roomIds
      - expiresAt
      - revokedAt
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    sessionCookie:
      description: Valid for at most 8 hours, enforced by the database. Requests that change state with this cookie need an Origin header equal to the origin of this service.
      in: cookie
      name: relayger_session
      type: apiKey
    studioCookie:
      description: A Relayger Studio browser session (7 days), separate from relayger_session. Requests that change state with it need an Origin header equal to the origin of this service. Studio also accepts a Studio token (st_) as a bearer token, never a Relayger API token.
      in: cookie
      name: relayger_studio
      type: apiKey