openapi: 3.2.0
info:
  title: Folio Auth User API
  version: v1
  description: 'Operations tagged auth-user across 2 of this provider''s published API definitions: folio-mod-users-keycloak-openapi.json, folio-mod-users-keycloak-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8081
  description: Locally deployed server
tags:
- name: auth-user
paths:
  /users-keycloak/auth-users/{userId}:
    get:
      operationId: checkIfExistsAuthUserById
      tags:
      - auth-user
      description: Check if AuthUser exists for the specified user ID
      parameters:
      - $ref: '#/components/parameters/path-entity-userId'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
          description: User is present in Keycloak
        '404':
          $ref: '#/components/responses/entityNotFound'
          description: User is not present in Keycloak
      summary: Check if exists auth user by id
      x-summary-source: derived
    post:
      operationId: createAuthUser
      tags:
      - auth-user
      description: Check if AuthUser exists for the specified user ID
      parameters:
      - $ref: '#/components/parameters/path-entity-userId'
      responses:
        '201':
          $ref: '#/components/responses/created'
          description: User was not present in Keycloak and was created
        '204':
          $ref: '#/components/responses/noContent'
          description: User was already present in Keycloak so nothing was changed
        '400':
          $ref: '#/components/responses/badRequest'
          description: User doesn't have a username
        '500':
          $ref: '#/components/responses/internalServerError'
          description: Unexpected error
      summary: Create auth user
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
components:
  schemas:
    parameter:
      description: List of key/value parameters of an error
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
    error:
      $schema: http://json-schema.org/draft-04/schema#
      description: An error
      type: object
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: List of key/value parameters of an error
          $ref: '#/components/schemas/parameters'
    errors:
      description: A set of errors
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        errors:
          description: List of errors
          id: errors
          type: array
          items:
            $ref: '#/components/schemas/error'
        total_records:
          description: Total number of errors
          type: integer
    parameters:
      description: List of key/value parameters of an error
      $schema: http://json-schema.org/draft-04/schema#
      type: array
      items:
        $ref: '#/components/schemas/parameter'
  responses:
    internalServerError:
      description: Error response for unhandled or critical server exceptions, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    created:
      description: Success, entity created
    badRequest:
      description: Bad request, e.g. malformed request body or query parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    entityNotFound:
      description: Error response if entity is not found by id (in json format)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    noContent:
      description: Success, no content
      content:
        text/plain:
          schema:
            type: string
  parameters:
    path-entity-userId:
      in: path
      required: true
      name: userId
      description: User ID
      schema:
        type: string
        format: uuid
x-refined-from:
- folio-mod-users-keycloak-openapi.json
- folio-mod-users-keycloak-openapi.yml