Return to default tenant

DELETE

/api/v1/tenant/switch

const url = 'http://localhost:3000/api/v1/tenant/switch?trigger=user';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url 'http://localhost:3000/api/v1/tenant/switch?trigger=user' \
  --header 'Authorization: Bearer <token>'

Ends the open switch. Not available to API keys.

Authorizations

bearer

Parameters

Query Parameters

trigger

string

Allowed values: user logout

Why the switch ends; recorded in the audit trail (default: user)

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

204

Returned to default tenant

400

No active tenant switch, or invalid trigger

403

Forbidden — caller lacks required permission, or the caller is an API key