...
- Principal names are are unique across all users and teams (a team cannot have the same principalName as a user or vice versa).
- Principal Name uniqueness is case-insensitive. However, when a principal name is set for a user or a team, the original case will be preservers and displayed (i.e. "JaneSmith" can be used as a principal name, however, it will not be possible to later create a principal name "janesmith" as it would collide with the case-insensitive version of "JaneSmith".
- User principal names cannot be changed once they are issued. The only exception to this rule is if the principal name is flag as "requires change" by an administrator.
- Team principal names are mutable.
- User principal names are limited at alpha-numeric characters (a-z,0-9) and the following characters: '.','-','_'. Howerver, only the alpha-numeric characters contribute to the uniqueness so "jane.smith" and "janesmilth" will be interpreted as the same name.
- Team names can contain the same characters as users with the addition of spaces. Howerver, only the alpha-numeric characters contribute to the uniqueness so "Best Team Ever" and "bestteamever" will be interpeted as the same name.
Principal Look-up
We will also be added a new services that can be used to look-up principals (we will be removing the old service GET /userGroupHeaders):
...
| Name | Description | Optional |
|---|---|---|
| limit | Standard pagination parameter to limit the number of results | false |
| offset | Standard pagination parameter to control page offest | false |
| prefixnameFilter | Filter by all principalNames, firstNames, or lastNames, that start with this nameFilter. The "exactNameOnly" parameters determines if this is a prefix or exact match filter. | true |
| exactNameOnly | Used to limit the name filter to an exact match only. When set to TRUE, only names that match "nameFilter" exactly will be returned. When set to FALSE (or excluded), all names that match the "nameFilter" exactly or with the the "nameFilter" prefix will be returned. | 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. | true |
| 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 |
...