openapi.yaml

openapi: 3.0.3
info:
  title: Auth API
  contact: {}
  version: AUTH_VERSION
paths:
  /.well-known/openid-configuration:
    get:
      summary: Retrieve OpenID connect well-knowns.
      operationId: getOIDCWellKnowns
      tags:
        - auth.v1
      responses:
        '200':
          description: >
            OpenID provider configuration.

            See
            https://swagger.io/docs/specification/authentication/openid-connect-discovery/
            for details
      security:
        - Authorization:
            - auth:read
  /_info:
    get:
      summary: Get server info
      operationId: getServerInfo
      tags:
        - auth.v1
      responses:
        '200':
          description: Server information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfo'
      security:
        - Authorization:
            - auth:read
  /clients:
    get:
      summary: List clients
      tags:
        - auth.v1
      operationId: listClients
      responses:
        '200':
          description: List of clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClientsResponse'
      security:
        - Authorization:
            - auth:read
    post:
      summary: Create client
      tags:
        - auth.v1
      operationId: createClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClientRequest'
      responses:
        '201':
          description: Client created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClientResponse'
      security:
        - Authorization:
            - auth:write
  /clients/{clientId}:
    get:
      summary: Read client
      tags:
        - auth.v1
      operationId: readClient
      parameters:
        - description: Client ID
          in: path
          name: clientId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Retrieved client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadClientResponse'
      security:
        - Authorization:
            - auth:read
    put:
      summary: Update client
      tags:
        - auth.v1
      operationId: updateClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientRequest'
      parameters:
        - description: Client ID
          in: path
          name: clientId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Updated client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClientResponse'
      security:
        - Authorization:
            - auth:write
    delete:
      summary: Delete client
      tags:
        - auth.v1
      operationId: deleteClient
      parameters:
        - description: Client ID
          in: path
          name: clientId
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Client deleted
      security:
        - Authorization:
            - auth:write
  /clients/{clientId}/secrets:
    post:
      summary: Add a secret to a client
      tags:
        - auth.v1
      operationId: createSecret
      parameters:
        - description: Client ID
          in: path
          name: clientId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSecretRequest'
      responses:
        '200':
          description: Created secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSecretResponse'
      security:
        - Authorization:
            - auth:write
  /clients/{clientId}/secrets/{secretId}:
    delete:
      summary: Delete a secret from a client
      tags:
        - auth.v1
      operationId: deleteSecret
      parameters:
        - description: Client ID
          in: path
          name: clientId
          required: true
          schema:
            type: string
        - description: Secret ID
          in: path
          name: secretId
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Secret deleted
      security:
        - Authorization:
            - auth:write
  /users:
    get:
      summary: List users
      tags:
        - auth.v1
      description: List users
      operationId: listUsers
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
      security:
        - Authorization:
            - auth:read
  /users/{userId}:
    get:
      summary: Read user
      tags:
        - auth.v1
      description: Read user
      operationId: readUser
      parameters:
        - description: User ID
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Retrieved user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadUserResponse'
      security:
        - Authorization:
            - auth:read
components:
  schemas:
    Metadata:
      type: object
      nullable: true
      additionalProperties: {}
    ClientOptions:
      type: object
      properties:
        public:
          type: boolean
        redirectUris:
          type: array
          items:
            type: string
        description:
          type: string
        name:
          type: string
        trusted:
          type: boolean
        postLogoutRedirectUris:
          type: array
          items:
            type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
        scopes:
          type: array
          items:
            type: string
      required:
        - name
    ClientSecret:
      type: object
      properties:
        lastDigits:
          type: string
        name:
          type: string
        id:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
        - id
        - lastDigits
        - name
    Client:
      allOf:
        - $ref: '#/components/schemas/ClientOptions'
        - type: object
          properties:
            id:
              type: string
            secrets:
              type: array
              items:
                $ref: '#/components/schemas/ClientSecret'
          required:
            - id
    ScopeOptions:
      type: object
      properties:
        label:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
        - label
    Scope:
      allOf:
        - $ref: '#/components/schemas/ScopeOptions'
        - type: object
          properties:
            id:
              type: string
            transient:
              type: array
              items:
                type: string
          required:
            - id
    SecretOptions:
      type: object
      properties:
        name:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
        - name
    Secret:
      allOf:
        - $ref: '#/components/schemas/SecretOptions'
        - type: object
          properties:
            id:
              type: string
            lastDigits:
              type: string
            clear:
              type: string
          required:
            - id
            - lastDigits
            - clear
    User:
      type: object
      properties:
        id:
          type: string
          example: 3bb03708-312f-48a0-821a-e765837dc2c4
        subject:
          type: string
          example: Jane Doe
        email:
          type: string
          example: user1@orga1.com
    CreateClientRequest:
      $ref: '#/components/schemas/ClientOptions'
    CreateClientResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Client'
    ListClientsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Client'
    UpdateClientRequest:
      $ref: '#/components/schemas/ClientOptions'
    UpdateClientResponse:
      $ref: '#/components/schemas/CreateClientResponse'
    ReadClientResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Client'
    CreateSecretRequest:
      $ref: '#/components/schemas/SecretOptions'
    CreateSecretResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Secret'
    ReadUserResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/User'
    ListUsersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/User'
    ServerInfo:
      type: object
      required:
        - version
      properties:
        version:
          type: string