Retrieve principals by reference
Retrieve principals in an organization by ID or external ID.
Service accounts can be retrieved by ID or external ID. Users can be retrieved by ID.
Access control
Requires the caller to be logged into the target organization, or to be an admin in any of its the ancestor organizations.
Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Path Parameters
ID of an organization The ID of an organization
3 - 64^([a-z][a-z0-9-]{1,62}[a-z0-9])$"my-org"
Body
A request to retrieve principals by reference.
For now, only service accounts can have an external ID.
1 - 100 elementsEither a principal ID, or a principal external ID
- Option 1
- Option 2
If true, IDs that do not match existing principals will be ignored.
If false, the request will fail if any of the IDs do not match existing principals.
This is the default behavior.
Response
A list of principals.
A principal
- Option 1
- Option 2