Reset the password for a user

POST 
/v2/users/:username/reset_password

Reset the password for a user.

Request

Path Parameters

username stringrequired

Specifies the user ID to update. Note that the username must be percent encoded and URI safe.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

User was sent the password reset email.

application/json

Schema

Schema

one_time_code string

A one time code that can be used to reset the password. This is optional, and is only populated for some Vectara deployments.

one_time_code_link string

The link where to enter the one_time_code. This is optional, and is only populated for some Vectara deployments.

Example (from schema)

{
  "one_time_code": "string",
  "one_time_code_link": "string"
}

403

Permissions do not allow resetting the user password.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

User not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...