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": "e4c389ac-7f74-47ed-9e59-3d542e98594d",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "abc2ada5-a3e6-41a6-8881-6be542432ef7",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "abc2ada5-a3e6-41a6-8881-6be542432ef7",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "abc2ada5-a3e6-41a6-8881-6be542432ef7",
        "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": "0fa5a844-ab49-49c3-8c6a-bde0f2a4421d",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "9de448b8-12d9-4770-b888-18be0bc8921f",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "9de448b8-12d9-4770-b888-18be0bc8921f",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "9de448b8-12d9-4770-b888-18be0bc8921f",
        "Name": "sample string 2"
      },
      "IsActive": true
    }
  ]
}