openapi: 3.2.0
info:
  title: Folio Password Reset API
  version: v1
  description: 'Operations tagged password-reset 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: password-reset
paths:
  /users-keycloak/password-reset/reset:
    post:
      operationId: passwordReset
      tags:
      - password-reset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/passwordReset'
      responses:
        '204':
          description: Successful password reset
          content:
            text/plain:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/badRequest'
        '422':
          $ref: '#/components/responses/unprocessableEntity'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Password reset
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
  /users-keycloak/password-reset/link:
    post:
      operationId: generatePasswordResetLink
      tags:
      - password-reset
      description: Generate and send password reset link
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateLinkRequest'
      responses:
        '200':
          description: Response for reset password link generation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateLinkResponse'
      summary: Generate password reset link
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
  /users-keycloak/password-reset/validate:
    post:
      operationId: validatePasswordResetLink
      tags:
      - password-reset
      description: Validates password reset link
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '422':
          $ref: '#/components/responses/unprocessableEntity'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Validate password reset link
      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
    passwordReset:
      $schema: http://json-schema.org/draft-04/schema#
      description: Password reset entity
      type: object
      properties:
        newPassword:
          description: New password
          type: string
      additionalProperties: false
      required:
      - newPassword
    generateLinkResponse:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Response for reset password link generation
      properties:
        link:
          type: string
          description: Link for resetting password
      additionalProperties: false
    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'
    generateLinkRequest:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Request to generate and send reset password link
      properties:
        userId:
          type: string
          format: uuid
          description: Id of user to whom a reset password link is sent
      required:
      - userId
  responses:
    internalServerError:
      description: Error response for unhandled or critical server exceptions, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    unprocessableEntity:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    badRequest:
      description: Bad request, e.g. malformed request body or query parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    noContent:
      description: Success, no content
      content:
        text/plain:
          schema:
            type: string
x-refined-from:
- folio-mod-users-keycloak-openapi.json
- folio-mod-users-keycloak-openapi.yml