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"
},
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"public_code": "<string>"
},
"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"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Create an account
Bootstraps user, organization and owner membership in one transaction, then signs the user in — the session is minted inside the same transaction, so a sign-up either lands complete or not at all.
Rate limited to 10 requests per hour per IP.
Call GET /v1/auth/signup/config first: it says whether this server demands a solved captcha, and carries the public site key to render one with. When it does, captcha_token is required and a sign-up without one is refused — never let through.
This server may also refuse addresses that belong to throwaway inbox services (disposable_email). Both checks are functions of what the request itself supplied, so they answer before anything is looked up.
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"
},
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"public_code": "<string>"
},
"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"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Corpo
The person's name.
At least 8 characters, with a lowercase letter, an uppercase letter and a digit.
Optional. Defaults to user_name; it can be renamed later.
The solved challenge, required when GET /v1/auth/signup/config reports captcha.required. Ignored otherwise.
Resposta
Account created and signed in.