openapi: 3.2.0
info:
  title: Folio Permissions Users API
  version: v1
  description: 'Operations tagged permissions-users across 2 of this provider''s published API definitions: folio-mod-roles-keycloak-openapi.json, folio-mod-roles-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: permissions-users
paths:
  /permissions/users/{id}:
    get:
      description: Get permissions by user ID. If onlyVisible=true, then desiredPermissions are ignored. entitledOnly=true applies after onlyVisible and desiredPermissions filtering and may be combined with either.
      operationId: getPermissionsUser
      tags:
      - permissions-users
      parameters:
      - $ref: '#/components/parameters/pathEntityId'
      - $ref: '#/components/parameters/onlyVisible'
      - $ref: '#/components/parameters/desiredPermissions'
      - $ref: '#/components/parameters/entitledOnly'
      responses:
        '200':
          description: Retrieve permissions by user id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/permissions_user'
              example:
                $ref: '#/components/examples/permissionsUserResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
        '501':
          $ref: '#/components/responses/notImplementedResponse'
      summary: Get permissions user
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
components:
  parameters:
    entitledOnly:
      in: query
      name: entitledOnly
      description: Return only permissions from currently entitled applications
      required: false
      schema:
        type: boolean
        default: false
    desiredPermissions:
      in: query
      name: desiredPermissions
      description: A list of permissions to filter by
      required: false
      schema:
        type: array
        items:
          type: string
      example:
      - users.item.get
      - users.collection.*
    pathEntityId:
      in: path
      required: true
      name: id
      description: Entity id
      schema:
        type: string
        format: uuid
    onlyVisible:
      in: query
      name: onlyVisible
      description: Return only visible permission sets
      required: false
      schema:
        type: boolean
        default: false
      example: false
  schemas:
    permissions_user:
      $schema: http://json-schema.org/draft-04/schema#
      title: Permissions User Schema
      description: Permissions user
      type: object
      properties:
        userId:
          description: Id of the user
          type: string
          format: uuid
        permissions:
          description: List of permissions assigned to the user
          type: array
          minItems: 1
          items:
            description: Permission names assigned to the user
            type: string
      required:
      - userId
      - permissions
    errors:
      description: A set of errors
      $schema: http://json-schema.org/draft-04/schema#
      type: object
  responses:
    internalServerErrorResponse:
      description: Error response for unhandled or critical server exceptions, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
          example:
            $ref: '#/components/examples/internalServerErrorResponse'
    notImplementedResponse:
      description: Operation is not supported error response in JSON format for validation errors.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
          example:
            $ref: '#/components/examples/notImplementedResponse'
  examples:
    permissionsUserResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    notImplementedResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    internalServerErrorResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
x-refined-from:
- folio-mod-roles-keycloak-openapi.json
- folio-mod-roles-keycloak-openapi.yml