POST /v1/users — admin-api-nhs-innovation-service

Create a user.

post/v1/users

Request body

namestring required

Name of the user.

emailstring email required

Email of the user.

strategicRolesstring[]

Strategic roles to be assigned to the user.

role'ADMIN' | 'ASSESSMENT' | 'ACCESSOR' | 'QUALIFYING_ACCESSOR' required

Role of the user.

organisationIdstring uuid required

Id of the organisation.

unitIdsstring[] required

Ids of the organisation units.

Response

The user has been created.

idstring uuid required

Changes

Changed in 6 of the 50 revisions of this API.558

Jan 8, 20261a84c9639e0b1See the full diff
- ○
  added the new optional request property strategicRoles
  new-optional-request-property
Nov 7, 2024bf0b42ebdc021See the full diff
- ○
  the response property id became required for the status 201
  response-property-became-required
Aug 24, 20233419337bcb8a11See the full diff
- ▲
  removed the success response with the status 200
  response-success-status-removed
- ○
  added the success response with the status 201
  response-success-status-added
Aug 24, 20236ddeb2c9e28d11See the full diff
- ▲
  removed the success response with the status 201
  response-success-status-removed
- ○
  added the success response with the status 200
  response-success-status-added
Aug 24, 202375f7a3d8a09e11See the full diff
- ▲
  removed the success response with the status 200
  response-success-status-removed
- ○
  added the success response with the status 201
  response-success-status-added
Aug 22, 20232b43f8cf5d91253See the full diff
- ▲
  the request property role became not nullable
  request-property-became-not-nullable
- ▲
  the request property role became required
  request-property-became-required
- ●
  the email request property's maxLength was set to 100
  request-property-max-length-set
- ●
  the name request property's maxLength was set to 100
  request-property-max-length-set
- ●
  removed the request property organisationAcronym
  request-property-removed
- ●
  removed the request property organisationUnitAcronym
  request-property-removed
- ●
  removed the request property type
  request-property-removed
- ○
  added subschema #1 to the request body oneOf list
  request-body-one-of-added
- ○
  added the new ADMIN enum value to the request property role
  request-property-enum-value-added
- ○
  added the new ASSESSMENT enum value to the request property role
  request-property-enum-value-added

Full history