Skip to main content
POST
Add embed group members
πŸ”’ Admin only. Requires administrator privileges β€” the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Adds one or more embed users (1–1000 per request) to a group. Each member is identified by exactly one of externalId (the id passed to generate-session) or embedUserId (the numeric id this API returns). An externalId that has never signed in is provisioned as an embed user, so groups can be populated ahead of a user’s first session; an unknown embedUserId is a 404 instead. Memberships are added, never replaced: the user’s other groups β€” including the account-wide groups that drive data-model access β€” are left untouched. Idempotent: the response buckets every requested member into addedMembers or unchangedMembers.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

embedTenantName
string
required

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

id
integer
required

Numeric id of the group, as returned by the groups endpoints.

Body

application/json

EmbedGroupMembersInput

members
object[]
required

Embed users to add or remove (1–1000 per request).

Required array length: 1 - 1000 elements

Response

200 - application/json
addedMembers
object[]
required
unchangedMembers
object[]
required