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
Deployment
Get JSON Web Key
Retrieve the public JSON Web Key used to verify JWT tokens issued by this deployment.
GET
/
.well-known
/
jwk
Get JSON Web Key
Copy
curl --request GET \
--url https://{deploymentHost}/.well-known/jwk \
--cookie __session=Copy
{
"status": 200,
"message": "",
"data": {
"keys": [
{
"kty": "RSA",
"use": "sig",
"kid": "deployment-123-key-1",
"alg": "RS256",
"n": "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx4cbbfAAtVT86zwu1RK7aPFFxuhDR1L6tSoc_BJECPebWKRXjBZCiFV4n3oknjhMstn64tZ_2W-5JsGY4Hc5n9yBXArwl93lqt7_RN5w6Cf0h4QyQ5v-65YGjQR0_FDW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awapJzKnqDKgw",
"e": "AQAB"
}
]
},
"session": {
"signin_attempts": [],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Response
JWK retrieved successfully
HTTP status code
Response message (empty for success)
Response data (can be any type)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique identifier for the sign-in attempt
Available options:
plain_email, plain_username, phone_otp, email_otp, magic_link, sso, passkey Available options:
verify_email, verify_email_otp, verify_email_link, verify_second_factor, verify_phone, verify_phone_otp Whether profile completion is required
Fields that need to be completed
All required fields for this deployment
Previous
Get Deployment InformationRetrieve deployment configuration and settings. Requires authentication to access detailed deployment data.
Next
⌘I
Get JSON Web Key
Copy
curl --request GET \
--url https://{deploymentHost}/.well-known/jwk \
--cookie __session=Copy
{
"status": 200,
"message": "",
"data": {
"keys": [
{
"kty": "RSA",
"use": "sig",
"kid": "deployment-123-key-1",
"alg": "RS256",
"n": "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx4cbbfAAtVT86zwu1RK7aPFFxuhDR1L6tSoc_BJECPebWKRXjBZCiFV4n3oknjhMstn64tZ_2W-5JsGY4Hc5n9yBXArwl93lqt7_RN5w6Cf0h4QyQ5v-65YGjQR0_FDW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awapJzKnqDKgw",
"e": "AQAB"
}
]
},
"session": {
"signin_attempts": [],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}