List unified view of users and invitations in an organization
Path parameters
Organization ID or label identifier
Organization ID or label
Query parameters
Fields to expand in the response. Supports "permissions" to include the permissions field with the caller's permissions for the resource. For list organization identities only, "total_count" populates pagination.total_count with the number of identities matching the same filters as the list (excluding cursor and limit). Other operations ignore expand values they do not use.
Search identities by email substring (case-insensitive)
User's role in the organization
Filter identities by role
Pagination cursor for navigating through results
Cursor for forward pagination
Pagination cursor for navigating through results
Cursor for backward pagination
Maximum number of identities to return
Headers
Unique request identifier specified by the originating caller and passed along by proxies.
Response
List of organization identities (users and invitations)
Example response
{
"items": [
{
"id": "ab3def8hij2klm9opq5rst7uvw",
"permissions": {
"organizations": {
"read": true,
"update": true
},
"users": {
"read": true,
"list": true
}
}
}
],
"permissions": {
"organizations": {
"read": true,
"update": true
},
"users": {
"read": true,
"list": true
}
}
}Changes
Changed in 4 of the 23 revisions of this API.119
- ○
added the enum value
total_countto the propertyitems/of thequeryrequest parameterexpand[]request-parameter-property-enum-value-added
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
- ○
added the new optional
queryrequest parameterquery[email]new-optional-request-parameter
- ○
- ○
the endpoint scheme security
OAuth2was added to the APIapi-security-added
- ○
the endpoint scheme security
bearerAuthwas added to the APIapi-security-added
- ○
the endpoint scheme security
org-management_bearerAuthwas removed from the APIapi-security-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
added to the
//response propertyoneOflist for the response statusresponse-property-one-of-added
- ●
deleted the
headerrequest parameterX-Request-IDrequest-parameter-removed
- ○
the endpoint scheme security
org-management_bearerAuthwas added to the APIapi-security-added
- ○
the endpoint scheme security
svc-org-management_bearerAuthwas removed from the APIapi-security-removed
- ○
removed from the
//response propertyoneOflist for the response statusresponse-property-one-of-removed
This revision also has 82 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲