POST api/users

Create a user

Request Information

URI Parameters

None.

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": "386f6792-e8bf-4518-baa2-c51b4037215c",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "28c728bc-80cc-4904-8cff-d1bb48b9f9b1",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "28c728bc-80cc-4904-8cff-d1bb48b9f9b1",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "28c728bc-80cc-4904-8cff-d1bb48b9f9b1",
        "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": "63634dc7-986e-490c-b0f1-6a0cdccf10e9",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "IsActive": true,
  "Customer": {
    "Id": "3f36ecdc-92af-4703-8364-e8a2bb5c355a",
    "Name": "sample string 2"
  },
  "Roles": [
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "3f36ecdc-92af-4703-8364-e8a2bb5c355a",
        "Name": "sample string 2"
      },
      "IsActive": true
    },
    {
      "Role": "Viewer",
      "CustomerGroup": {
        "Id": "3f36ecdc-92af-4703-8364-e8a2bb5c355a",
        "Name": "sample string 2"
      },
      "IsActive": true
    }
  ]
}