DoControl Authentication API

openapi: 3.1.0
info:
  title: DoControl Authentication API
  description: DoControl exposes a GraphQL API for its SaaS data security platform. Authentication uses a short-lived access token obtained by exchanging a refresh token (the API key issued from the DoControl admin panel) at the auth endpoint. All GraphQL queries and mutations are sent as POST requests to the gateway endpoint.
  version: '4.0'
servers:
- url: https://apollo-gateway-v4-api.prod.docontrol.io
  description: DoControl GraphQL gateway
- url: https://auth.prod.docontrol.io
  description: DoControl auth service
security:
- bearerAuth: []
tags:
- name: Authentication
paths:
  /refresh:
    post:
      tags:
      - Authentication
      summary: Exchange refresh token for access token
      description: Exchange the API key (refresh token) for an access token that is valid for approximately 5 minutes. Use the access token as a Bearer token in subsequent GraphQL requests.
      operationId: refreshToken
      servers:
      - url: https://auth.prod.docontrol.io
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - refreshToken
              properties:
                refreshToken:
                  type: string
                  description: API key created in DoControl admin panel
      responses:
        '200':
          description: Access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  accessToken:
                    type: string
                  expiresIn:
                    type: integer
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token returned from /refresh