...
Name | Description | Optional |
---|---|---|
limit | Standard pagination parameter to limit the number of results | false |
offset | Standard pagination parameter to control page offest | false |
prefix | Filter by all principalNames, firstNames, or lastNames, that start with this prefix | true |
principalType | Used to limit results to only teams or users. When included, only principals of the provided type: <USERS, TEAMS> will be returned. When excluded all users and teams will be listed | true |
domainType | Used to limit users and teams associated with a given domain. When included only principals associated with the provided domain: <SYNAPSE, BRIDGE> will be returned. When excluded, users or teams from any domain will be listed. | tryetrue |
nameType | Used to limit prefix look-ups to a type of name. When included, the prefix filter will only be applied to names of the provided type: <PRINCIPAL_NAME, FIRST_NAME, LAST_NAME>. When excluded the prefix will be applied to all name types. | true |
...