Request a password token

Error

A valid request URL is required to generate request examples

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

POST

auth

password

requestToken

Error

A valid request URL is required to generate request examples

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Headers

originHeader

string<uri>

The origin of the request. When an email needs to be sent, the "Origin" header value is used (after validation) to correctly generate the hyperlinks inside the email body.

Body

application/json

An object containing a username.

username

Not empty string.

Pattern: .+

Example:

"martin.dupont@kardinal.ai"

Response

The request has been taken into account. If the provided username is a valid email address which corresponds to an active user, a password token will be generated and sent by mail. If no active user is found, the error is silently discarded and a 204 code is returned anyway.

API

Data model

Changes

Request a password token

Headers

Body

Response