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

# Request password reset

> Sends a password reset email to the user.



## OpenAPI

````yaml /api-spec/ias-public-api.yaml post /users/password-reset
openapi: 3.0.3
info:
  title: IAM Service API
  description: APIs for IAM Service.
  version: 2.4.0
servers:
  - url: https://console.gmicloud.ai/api/v1
    description: IAM Service API
security: []
paths:
  /users/password-reset:
    post:
      tags:
        - users
      summary: Request password reset
      description: Sends a password reset email to the user.
      operationId: requestPasswordReset
      requestBody:
        description: The request body for requesting a password reset.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/passwordResetRequest'
      responses:
        '200':
          description: Successfully sent password reset email.
        '400':
          description: |
            - [group:**request**, code:**0**]: Invalid field in the request.
            - [group:**request**, code:**1**]: The request body is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrStatusMsg'
              examples:
                Invalid field in the request:
                  summary: Invalid field in the request.
                  value:
                    group: request
                    code: 0
                    validationDetail:
                      - field: email
                        expression: required
                        originalValue: ''
                        reason: This field is required.
        '429':
          description: |
            - [group:**user**, code:**200**]: Too many password reset requests.
          headers:
            Retry-After:
              description: The number of seconds the user should wait before retrying.
              schema:
                type: integer
                example: 300
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrStatusMsg'
              examples:
                Too many password reset requests:
                  summary: Too many password reset requests.
                  value:
                    group: user
                    code: 200
                    message: Too many password reset requests.
        '500':
          description: >
            - [group:**user**, code:**201**]: Get user password reset data
            encountered error.

            - [group:**user**, code:**202**]: Get user password reset data TTL
            encountered error.

            - [group:**user**, code:**203**]: Save user password reset data
            encountered error.

            - [group:**user**, code:**204**]: Create OTP code encountered error.

            - [group:**user**, code:**205**]: Create password reset token
            encountered error.

            - [group:**user**, code:**1200**]: Get user encountered DB error.

            - [group:**email**, code:**0**]: Failed to send email.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrStatusMsg'
              examples:
                Get user password reset data encountered error:
                  summary: Get user password reset data encountered error.
                  value:
                    group: user
                    code: 201
                    message: Get user password reset data encountered error.
                    traces:
                      - error occurred.
components:
  schemas:
    passwordResetRequest:
      type: object
      x-go-name: passwordResetRequest
      properties:
        email:
          type: string
          description: |
            User's email address for requesting a password reset.
            - Must be a valid email format.
          example: john_doe@example.com
          x-oapi-codegen-extra-tags:
            binding: required,email
      required:
        - email
    ErrStatusMsg:
      type: object
      properties:
        group:
          type: string
          description: >-
            API function group\n -Will be "request" if there are invalid request
            parameters.
          x-oapi-codegen-extra-tags:
            binding: required
        code:
          type: integer
          description: The substatus error code for the API response.
          x-oapi-codegen-extra-tags:
            binding: required
        message:
          type: string
          description: The substatus error Message for API response.
          x-go-type-skip-optional-pointer: true
        traces:
          type: array
          items:
            type: string
          description: The original error messages.
          x-go-type-skip-optional-pointer: true
        validationDetail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationDetail'
          description: >-
            Returned when there are invalid request
            paremeters(group="request")\n List of invalid fields and the reason
            of error.
          x-go-type-skip-optional-pointer: true
      example:
        group: request
        code: 0
        validationDetail:
          - field: email
            expression: required
            originalValue: ''
            reason: This field is required.
      required:
        - group
        - code
    ValidationDetail:
      type: object
      properties:
        field:
          type: string
          description: The field of the request data.
          x-go-type-skip-optional-pointer: true
        expression:
          type: string
          description: The form of violation.
          x-go-type-skip-optional-pointer: true
        argument:
          type: string
          description: The number or data to support the expression.
          x-go-type-skip-optional-pointer: true
        originalValue:
          description: The original value from the request.
          x-go-type-skip-optional-pointer: true
        reason:
          type: string
          description: The reason for the validation error.
          x-go-type-skip-optional-pointer: true
      example:
        - field: fieldXXX
          expression: required
          originalValue: ''
          reason: This field is required.

````