openapi: 3.2.0
info:
  title: Folio Self API
  version: 0.0.1
  description: 'Operations tagged Self across 3 of this provider''s published API definitions: folio-mod-consortia-keycloak-self-openapi.json, folio-mod-consortia-keycloak-self-openapi.yml, folio-mod-consortia-self-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /consortia/{consortiumId}/
tags:
- name: Self
paths:
  /_self:
    get:
      summary: Get a list of user tenants associated to the logged in user
      operationId: getUserTenantsForCurrentUser
      parameters:
      - $ref: '#/components/parameters/consortiumId'
      responses:
        '200':
          $ref: '#/components/responses/UserTenantCollection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Self
    servers:
    - url: /consortia/{consortiumId}/
components:
  responses:
    Unauthorized:
      description: Not authorized to perform requested action
      content:
        text/plain:
          example: unable to perform action -- unauthorized
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UserTenantCollection:
      description: Returns a user tenant association collection object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UserTenantCollection'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    UserTenantCollection:
      description: A JSON schema for the User Tenants Collection
      type: object
      properties:
        userTenants:
          type: array
          description: The list of user tenants
          items:
            type: object
            $ref: '#/components/schemas/UserTenant'
        totalRecords:
          type: integer
      additionalProperties: false
      required:
      - userTenants
      - totalRecords
    Error:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters'
      additionalProperties: false
      required:
      - message
    UserTenant:
      description: A JSON schema for the User Tenant
      type: object
      properties:
        id:
          type: string
          format: uuid
        userId:
          type: string
          format: uuid
        username:
          type: string
        tenantId:
          type: string
        tenantName:
          type: string
        isPrimary:
          type: boolean
        centralTenantId:
          type: string
        consortiumId:
          type: string
          format: uuid
        email:
          type: string
        mobilePhoneNumber:
          type: string
        phoneNumber:
          type: string
      additionalProperties: false
      required:
      - userId
      - tenantId
    Parameter:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    Parameters:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
    uuid:
      type: string
      format: uuid
  parameters:
    consortiumId:
      in: path
      name: consortiumId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of consortium
x-refined-from:
- folio-mod-consortia-keycloak-self-openapi.json
- folio-mod-consortia-keycloak-self-openapi.yml
- folio-mod-consortia-self-openapi.yml