Trigger a password reset flow

Triggers a password reset flow for the specified person and credential. The specified person must then take action to complete the flow and set a new password. Optionally, you can specify which of the person's handles will be used to send the password reset link.

Path Parameters

• person_id string required

  The person ID

  Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a

Header Parameters

• SlashID-OrgID string required

  The organization ID

  Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

application/json

Request Body required

• force_change boolean

  Delete the existing password for a person, forcing a new password to be set before the next password authentication.

• reset_handle object

  type string required

  Possible values: [email_address, phone_number, username]

  value string required

Responses

• 202
• 400
• 404

---

Accepted - Request was accepted and will be processed in the background

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}