personio-auth-api.yaml

openapi: 3.0.0
info:
  version: '1.0'
  title: Authentication
  description: 'Personio Authentication API'
x-readme:
  samples-languages:
    - "curl"
    - "python"
    - "ruby"
    - "java"
    - "php"
    - "node"
servers:
  - url: https://api.personio.de/v1

paths:
  /auth:
    post:
      description: 'Request Authentication Token'
      tags:
        - Auth
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  description: API Client id
                client_secret:
                  type: string
                  description: API Client secret
              required:
                - client_id
                - client_secret
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  description: API Client id
                client_secret:
                  type: string
                  description: API Client secret
              required:
                - client_id
                - client_secret
      responses:
        '200':
          description: 'Authentication token response'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationTokenResponse'
              examples:
                response:
                  value:
                    success: true
                    data:
                      token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpLmRldi5wZXJzb25pby5kZTozMDAwMS92MS9hdXRoIiwiaWF0IjoxNDg5MDkxMzA2LCJleHAiOjE0ODkxNzc3MDYsIm5iZiI6MTQ4OTA5MTMwNiwianRpIjoiZmU1ZjkxOGY2MDZjOWI4OGMwMzM0ZmJkZjkyYzkwMzgiLCJzdWIiOiJPR014TVdRd1kySmxZbVF6Tm1RNVpqQmxOell6WmpsaSJ9.QZZCdlDjmL-LYdoDx2XLUfhwTdcjDgm9h4t-6JoACiM"
                      expires_in: 86400
                      scope: employees:read absences:read
components:
  schemas:
    Response:
      title: Default response object
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
      required:
        - success
        - data
    AuthenticationTokenResponse:
      title: Request Authentication Token response
      allOf:
        - $ref: '#/components/schemas/Response'
        - type: object
          properties:
            data:
              type: object
              required:
                - token
              properties:
                token:
                  type: string
                expires_in:
                  type: number
                scope:
                  type: string