Create a new user

Creates a new user account with role and contact details.

Endpoints

post /emsapi/users

Copy full URL

Request URL

https://{server-hostname}:8383/emsapi/users

Scope

Admin.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

- Request Body

application/json

JSON object

Hide Sub-Attributes

authTypestringOptional

Authentication mode for the user (e.g., localAuthentication).

languagestringOptional

User locale identifier.

probeScopeTypeintegerOptional

Probe scope type for summary/probe configuration.

deviceScopeTypeintegerOptional

Device scope type for MDM access control.

remoteOfficeGroupsarrayOptional

List of remote office group identifiers for user scope.

roleIDlongOptional

Role identifier to assign to the user.

userNamestringOptional

Username for the new user.

mailIDstringOptional

Email address for the user.

phoneNumberstringOptional

Phone number for the user.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/emsapi/users \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"phoneNumber":"22222676","probeScopeType":1,"roleID":4,"deviceScopeType":0,"language":"en_us","mailID":"alex.morgan@example.com","remoteOfficeGroups":[],"authType":"localAuthentication","userName":"alex.morgan"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/emsapi/users"))
        .header("content-type", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"phoneNumber\":\"22222676\",\"probeScopeType\":1,\"roleID\":4,\"deviceScopeType\":0,\"language\":\"en_us\",\"mailID\":\"alex.morgan@example.com\",\"remoteOfficeGroups\":[],\"authType\":\"localAuthentication\",\"userName\":\"alex.morgan\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"phoneNumber\":\"22222676\",\"probeScopeType\":1,\"roleID\":4,\"deviceScopeType\":0,\"language\":\"en_us\",\"mailID\":\"alex.morgan@example.com\",\"remoteOfficeGroups\":[],\"authType\":\"localAuthentication\",\"userName\":\"alex.morgan\"}"

headers = {
    'content-type': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/emsapi/users", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("authType","value");
    data.put("language","value");
    data.put("probeScopeType","1");
    data.put("deviceScopeType","1");
    data_remoteOfficeGroups=List();
    data_remoteOfficeGroups.add("1");
    data.put("remoteOfficeGroups",data_remoteOfficeGroups);
    data.put("roleID","1");
    data.put("userName","value");
    data.put("mailID","value");
    data.put("phoneNumber","value");

    response = invokeUrl
    [
        url: "https://appDomain/emsapi/users"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/emsapi/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"phoneNumber":"22222676","probeScopeType":1,"roleID":4,"deviceScopeType":0,"language":"en_us","mailID":"alex.morgan@example.com","remoteOfficeGroups":[],"authType":"localAuthentication","userName":"alex.morgan"}'

▼ Show full

Sample Request Body

Create a local user with role, email, and scope settings.

Copied!

  {
    "phoneNumber": "22222676",
    "probeScopeType": 1,
    "roleID": 4,
    "deviceScopeType": 0,
    "language": "en_us",
    "mailID": "alex.morgan@example.com",
    "remoteOfficeGroups": [],
    "authType": "localAuthentication",
    "userName": "alex.morgan"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

mailStatusboolean

Indicates whether the invitation or activation email was sent successfully.

domainNamestring

Domain name for the user. Local users are represented as 'local'.

userNamestring

Username of the created user.

loginIdstring

Unique login identifier for the newly created user.

securityAdvisoryCodestring

Security advisory code returned after user creation.

metaJSON object

Metadata related to the user creation.

Show Sub-Attributes

userCountinteger

Total user count after creation.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

User creation succeeds and returns login identity with metadata.

Copied!

  {
    "loginId": "302",
    "securityAdvisoryCode": "SAC001",
    "meta": {
      "userCount": 3
    },
    "domainName": "local",
    "mailStatus": true,
    "userName": "alex.morgan"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.