MAmacrometa
Users

Modify User.

Update the data of an existing user.

Note: Requires administrator permissions if changing the email address.

patch/_api/user/{user}

Request

Path parameters

userstring string required

The id of the user.

Request body

activeboolean

If set to true, then the user is active.

passwdstring

The user password. The password must have at least 8 characters, one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*).

displayNamestring

The user name.

Example request

{
  "passwd": "P@55w0rd",
  "displayName": "joe",
  "newEmail": {
    "email": "example@xxx.com"
  }
}

Response

Successfully modified user.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. Falsefor this response.

tenantstring

The name of the tenant.

userstring

The id of the user.

displayNamestring

The username of the tenant.

emailstring

The email of this API key.

activeboolean

Active status the API key.

extraobject

A JSON object with extra user information.

Example response

{
  "code": 200,
  "tenant": "_mm",
  "user": "Ugr0xjYMS9y0eN5gBxSSmg",
  "displayName": "test1",
  "email": "test@foo.com",
  "active": true,
  "apikey": {
    "hash": "1467ad2eed8e823f5a5db74aacd716d2f87dc3dde2bced8799e3c07dcf1c88ee",
    "parent": "root"
  },
  "extra": {}
}

Changes

No recorded changes to this operation across all 1 revision of this API.