Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionOptional
limitStandard pagination parameter to limit the number of resultsfalse
offsetStandard pagination parameter to control page offestfalse
prefixFilter by all principalNames, firstNames, or lastNames, that start with this prefixtrue
principalTypeUsed 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 listedtrue
domainTypeUsed 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
nameTypeUsed 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

...