openapi: 3.2.0
info:
  title: Logius Token API
  version: 1.0.0
  description: 'Operations tagged Token across 2 of this provider''s published API definitions: logius-fsc-manager-openapi.yml, logius-fsc-manager-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{managerUrl}:8443/v1
  variables:
    managerUrl:
      default: localhost
      description: URL of the Manager
tags:
- name: Token
paths:
  /token:
    post:
      summary: Used to obtain a JWT which can be used to authorize a connection to a Service.
      operationId: getToken
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                grant_type:
                  $ref: '#/components/schemas/oAuthGrantType'
                scope:
                  description: The scope should contain the hash of the Grant that contains the authorization for a connection to a Service
                  type: string
                  example: $1$4$-PQI7we01qIfEwq4O5UioLKzjGBgRva6F5-bUfDlKxUjcY5yX1MRsn6NKquDbL8VcklhYO9sk18rHD6La3w_mg
                  maxLength: 1024
                client_id:
                  description: The Peer ID of the connecting Peer
                  $ref: '#/components/schemas/peerID'
              required:
              - grant_type
              - scope
              - client_id
      responses:
        200:
          description: A token response
          content:
            application/json:
              schema:
                properties:
                  access_token:
                    description: The access token
                    type: string
                  token_type:
                    $ref: '#/components/schemas/oAuthTokenType'
                required:
                - access_token
                - token_type
        400:
          description: Bad request
          content:
            application/json:
              schema:
                properties:
                  error:
                    $ref: '#/components/schemas/tokenErrorCode'
                  error_description:
                    description: A human-readable description of the error
                    type: string
                    example: contract containing the provided grant hash has been revoked
                required:
                - error
      tags:
      - Token
    servers:
    - url: https://{managerUrl}:8443/v1
      variables:
        managerUrl:
          default: localhost
          description: URL of the Manager
components:
  schemas:
    peerID:
      description: The ID of a Peer
      type: string
      example: '12345678901234567891'
      minLength: 3
      maxLength: 255
    oAuthGrantType:
      description: The grant_type of an access token request. FSC only uses client_credentials
      type: string
      enum:
      - client_credentials
    oAuthTokenType:
      description: The type of token. FSC only uses Bearer
      type: string
      enum:
      - bearer
    tokenErrorCode:
      description: one of the error codes described in https://www.rfc-editor.org/rfc/rfc6749#section-5.2
      type: string
      example: invalid_request
      enum:
      - invalid_request
      - invalid_client
      - invalid_grant
      - invalid_scope
      - unauthorized_client
      - unsupported_grant_type
x-refined-from:
- logius-fsc-manager-openapi.yml
- logius-fsc-manager-openapi.yml