List principals

List principals in an organization.

All principal types are supported.

Access control

Requires the caller to be logged into the target organization, or to be an admin in any of its the ancestor organizations.

Securityorg-oidc-token
Request
path Parameters
org
required
string (OrgId) [ 3 .. 64 ] characters ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

ID of an organization

Example: my-org
query Parameters
cursor
string

Cursor for paging through results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
limit
integer [ 1 .. 100 ]
types
string (PrincipalType)

Filter by principal types. If not specified, all principal types will be included. You can filter by multiple types by providing a comma-separated list, or by repeating the parameter.

Enum: "SERVICE_ACCOUNT" "USER"
Example: types=USER,SERVICE_ACCOUNT
Responses
200

A list of principals, with a cursor pointing to the next results page

get/api/v1/orgs/{org}/principals
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
➔ Next to Retrieve principals by reference