Endpoints for querying, managing, and retrieving statistics and quotas for organization members.
Query parameters:
Response example:
Request example:
Response example:
Create a new user and add the user to the organization. This endpoint creates new accounts only. If the email is already registered, the existing account is not reused and its password is not changed.
Request body:
Request example:
Response example:
The endpoint may return
Request example:
Response example:
Request example:
Returns HTTP 204 No Content on success.
Request example:
Response example:
Request body:
Response example:
Request body:
Response example:
Request body:
Each request accepts 1–100 non-empty member IDs and applies the same cap to every member.
Response example:
List members
| Parameter | Type | Description |
|---|---|---|
userId | string | Exact user UUID lookup; cannot be combined with email |
email | string | Exact match on email address |
includeDeleted | boolean | Include deleted members; defaults to false |
maxResults | integer | Items per page; default 20, max 100 |
nextToken | string | Pagination cursor |
userId must be a non-empty standard UUID. Exact lookup by userId or email returns at most one member and does not return a new nextToken. If no member matches, the API returns 200 OK with an empty members array.
Request example:
Member status values
| Status | Description |
|---|---|
ENABLED | Active |
DISABLED | Disabled |
UNACTIVATED | Not yet activated |
APPROVE_PENDING | Pending approval |
APPROVE_DECLINED | Approval declined |
DELETED | Deleted |
Get member details
Create a member
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | New user email. Its domain must be verified and enabled for the organization |
name | string | Yes | User and member display name |
password | string | Yes | Initial password. It must meet the password-strength requirements and is never returned |
role | string | No | org_member or org_admin; defaults to org_member |
InvalidParameter, InvalidPassword, InvalidRole, EmailDomainRequired, EmailDomainNotSupported, or InsufficientSeats (HTTP 400), or EmailAlreadyExists (HTTP 409).
Member statistics
| Field | Description |
|---|---|
totalMembers | Total number of members |
billableMembers | Number of billable members |
adminMembers | Number of administrators |
purchasedSeats | Total purchased seats |
remainingSeats | Available seats |
Delete a member
Get member quota
| Field | Description |
|---|---|
planQuota | Quota from the subscription plan |
resourcePackageQuota | Quota from resource packages |
totalQuota | Total available quota |
sharedQuota | Shared pool quota |
Batch get member quotas
memberIds: Array of member IDs (1–100 items).
Update member Add-On Cap
addOnCap accepts a non-negative integer, null, or omission. null or omission means unlimited; 0 disables the quota.
Request example:
Batch update Add-On Cap
addOnCap accepts a non-negative integer, null, or omission; null or omission means unlimited.
Request example:
previousAddOnCap is omitted when the member was previously unlimited. Request validation may return InvalidBatchAddOnCapRequest, EmptyMemberIDs, TooManyMemberIDs, EmptyMemberIDAtIndex, or InvalidAddOnCapFormat.