A valid request URL is required to generate request examples{
"token": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"totp_enabled": true,
"created_at": "2023-11-07T05:31:56Z"
},
"organizations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_code": "<string>",
"name": "<string>",
"logo_url": "<string>",
"role": "<string>"
}
],
"active_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_organization_code": "<string>"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Sign in
Answers a session, or — when the account has two-factor on — a short-lived challenge to exchange at /v1/auth/two-factor.
An unknown email and a wrong password produce the same 401 and take roughly the same time: the unknown-email path runs a throwaway bcrypt compare so latency does not leak whether an account exists.
Rate limited to 20 requests per 5 minutes per IP.
A valid request URL is required to generate request examples{
"token": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"totp_enabled": true,
"created_at": "2023-11-07T05:31:56Z"
},
"organizations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_code": "<string>",
"name": "<string>",
"logo_url": "<string>",
"role": "<string>"
}
],
"active_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_organization_code": "<string>"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Resposta
Either a session or a two-factor challenge.
- Option 1
- Option 2
uk_st_…. Shown once.
The public shape of a user. What is not listed here — the password hash, the TOTP secret — never reaches a response body.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Null, with organizations empty, when the account is in no organization — it was removed from its last one. Signing in still succeeds and the session still works for the account-level routes; send the person to a chooser rather than into an organization.