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
User Management
Verify TOTP Authenticator Setup
Verify that the TOTP authenticator is set up correctly by providing two consecutive authentication codes. This activates two-factor authentication.
POST
/
me
/
authenticator
/
attempt-verification
Verify TOTP Authenticator Setup
Copy
curl --request POST \
--url https://{deploymentHost}/me/authenticator/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"code1": "123456",
"code2": "789012"
}'Copy
{
"status": 200,
"message": "",
"data": {
"verified": true,
"two_factor_enabled": true,
"authenticator": {
"id": "auth_123456789",
"verified": true,
"created_at": "2024-01-15T10:30:00Z",
"verified_at": "2024-01-15T10:35: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
Delete TOTP AuthenticatorRemove the TOTP authenticator from the user's account, disabling two-factor authentication. Requires password confirmation for security.
Next
⌘I
Verify TOTP Authenticator Setup
Copy
curl --request POST \
--url https://{deploymentHost}/me/authenticator/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"code1": "123456",
"code2": "789012"
}'Copy
{
"status": 200,
"message": "",
"data": {
"verified": true,
"two_factor_enabled": true,
"authenticator": {
"id": "auth_123456789",
"verified": true,
"created_at": "2024-01-15T10:30:00Z",
"verified_at": "2024-01-15T10:35: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": []
}