Skip to main content
Browse Documentation
HTTP - Management

Get a user

Created by s.yearsley, last modified by zengenti on 17 Jun 2022

A user resource can be retrieved by any valid User Identifier

GET/api/security/users/{userIdentifier}

Parameter

NameParameter typeTypeFormatDescriptionExampleRequired
UserIdentifierpathstringuser identifierFor convenience, User resources can be referenced by using one of several identifiers - username, email address or Id."82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com"true

Examples

Get a user resource by their UUID

HTTP
GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c

Get a user resource by their username

HTTP
GET: /api/security/users/t.durden

Get a user resource by their email

HTTP
GET: /api/security/users/t.durden@fightclub.com

Remarks

Permissions

Members of System Administrators are permitted to get any user.

Authenticated standard user accounts are permitted to get their own user.

Responses

HTTP status codeReasonModel
200SuccessUser
401UnauthorizedError
403ForbiddenError
404User not foundError
500Internal server errorError