Skip to main content
POST
/
api
/
v1
/
users
/
{user_id}
/
login
Create a login method for a user
curl --request POST \
  --url https://breadbox.example.com/api/v1/users/{user_id}/login \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "id": "<string>",
  "short_id": "<string>",
  "user_id": "<string>",
  "kind": "<string>",
  "identifier": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Path Parameters

user_id
string
required

Body

application/json

The body is of type object.

Response

201 - application/json

Created login.

id
string
short_id
string
user_id
string
kind
string

password, magic_link, etc.

identifier
string | null
last_used_at
string<date-time> | null
created_at
string<date-time>