Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
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
User Management
Generate Backup Codes
Generate 12 backup codes for two-factor authentication recovery. These codes can be used when the authenticator app is unavailable.
POST
/
me
/
backup-codes
Generate Backup Codes
Copy
curl --request POST \
--url https://{deploymentHost}/me/backup-codesCopy
{
"status": 200,
"message": "",
"data": {
"backup_codes": [
"ABCD-1234",
"EFGH-5678",
"IJKL-9012",
"MNOP-3456",
"QRST-7890",
"UVWX-2468",
"YZAB-1357",
"CDEF-9024",
"GHIJ-5791",
"KLMN-8246",
"OPQR-1593",
"STUV-7420"
],
"generated_at": "2024-01-15T11:00:00Z"
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}Previous
Regenerate Backup CodesRegenerate all backup codes, invalidating any previously generated codes. This should be done if backup codes are compromised or lost.
Next
⌘I
Generate Backup Codes
Copy
curl --request POST \
--url https://{deploymentHost}/me/backup-codesCopy
{
"status": 200,
"message": "",
"data": {
"backup_codes": [
"ABCD-1234",
"EFGH-5678",
"IJKL-9012",
"MNOP-3456",
"QRST-7890",
"UVWX-2468",
"YZAB-1357",
"CDEF-9024",
"GHIJ-5791",
"KLMN-8246",
"OPQR-1593",
"STUV-7420"
],
"generated_at": "2024-01-15T11:00:00Z"
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}