user

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/users in the new API; the migration guide has the recommended order of work and the important model differences.

Legacy /rest/config/user was an upsert (create-or-update by userRef). The new API splits this into POST /v1/users (create) and PATCH /v1/users/{id} (update); pick the appropriate one based on whether the user already exists.

Open POST /v1/users in the new API →

View legacy reference

/rest/config/user

POST

This API adds or updates a User.

• User will be associated to all the Clients linked to the specified Client Group Id unless the User Type is Client user type then the user will only be associated to the Client specified.
• Not all fields required on update.  Only fields populated will be updated.

acceptable request representations:

• application/json

{    "userRef":"",    "clientGroupId":"32",    "userTypeId":"12",    "userId":"bob@bigco.com",
    "status":"1",
    "forename":"Bob",
    "surname":"Brisco",
    "clientId":"",
    "supplierId":"",
    "defaultClientId":"",
    "defaultSupplierId":"",
    "workGroupId":"",
    "workGroupPermission":"",
    "siteGroupId":"",
    "password", "XJA2392kmxjAL"}

available response representations:

• 200 - application/json

{
     "userRef":"34",
}

Filed Specification

Rest API Field Specification - User

Rest API Field Specification - User

Open Rest API Field Specification - User

See the Config API matrix for the full list of endpoints in this category.