PUT api/users/{id}

Update a user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

UserDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

Email

string

Required

IsActive

boolean

None.

Customer

NamedItem

None.

Roles

Collection of UserRoleDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "734f7e20-98ff-4d2b-ae24-63f5777103bf",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "d8185638-c0f3-41c7-964b-fc0285b9194e",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "d8185638-c0f3-41c7-964b-fc0285b9194e",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "d8185638-c0f3-41c7-964b-fc0285b9194e",
        "Name": "sample string 2"
      },
      "IsActive": true
    }
  ]
}

Response Information

Resource Description

UserDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

Email

string

Required

IsActive

boolean

None.

Customer

NamedItem

None.

Roles

Collection of UserRoleDto

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "8f72604e-ae1b-4308-aeb1-dc2cf39d5b13",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "6c9df4af-5dae-4a45-928d-f5ea30028c08",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "6c9df4af-5dae-4a45-928d-f5ea30028c08",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "6c9df4af-5dae-4a45-928d-f5ea30028c08",
        "Name": "sample string 2"
      },
      "IsActive": true
    }
  ]
}