User and group identifiers
Created by zengenti, last modified by s.yearsley on 24 Sep 2020
For convenience, User and Group resources can be identified by using one of several identifiers.
For example, a User can be identified by Username, Id or Email Address. A Group can be identified by Name or Id.
A combination of identifiers can be used if an endpoint requires both types of resource.
Available User identifiers
| Identifier | Format | Description |
|---|---|---|
| Id | UUID | The user Id |
| Username | string | The user username |
| Email address | string | The user email in valid email format |
Available Group identifiers
| Identifier | Format | Description |
|---|---|---|
| Id | Guid | The group Id |
| Name | string | The group name |
Example requests
User requests
GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01GET: /api/security/users/tdurdenGET: /api/security/users/t.durden@fightclub.comGroup requests
GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01cGET: /api/security/groups/Paper%20Street%20Soap%20CompanyCombination requests
HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/9f02a3d1-d8eb-4b10-8ed6-293a11d5201fHEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/tdurdenHEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/tdurden@fightclub.comHEAD: /api/security/groups/Paper%20Street%20Soap%20Company/users/3d063773-2ca9-4baf-90e1-ed674fa68640