Sign in

v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
User management

Update user access to Rudder

Rename, change password (pre-hashed or not) and change permission of an user. If a parameter is empty, it will be ignored.

post/usermanagement/update/{username}

Path parameters

usernamestring required
Example:JaneDoe

Username of an user (unique and must not contain whitespace)

Request body

usernamestring required

A new username or an empty string to ignore the update of username.

passwordstring required

This password will be hashed for you if the isPreHashed is set on false. Empty string means that no update is requested.

permissionsstring[] required

Roles or authorizations

isPreHashedfalse | true required

If you want to provide hashed password set this property to true otherwise we will hash the plain password and store the hash

Example request

{
  "username": "johndoe",
  "password": "passwdWillBeStoredHashed",
  "permissions": [
    "admin"
  ]
}

Response

Updated

result'success' | 'error' required

Result of the request

action'updateUser' required

The id of the action

Example response

{
  "data": {
    "updatedUser": {
      "username": "johndoe",
      "password": "secret_password",
      "permissions": [
        "inventory"
      ]
    }
  }
}