Skip to content

Workspace

The workspace endpoint returns the current configuration of the workspace resolved from the API key’s tenant context. This is a read-only endpoint — workspace settings are managed through the admin console.

Required scope: workspace:read


{
"id": 2,
"slug": "my-app",
"displayName": "My App",
"issuerUrl": "https://auth.yourdomain.com/t/my-app",
"tokenExpirySeconds": 300,
"refreshTokenExpirySeconds": 2592000,
"registrationEnabled": true,
"emailVerificationRequired": true,
"passkeysEnabled": true,
"maxConcurrentSessions": null,
"signInMethods": {
"password": true,
"passkey": true,
"magicLink": true,
"emailOtp": true
},
"passwordPolicy": {
"minLength": 8,
"requireSpecial": false,
"requireUppercase": false,
"requireNumber": false,
"historyCount": 0,
"maxAgeDays": 0,
"blacklistEnabled": true,
"hibpCheckEnabled": true
},
"mfaPolicy": "optional",
"lockoutMaxAttempts": 5,
"lockoutDurationMinutes": 15,
"magicLinkTtlMinutes": 15,
"emailOtpSignupEnabled": true,
"emailOtpLockoutThreshold": 5,
"corsAllowCredentials": false,
"portalLayout": "sidenav"
}
FieldTypeDescription
idintegerInternal workspace ID
slugstringURL-safe workspace identifier
displayNamestringHuman-readable workspace name
issuerUrlstring | nullJWT iss claim base URL
tokenExpirySecondsintegerAccess token lifetime in seconds
refreshTokenExpirySecondsintegerRefresh token lifetime in seconds
registrationEnabledbooleanWhether self-registration is allowed
emailVerificationRequiredbooleanWhether email verification is enforced
passkeysEnabledbooleanWhether passkey sign-in is enabled
maxConcurrentSessionsinteger | nullSession limit per user. null = unlimited
signInMethodsobjectWhich sign-in methods are enabled
passwordPolicyobjectPassword strength and history rules
mfaPolicystringoptional, required, or required_for_admins
lockoutMaxAttemptsintegerFailed login attempts before lockout
lockoutDurationMinutesintegerLockout duration
magicLinkTtlMinutesintegerMagic link token expiry
emailOtpSignupEnabledbooleanWhether Email OTP creates accounts for unknown emails
emailOtpLockoutThresholdintegerCross-challenge OTP failure threshold
corsAllowCredentialsbooleanCORS Access-Control-Allow-Credentials setting
portalLayoutstringUser portal layout (sidenav or tabnav)

GET /t/{slug}/api/v1/workspace

Response 200 OK: Returns the workspace object.