Sign in

v1

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

Creates a new user

Creates a new user in cognito

post/users

Request body

forenamestring required
lastnamestring required
emailstring required

Example request

{
  "forename": "bob",
  "lastname": "bobbings",
  "email": "email@ons.gov.uk"
}

Response

The user is created

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"
}