Skip to main content
Use the user management API to provision, update, and remove workspace and project members from an identity provider, an HR system, or a script. You invite people to a workspace, add them to projects, change their roles, and remove them when they leave.

Prerequisites

  • A workspace platform key (abl_ws_…). A workspace Owner or Admin creates it under Settings > Secrets > Platform Keys. Project endpoints also accept a project platform key bound to that project.
  • The scopes that the endpoints you call need: workspace.members.read, workspace.members.write, workspace.roles.read, project.members.read, or project.members.write. A missing scope returns 403 INSUFFICIENT_SCOPE.
  • The workspace ID or project ID that you manage.
Send the key in the X-API-Key header or as Authorization: Bearer <key>. The API rejects user session tokens and SDK tokens with 401.

Workflow and use cases

  1. List the workspace roles and project roles. Use assignableByCaller to see which roles your key can assign.
  2. List the workspace projects to get project IDs.
  3. Invite people to the workspace. Each person starts as pending and gets access after they accept and sign in.
  4. Add active workspace members to projects with a project role.
  5. Look up, update, or apply lifecycle actions to members as their access changes.
  6. Remove members from projects or the workspace when they leave.

List of endpoints

Behavior and limits

  • A key can assign only builtin.workspace.restricted_member and builtin.workspace.workbench_manager at workspace level. At project level it can assign builtin.project.developer, builtin.project.tester, builtin.project.viewer, and builtin.project.workbench_manager. Owner, Admin, Auditor, and custom roles are never assignable by a key.
  • Batch endpoints accept up to 100 items. They return 201 when every item succeeds and 207 when any item fails. Each item carries its own outcome.
  • Send an Idempotency-Key header on every write so a retry replays the first result. Send the ETag from your last read in If-Match on updates to avoid overwriting concurrent changes.
  • Every response carries an X-Request-Id header. Quote it to Kore.ai Support.
  • Responses use the envelope { "success": true, "data": … } or { "success": false, "error": { "code", "message", "details" } }.
  • Per key, the limits are 300 reads per minute, 60 writes per minute, 300 removals per minute, and 5 requests in flight. Exceeding a limit returns 429 with a Retry-After header.
  • Invitation emails are limited to 500 per hour for each workspace and 3 per address in 24 hours.