Switch Active Tenant

POST/auth/switch-tenant

Request body

NestAuthSwitchTenantRequestDto

Field	Type	Required	Description
`tenantId`	`string`	required	Tenant ID to switch into Example: `123e4567-e89b-12d3-a456-426614174000`

Examples

Example

{
  "tenantId": "123e4567-e89b-12d3-a456-426614174000"
}

Responses

200

AuthWithTokensResponseDto

Field	Type	Required	Description
`accessToken`	`string`	required	JWT access token (short-lived) Example: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjMiLCJpYXQiOjE2OTk5OTk5…`
`refreshToken`	`string`	required	JWT refresh token (long-lived) Example: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjMiLCJ0eXBlIjoicmVmcmVz…`
`message`	`string`	optional	Success message (added by controller based on configuration) Example: `Login successful`
`isRequiresMfa`	`boolean`	required	Whether multi-factor authentication is required Example: `false`
`mfaMethods`	`"email" \| "sms" \| "totp"[]`	optional	Available MFA methods when isRequiresMfa is true Example: `["email","totp"]`
`defaultMfaMethod`	`"email" \| "sms" \| "totp"`	optional	Default/recommended MFA method `emailsmstotp` Example: `email`
`trustToken`	`string`	optional	Trust token for trusted device verification Example: `1234567890`

Example response

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjMiLCJpYXQiOjE2OTk5OTk5OTksImV4cCI6MTY5OTk5OTk5OX0.xyz",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjMiLCJ0eXBlIjoicmVmcmVzaCIsImlhdCI6MTY5OTk5OTk5OX0.abc",
  "message": "Login successful",
  "isRequiresMfa": false,
  "mfaMethods": [
    "email",
    "totp"
  ],
  "defaultMfaMethod": "email",
  "trustToken": "1234567890"
}

Try it

curl -X POST 'https://api.example.com/auth/switch-tenant' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -d '{"tenantId":"123e4567-e89b-12d3-a456-426614174000"}'

POST /auth/switch-tenant

Switch Active Tenant

Request body

Responses

Try it

On this page