Passcode

Initialize passcode login

Initialize a passcode login for the user identified by user_id. Sends an email containing the actual passcode to the user's primary email address or to the address specified through email_id. Returns a representation of the passcode.

post/passcode/login/initialize

Request

Base URL
https://.hanko.io/admin
Auth
none required
TypeScript
https://skmtc.dev/hanko/apis/hanko-admin-api/docs/passcode/login/initialize/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

user_idstring uuid4 required

email_idstring uuid4

Example request

{
  "user_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "email_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"
}

Response

Successful passcode login initialization

idstring uuid4

ttlinteger

Lifespan of a passcode in seconds

created_atstring date-time

Time of creation of the passcode

Example response

{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "ttl": 300
}

Changes

No recorded changes to this operation across all 1 revision of this API.