v1

latestOpenAPI 3.0.02026-07-249372139.7 KB

Users

Update User

Updates a single User

put/users/{UserID}

Path parameters

UserIDinteger required

ID of User

Request body

Emailstring

Usernamestring

FirstNamestring

LastNamestring

MfaFactorAuthboolean

ReceiveTechUpdatesboolean

Example request

{
  "Department": "Service Desk/NOC",
  "Email": "Steve.Roggers@contoso.com",
  "Username": "Steve.Roggers",
  "FirstName": "Steve",
  "LastName": "Roggers",
  "Groups": [
    {
      "ID": 85783,
      "Name": "Admin"
    }
  ],
  "MfaFactorAuth": true
}

Response

EnvironmentNamestring nullable

IDinteger

{"stackTrail":"components:schemas:Users:properties:Environment","oasType":"schema","type":"unknown","example":null,"nullable":true}

FirstNamestring

LastNamestring

Emailstring

Usernamestring

MfaFactorAuthboolean

Status'active' | 'invited'

Ownerboolean

Visibleboolean

Lockedboolean

LastLoginstring date-time

ReceiveTechUpdatesboolean

CreatedOnstring date-time

UpdatedOnstring date-time

Example response

[
  {
    "ID": 3,
    "FirstName": "Alex",
    "LastName": "Weber",
    "Email": "Alex.Weber@contoso.com",
    "Username": "Alex.Weber",
    "MfaFactorAuth": true,
    "Status": "active",
    "Visible": true,
    "LastLogin": "2021-07-22T14:47:36.286Z",
    "Department": "Other",
    "CreatedOn": "2021-07-22T14:47:36.286Z",
    "UpdatedOn": "2021-07-22T14:47:36.286Z",
    "Preferences": {
      "ColorTheme": {
        "name": "Light Mode",
        "cssClass": "light-mode"
      }
    },
    "Groups": [
      {
        "ID": 85783,
        "Name": "Manager",
        "EnvironmentName": "Contoso Nation"
      }
    ],
    "CreatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    },
    "UpdatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    }
  }
]