> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.tarla.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Password Reset Request Operation

> This is the operation that receives the password reset request from users who have forgotten their password. A limit is applied to the password reset request for a user within a certain period. When this limit is exceeded, an email is not sent again and an error message is returned.



## OpenAPI

````yaml en/open-api/auth-version-1.json post /v1/users/password-reset-request
openapi: 3.0.1
info:
  title: OpenAPI definition
  version: v0
servers:
  - url: https://api.iklim.co
    description: Production server
  - url: https://api-test.iklim.co
    description: Test server
  - url: http://localhost:8080
    description: Local development environment with api gateway
security: []
tags:
  - name: User Service
    description: Manages User Related Services
  - name: Authentication Service
    description: Manages Authentication Operations
paths:
  /v1/users/password-reset-request:
    post:
      tags:
        - User Service
      summary: Password Reset Request Operation
      description: >-
        This is the operation that receives the password reset request from
        users who have forgotten their password. A limit is applied to the
        password reset request for a user within a certain period. When this
        limit is exceeded, an email is not sent again and an error message is
        returned.
      operationId: passwordResetRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetRequest'
        required: true
      responses:
        '200':
          description: Successful Password Reset Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetResponse'
        '400':
          description: Required Headers Missing or Payload Invalid for Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
              examples:
                Bad Request Example:
                  summary: Example response
                  description: Bad Request Example
                  value:
                    timestamp: '2025-04-14T16:26:54.203118461'
                    status: 400
                    error: Bad Request
                    message: Missing X-Idempotency-Key header
                    path: /endpoint/uri/here
        '401':
          description: Unauthorized Request or Invalid Signature
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
              examples:
                Unauthorized Example 1:
                  summary: Example response 1
                  description: Unauthorized Example 1
                  value:
                    timestamp: '2025-04-14T16:57:50.083970026'
                    status: 401
                    error: Unauthorized
                    message: Bad Credentials
                    path: /endpoint/uri/here
                Unauthorized Example 2:
                  summary: Example response 2
                  description: Unauthorized Example 2
                  value:
                    timestamp: '2025-04-14T16:57:50.083970026'
                    status: 401
                    error: Unauthorized
                    message: Invalid request signature
                    path: /auth/login
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: Redundant Request Made
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
              examples:
                Conflict Example 1:
                  summary: Example response 1
                  description: Conflict Example 1
                  value:
                    timestamp: '2025-04-14T16:57:21.168927321'
                    status: 409
                    error: Conflict
                    message: Replay attack detected (nonce reused)
                    path: /endpoint/uri/here
                Conflict Example 2:
                  summary: Example response 2
                  description: Conflict Example 2
                  value:
                    timestamp: '2025-04-14T16:56:28.671809875'
                    status: 409
                    error: Conflict
                    message: Duplicate request detected (X-Idempotency-Key)
                    path: /endpoint/uri/here
        '500':
          description: Internal Server Error During Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
              examples:
                Internal Server Error Example:
                  summary: Example response
                  description: Internal Server Error Example
                  value:
                    timestamp: '2025-04-14T16:58:10.414972912'
                    status: 500
                    error: Internal Server Error
                    message: An Error Occurred During Login
                    path: /endpoint/uri/here
components:
  schemas:
    PasswordResetRequest:
      required:
        - passwordResetPageLink
        - userName
      type: object
      properties:
        userName:
          type: string
          description: User Name in E-Mail Format
          example: name@email.com
        passwordResetPageLink:
          type: string
          description: >-
            The Link to The Page Where New Password Will Be Entered During
            Password Reset. Userid (u) and Password Reset Token (t) Are Added As
            Parameters into The Link.
          example: https://ui.iklim.co/reset-password
    PasswordResetResponse:
      type: object
      properties:
        userName:
          type: string
          description: Username
        userId:
          type: string
          description: User Identifier
        token:
          type: string
          description: Password Reset Token
        tokenExpirationEpoch:
          type: integer
          description: Password Reset Token Expiration Date in Epoch Seconds
          format: int64
    StandardErrorResponse:
      required:
        - error
        - message
        - path
        - status
        - timestamp
      type: object
      properties:
        timestamp:
          type: string
          description: Error Time Stamp
          format: date-time
        status:
          type: integer
          description: Error Status Code
          format: int32
        error:
          type: string
          description: Error Name
          example: Error Name
        message:
          type: string
          description: Error Description
          example: Error Message
        path:
          type: string
          description: Erroring Endpoint URI
          example: /endpoint/uri/here

````