Skip to navigation
WorkspacesSwitch to an assigned Workspace

Switch to an assigned Workspace

Required permissions Beta Learn more

Authenticate.Workspace + Get

Roles: Administrator User Observer

Switch to an assigned Workspace and receive an authentication token for the target Workspace.

This endpoint requires authentication with user credentials (not an application token), as application tokens are scoped to a single Workspace.

The returned auth_token is valid for the target Workspace. Your original token remains valid for the source Workspace.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.
target_organisationobjectRequired

Response

Successfully switched to the assigned Workspace
auth_tokenstringOptional
JWT authentication token valid for the target Workspace

Errors

401
Unauthorized Error
403
Forbidden Error