Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Body
application/json
Authentication
Session
User Management
- GETGet Current User Profile
- PATCHUpdate User Profile
- GETGet User's Organization Memberships
- GETGet User's Workspace Memberships
- GETGet User's Email Addresses
- POSTAdd Email Address
- DELRemove Email Address
- POSTPrepare Email Verification
- POSTVerify Email Address
- POSTMake Email Primary
- GETGet User's Phone Numbers
- POSTAdd Phone Number
- DELRemove Phone Number
- POSTSend Phone Verification SMS
- POSTVerify Phone Number with OTP
- POSTSet Phone Number as Primary
- POSTGenerate New TOTP Authenticator
- POSTVerify TOTP Authenticator Setup
- DELDelete TOTP Authenticator
- POSTGenerate Backup Codes
- POSTRegenerate Backup Codes
- POSTUpload Profile Picture
- POSTUpdate Password
- DELRemove Password
- GETGet Active Sessions
- PATCHSign Out from Specific Session
- DELDisconnect Social Connection
- DELDelete User Account
Organizations
- POSTCreate Organization
- DELDelete Organization
- PATCHUpdate Organization
- DELLeave Organization
- GETGet Organization Members
- DELRemove Organization Member
- PUTAdd Member Role
- DELRemove Member Role
- GETGet Organization Invitations
- POSTInvite Member to Organization
- DELCancel Organization Invitation
- GETGet Organization Roles
- POSTCreate Organization Role
- DELDelete Organization Role
- GETGet Organization Domains
- POSTAdd Organization Domain
- POSTVerify Organization Domain
- DELDelete Organization Domain
- GETGet Organization Billing Addresses
- POSTAdd Organization Billing Address
- PUTUpdate Organization Billing Address
- DELDelete Organization Billing Address
Authentication
Prepare Verification
Send verification code via email or SMS for authentication. Used during signin attempts and profile verification.
POST
/
auth
/
prepare-verification
Copy
curl --request POST \
--url https://{deploymentHost}/auth/prepare-verification \
--header 'Content-Type: application/json' \
--data '{
"signin_attempt_id": "123456789",
"method": "email"
}'Copy
{
"status": 200,
"message": "",
"data": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"current_step": "verify_email_otp",
"completed": false,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"session": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"current_step": "verify_email_otp",
"completed": false,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}Previous
Attempt VerificationVerify authentication code from email or SMS. Completes the verification step for signin or signup attempts.
Next
⌘I
Copy
curl --request POST \
--url https://{deploymentHost}/auth/prepare-verification \
--header 'Content-Type: application/json' \
--data '{
"signin_attempt_id": "123456789",
"method": "email"
}'Copy
{
"status": 200,
"message": "",
"data": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"current_step": "verify_email_otp",
"completed": false,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"session": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"current_step": "verify_email_otp",
"completed": false,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}