CreateUser

Create a User

application/json

Request Body

• users object[] required

  fullName string

  Used to provide a name to the new user.

  name string

  Used to provide the new user with a username. This username can be used for logging in the user instead of email-id when duplicate email-ids are present. For external user, it is necessary to provide the domain name along with the username (domainName\username). To create a company user, the company id or name needs to be provided in the company entity.

  externalProviderId int32

  Please provide this entity only when creating an AD user. Not needed for local and company users.

  email string required

  Used to provide an email-id to the new user. This email-id is used for logging in the user. Please note that email ids are compulsory for company and local users and optional for external users.

  company object

  id int32

  name string

  userGroups object[]

  Provide a list of userGroups that the user should be a part of. Either id or name or both can be provided.

  id int32

  name string

  useSystemGeneratePassword boolean

  Choose to provide a system generated password to the user instead of providing your own password. An email will be sent to the user to reset the password. If it is set to true, password tag need not be provided. If it is set to false, password needs to be provided in the password tag in Base64 format.

  password string

  Used to provide a password to the user being created. This will be accepted when the useSystemGeneratePassword tag is false. The password has to be provided in Base64 format.

  inviteUser boolean

  User will receive an email to install backup software package on their device if this is set to true.

  plan object

  id int32

  name string

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• users object[]

  id int32

  GUID string

  name string

{
  "users": [
    {
      "id": 0,
      "GUID": "string",
      "name": "string"
    }
  ]
}

Bad Request

Internal Server Error

POST /v4/user    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/user' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "fullName": "string",
      "name": "string",
      "externalProviderId": 0,
      "email": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "useSystemGeneratePassword": true,
      "password": "string",
      "inviteUser": true,
      "plan": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}'