Skip to main content
Skip table of contents

Update user (single user parameter)

Read this page before using this guide.

Update a user using a HTTP PUT request.

Resource URL:



Request header parameters

Authorisation is required.

Request parameters

The username parameter is mandatory. If this is not included, the request will fail.

The request body is the example shows how to update a single user parameter, in this case the family_name.

Use the request example on this page as a reference.

The request example does not include all possible parameters.


Security-sensitive fields may not be returned in the response.

Refer to the Response codes guide for more information.

Example request

Request URL example


Request body

    "username": "test-user",
    "family_name": null
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.