ROCKITPLAY API

Modify user

Developing

PATCH

https://Example-Server.com/be/v1/users

Last modified:2025-05-08 12:00:04

This endpoint allows to modify a user in your ROCKIT Edge Organization. You can modify the following fields:

email

firstname

surname

title

You can also change the password of your own user, by providing the old password and a new password.

oldPW

newPW

A user with full resource user permission, can reset the password by just setting a new one with:

resetCreds

Required Permissions

users.update or being the user itself.

See Roles for more details.

Request

Header Params

x-rockit-beauth-token

string

optional

Example:

x-rockit-orgname

string

optional

Example:

x-rockit-username

string

optional

Example:

adminPrincipal

x-rockit-api-key

string

optional

Example:

Body Params application/json

username

string

required

Required to identify the user whose data should be updated.

title

string

optional

Optional title for the user (e.g., "Mr", "Dr", etc.).

firstname

string

optional

First name of the user.

surname

string

optional

Last name of the user.

string

optional

Email address of the user.

oldPW

string

optional

Required if newPW is provided and the requester does not have write permissions on users. Used to verify identity before changing password.

newPW

string

optional

New password to set. Requires oldPW unless requester has write permissions on users. The new password needs to be in this format: /^(?=.?[A-Z])(?=.?[a-z])(?=.?[0-9])(?=.?[#?!@

resetCreds

boolean

optional

Reset the password. Responds with a new generated password. Requires user.update permission.

roles

string

optional

Array of Roles which the machine account should be associated with.

Example

{
  "username": "exampleName",
  "title": "newtitle",
  "firstname": "newFirstname",
  "surname": "newSurname",
  "email": "newEmail",
  "oldPW": "oldPassword",
  "newPW": "newPassword"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://Example-Server.com/be/v1/users' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "username": "exampleName",
  "title": "newtitle",
  "firstname": "newFirstname",
  "surname": "newSurname",
  "email": "newEmail",
  "oldPW": "oldPassword",
  "newPW": "newPassword"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

🟠400Invalid Param

🟠401Unauthorized

list users

delete users

Modify user

Required Permissions#

Request

Request samples

Responses

Required Permissions