Organization membership, role assignment, and member search.
GET
/org/membersSearch members
Returns a filtered list of organization members matching the search criteria, including their profiles and role assignments.
Parameters
pageinteger
page
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
Type
integer
Format
"int32"Minimum
1Default
1limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100sortBystring
sortBy
The field to sort by.
Type
string
Valid values
"name""email"Default
"name"sortDirectionstring
sortDirection
The direction to sort (ascending or descending).
Type
string
Valid values
"asc""desc"Default
"asc"filterobject
filter
Filter criteria for members
Type
object
Responses
Responses
A paginated list of organization users with details is returned.
application/json
JSON "total": 0, "items": [ { "memberId": "A1B2C3D4E5", "userId": "A1B2C3D4E5", "roleIds": [ "string" ], "teamRoleIds": { "additionalProperties": [ "string" ] } } ], "included": { "members": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "userId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "preferences": { }, "invitedByMemberId": "A1B2C3D4E5", "inviteExpiresAt": "string", "inviteAcceptedAt": "string", "lastLoginAt": "string", "lastActiveAt": "string", "isEnabled": true, "accountType": "managed", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "users": [ { "user": { "id": "A1B2C3D4E5", "email": "alice@example.com", "givenName": "string", "familyName": "string", "displayName": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "emails": [ { "userId": "A1B2C3D4E5", "email": "alice@example.com", "verifiedAt": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "auth": { "has2FA": true, "hasPassword": true, "hasRecovery": true } } ], "roles": [ { "role": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "description": "string", "allTeams": true, "breakGlass": true, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "memberCount": 0, "permissionCount": 0 } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "teamRoles": [ { "role": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "description": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "memberCount": 0, "permissionCount": 0 } ], "_entityRelations": { "memberId": "A1B2C3D4E5", "organizationRoleId": "A1B2C3D4E5", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "id": "A1B2C3D4E5", "teamId": "A1B2C3D4E5", "isAutomatic": true, "memberTeamId": "A1B2C3D4E5", "teamRoleId": "A1B2C3D4E5" } }
{
}
GET
/org/members/{member}Describe an organization member
Returns the full details of an organization member, including their profile, assigned roles, and team memberships.
Responses
Responses
Organization user details retrieved successfully
application/json
JSON "item": { "memberId": "A1B2C3D4E5", "userId": "A1B2C3D4E5", "roleIds": [ "string" ], "teamRoleIds": { "additionalProperties": [ "string" ] } }, "included": { "members": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "userId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "preferences": { }, "invitedByMemberId": "A1B2C3D4E5", "inviteExpiresAt": "string", "inviteAcceptedAt": "string", "lastLoginAt": "string", "lastActiveAt": "string", "isEnabled": true, "accountType": "managed", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "users": [ { "user": { "id": "A1B2C3D4E5", "email": "alice@example.com", "givenName": "string", "familyName": "string", "displayName": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "emails": [ { "userId": "A1B2C3D4E5", "email": "alice@example.com", "verifiedAt": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "auth": { "has2FA": true, "hasPassword": true, "hasRecovery": true } } ], "roles": [ { "role": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "description": "string", "allTeams": true, "breakGlass": true, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "memberCount": 0, "permissionCount": 0 } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "teamRoles": [ { "role": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "description": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "memberCount": 0, "permissionCount": 0 } ], "_entityRelations": { "memberId": "A1B2C3D4E5", "organizationRoleId": "A1B2C3D4E5", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "id": "A1B2C3D4E5", "teamId": "A1B2C3D4E5", "isAutomatic": true, "memberTeamId": "A1B2C3D4E5", "teamRoleId": "A1B2C3D4E5" } }
{
}
DELETE
/org/members/{member}Remove a member
Removes a user from the organization and revokes all their assigned roles and team memberships.
The last Owner of the organization cannot be removed.
Responses
Responses
The requested operation was done successfully.
PATCH
/org/members/{member}Update a member
Modifies an organization member's profile information such as their display name.
Request Body
application/json
JSON "name": "string", "email": "alice@example.com", "preferences": { }, "invitationToken": "string", "isEnabled": true
{
}
Responses
Responses
The updated organization user.
application/json
JSON "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "userId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "preferences": { }, "invitationToken": "string", "invitedByMemberId": "A1B2C3D4E5", "inviteExpiresAt": "string", "inviteAcceptedAt": "string", "lastLoginAt": "string", "lastActiveAt": "string", "isEnabled": true, "accountType": "managed", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
PUT
/org/members/{member}/rolesUpdate member roles
Replaces all organization roles for a member with the provided list.
At least one role must be provided; to remove a member entirely use the
remove-member endpoint instead.
The last Owner of the organization cannot have their Owner role removed.
Request Body
application/json
JSON "roleIds": [ [ "ROLE123", "ROLE456" ] ]
{
}
Responses
Responses
The requested operation was done successfully.