Update an embed group
Embed Tenants
Update an embed group
PATCH
Update an embed group
π 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.
Updates a groupβs description. The name is deliberately immutable: it is part of the security context an embed session carries (
system:tenant:{embedTenantName}:{name}), so renaming would silently detach the data-model access policies written against it β create a new group instead. Pass an empty description to clear it.Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Name of the embed tenant (the embedTenantName used to generate embed sessions).
Numeric id of the group, as returned by the groups endpoints.
Body
application/json
UpdateEmbedGroupInput
New description. Pass an empty string to clear it. Omit to leave it unchanged.
Maximum string length:
500