Users

Update a user account

Superadmin-only. Update an existing user account with an optional password based authentication method.

put/api/v1/users/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/users/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The user id

Request body

tenantsstring[]
groupsstring[]
firstNamestring
lastNamestring
emailstring required
passwordstring
superAdminboolean
restrictedboolean

Response

updateUser 200 response

idstring
usernamestring
displayNamestring
firstNamestring
lastNamestring
emailstring
superAdminboolean
restrictedboolean

Example response

{
  "firstName": "firstName",
  "lastName": "lastName",
  "tenants": [
    {
      "name": "name",
      "id": "id"
    },
    {
      "name": "name",
      "id": "id"
    }
  ],
  "displayName": "displayName",
  "auths": [
    {
      "name": "name",
      "id": "id",
      "type": "type"
    },
    {
      "name": "name",
      "id": "id",
      "type": "type"
    }
  ],
  "restricted": true,
  "groups": [
    {
      "tenantId": "tenantId",
      "id": "id"
    },
    {
      "tenantId": "tenantId",
      "id": "id"
    }
  ],
  "id": "id",
  "superAdmin": true,
  "email": "email",
  "username": "username"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.