Sign in
Embed Tenants

Provision an embed user

post/api/v1/embed-tenants/{embedTenantName}/user

Path parameters

embedTenantNamestring required

Name of the embed tenant (the embedTenantName used to generate embed sessions).

Request body

emailstring email nullable

Email address, shown wherever the user is listed and searchable through GET /embed-tenants/{embedTenantName}/users. Must be a valid address, and is stored lowercased. Omit it and Cube derives a synthetic {externalId}@cubecloud.dev placeholder instead, which is what makes a user hard to recognise in a list. Supplying it again later updates the stored address.

externalIdstring required

The id your own system knows this user by — the same externalId you will pass to generate-session. Trimmed and lowercased before it is stored, so casing never produces a second user.

groupsstring[] nullable

Global, account-wide groups (the groups field of generate-session) that gate data-model access. They must already exist. Supplying the field REPLACES the user’s global groups; omit it to leave them untouched, pass [] to clear them.

tenantGroupsstring[] nullable

Groups belonging to this embed tenant (the tenantGroups field of generate-session), which scope content sharing and organization within the tenant. Create them first via POST /embed-tenants/{embedTenantName}/groups. Supplying the field REPLACES the user’s tenant groups; omit it to leave them untouched, pass [] to clear them.

Response

emailstring nullable
externalIdstring nullable
firstNamestring nullable
idinteger required
usernamestring required

Changes

Changed in 1 of the 10 revisions of this API.1