Workspaces

Switch to an assigned Workspace

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Authenticate.Workspace` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Switch to an assigned Workspace and receive an authentication token for the target Workspace. <Note> This endpoint requires authentication with [user credentials](/developers/auth/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. </Note>

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