Skip to main content
Browse Documentation
HTTP - Management

Get a user

Created by s.yearsley, last updated 25 Sep 2020

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

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

Get a user resource by their username

GET: /api/security/users/tdurden

Get a user resource by their email

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

Responses

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