Skip to main content
Browse Documentation

User and group identifiers

Created by zengenti, last updated 25 Jun 2021

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-e8ee5047b01
GET: /api/security/users/t.durden
GET: /api/security/users/t.durden@fightclub.com

Group requests

GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c
GET: /api/security/groups/Paper%20Street%20Soap%20Company

Combination requests

HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/9f02a3d1-d8eb-4b10-8ed6-293a11d5201f
HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/t.durden
HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/t.durden@fightclub.com
HEAD: /api/security/groups/Paper%20Street%20Soap%20Company/users/3d063773-2ca9-4baf-90e1-ed674fa68640
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.