Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23231323.7 KB
Users

Get a user

Gets the details of a user from the user pool

get/users/{id}

Path parameters

idstring required

the users id

Response

The users details

idstring

The users id

forenamestring

The users forename

surnamestring

The users surname

emailstring

The users email address

groupsstring[]

The groups the user belongs to

activeboolean

Whether or not the user is active

status_notesstring

Notes about the updates made to the user

status'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD'

The current status of the user

Example response

{
  "status_notes": "User has been suspended",
  "status": "CONFIRMED"
}