Provision embed users in bulk
Embed Tenants
Provision embed users in bulk
POST
Provision embed users in bulk
🔒 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.
Provisions up to 100 embed users in one request, each exactly as
POST /embed-tenants/{embedTenantName}/user would. Use it to load a user directory into an embed tenant, and send further requests to cover a directory larger than one batch.
This endpoint is partially successful. It returns 200 whenever the request itself is well formed, and reports each user separately:
succeeded— the users that were provisioned, in the order requested.failed— the entries that were not, each with theexternalIdand anerrorcarrying thestatusandmessagethe single-user endpoint would have returned (400for a group name that does not exist,429once the tenant is at its embed-user limit).
externalId within one batch is applied once per entry, so the last one wins.Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Name of the embed tenant (the embedTenantName used to generate embed sessions).
Body
application/json
ProvisionEmbedUsersInput
Embed users to provision (1–100 per request).
Required array length:
1 - 100 elements