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 New TOTP Authenticator
Generate a new Time-based One-Time Password (TOTP) authenticator for two-factor authentication. Returns a QR code URL and manual setup key.
POST
/
me
/
authenticator
Generate New TOTP Authenticator
Copy
curl --request POST \
--url https://{deploymentHost}/me/authenticatorCopy
{
"status": 200,
"message": "",
"data": {
"id": "auth_123456789",
"secret": "JBSWY3DPEHPK3PXP",
"qr_code_url": "otpauth://totp/Acme%20Corp:[email protected]?secret=JBSWY3DPEHPK3PXP&issuer=Acme%20Corp",
"backup_codes": [
"1234-5678",
"2345-6789",
"3456-7890",
"4567-8901",
"5678-9012",
"6789-0123",
"7890-1234",
"8901-2345",
"9012-3456",
"0123-4567",
"1357-2468",
"2468-1357"
],
"verified": false,
"created_at": "2024-01-15T10:30: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
Verify TOTP Authenticator SetupVerify that the TOTP authenticator is set up correctly by providing two consecutive authentication codes. This activates two-factor authentication.
Next
⌘I
Generate New TOTP Authenticator
Copy
curl --request POST \
--url https://{deploymentHost}/me/authenticatorCopy
{
"status": 200,
"message": "",
"data": {
"id": "auth_123456789",
"secret": "JBSWY3DPEHPK3PXP",
"qr_code_url": "otpauth://totp/Acme%20Corp:[email protected]?secret=JBSWY3DPEHPK3PXP&issuer=Acme%20Corp",
"backup_codes": [
"1234-5678",
"2345-6789",
"3456-7890",
"4567-8901",
"5678-9012",
"6789-0123",
"7890-1234",
"8901-2345",
"9012-3456",
"0123-4567",
"1357-2468",
"2468-1357"
],
"verified": false,
"created_at": "2024-01-15T10:30: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": []
}