openapi: 3.2.0
info:
  title: mod-authtoken Refreshtoken API
  version: v1
tags:
- name: Refreshtoken
paths:
  /refreshtoken:
    parameters:
    - $ref: '#/components/parameters/okapi-tenant-required'
    - $ref: '#/components/parameters/okapi-url-required'
    post:
      description: 'Returns a signed, expiring refresh token. This is a legacy endpoint and should not be

        called by new code and will soon be fully depreciated.'
      operationId: token-sign-legacy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/signRefreshToken'
        required: true
      responses:
        '201':
          description: Created and signed token successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/token'
        '400':
          $ref: '#/components/responses/trait_400'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Refreshtoken
      summary: Token sign legacy
      x-summary-source: derived
components:
  parameters:
    okapi-url-required:
      in: header
      name: X-Okapi-Url
      description: Okapi URL
      required: true
      schema:
        type: string
    okapi-tenant-required:
      in: header
      name: X-Okapi-Tenant
      description: Okapi Tenant
      required: true
      schema:
        type: string
  schemas:
    token:
      description: The signed JWT token based on the payload
      type: object
      properties:
        token:
          type: string
          description: The JWT token
      required:
      - token
      additionalProperties: false
    signRefreshToken:
      description: The request to sign a new refresh token
      type: object
      properties:
        userId:
          type: string
          description: The user id of the request
          format: uuid
        sub:
          type: string
          description: The subject (user id) of the request
      required:
      - userId
      - sub
      additionalProperties: false
  responses:
    trait_500:
      description: Internal error
      content:
        text/plain:
          schema:
            type: string
            example: Internal server error, contact administrator
    trait_400:
      description: Bad request
      content:
        text/plain:
          schema:
            type: string
            example: Invalid JSON in request
        application/json:
          schema:
            type: object
            example:
              error: Invalid JSON in request