openapi: 3.2.0
info:
  title: Folio Forgotten Username Password API
  version: v1
  description: 'Operations tagged forgotten-username-password 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: forgotten-username-password
paths:
  /users-keycloak/forgotten/password:
    post:
      description: Called when a user has forgotten a password. Always returns 204 No Content regardless of whether a user exists, to prevent username/email enumeration. If a matching active user is found, a password reset link is sent. Otherwise, the request is logged but no email is sent.
      operationId: resetForgottenPassword
      tags:
      - forgotten-username-password
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identifier'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Reset forgotten password
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
  /users-keycloak/forgotten/username:
    post:
      description: Called when a user has forgotten a username. Always returns 204 No Content regardless of whether a user exists, to prevent username/email enumeration. If a matching active user is found, a username reminder is sent. Otherwise, the request is logged but no email is sent.
      operationId: recoverForgottenUsername
      tags:
      - forgotten-username-password
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identifier'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Recover forgotten username
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
components:
  responses:
    internalServerError:
      description: Error response for unhandled or critical server exceptions, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    noContent:
      description: Success, no content
      content:
        text/plain:
          schema:
            type: string
  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
    identifier:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Identifier
      properties:
        id:
          type: string
          description: Id
    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'
x-refined-from:
- folio-mod-users-keycloak-openapi.json
- folio-mod-users-keycloak-openapi.yml