Create User

Creates a new user, either End-User or Service User.

• End-User Accounts are assigned to employees. To create an end user account, the accountType field must be NORMAL.

• Service User Accounts are a type of account used for bots or applications, rather than end-users. To create a service user account, the accountType field must be SYSTEM.

See User Attributes, Password Object, and Roles Object for user creation parameters.

Create a new V2 User

POSTyourpodURL.symphony.com/pod/v2/admin/user/create

Header parameters

Body

application/json

userAttributesV2UserAttributes (object)

V2 User record.

passwordPassword (object)

Password. Stored as derived password in both the Pod and the Key Manager using PBKDF2 function. Number of iterations should be 10000 and desired length 256 bits.

rolesarray of string

Response

200400401403500

Success

Body

application/json

userAttributesV2UserAttributes (object)

V2 User record.

userSystemInfoUserSystemInfo (object)

User Status Information.

featuresIntegerList (array of integer (int64))

appsIntegerList (array of integer (int64))

groupsIntegerList (array of integer (int64))

rolesStringList (array of string)

disclaimersIntegerList (array of integer (int64))

avatarAvatar (object)

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v2/admin/user/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "userAttributes": {
    "emailAddress": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Company",
    "department": "Department",
    "division": "Division",
    "title": "Trader",
    "workPhoneNumber": "[phone]",
    "mobilePhoneNumber": "[phone]",
    "twoFactorAuthPhone": "[phone]",
    "smsNumber": "[phone]",
    "accountType": "NORMAL",
    "location": "New York",
    "recommendedLanguage": "english",
    "jobFunction": "Trader",
    "assetClasses": [
      "Equities"
    ],
    "industries": [
      "Healthcare",
      "Technology"
    ],
    "marketCoverage": [
      "EMEA"
    ],
    "responsibility": [
      "BAU"
    ],
    "function": [
      "Trade Processing"
    ],
    "instrument": [
      "Equities"
    ],
    "currentKey": {
      "key": "-----BEGIN PUBLIC KEY-----\\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\\n-----END PUBLIC KEY-----",
      "expirationDate": 1467562406219,
      "action": "SAVE"
    },
    "previousKey": {
      "key": "-----BEGIN PUBLIC KEY-----\\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\\n-----END PUBLIC KEY-----",
      "expirationDate": 1467562406219,
      "action": "SAVE"
    }
  },
  "userSystemInfo": {
    "id": 7215545078461,
    "status": "ENABLED",
    "suspended": true,
    "suspendedUntil": 1601546400,
    "suspensionReason": "The user will be OOO due to a mandatory leave",
    "createdDate": 1461508270000,
    "createdBy": "7215545057281",
    "lastUpdatedDate": 1461508270000,
    "lastLoginDate": 1461508270000,
    "lastPasswordReset": 1461508270000,
    "deactivatedDate": 1461508270000
  },
  "features": [
    1461508270000,
    7215545057281
  ],
  "apps": [
    1461508270000,
    7215545057281
  ],
  "groups": [
    1461508270000,
    7215545057281
  ],
  "roles": [
    "ftp",
    "mailto",
    "fdsup",
    "skype"
  ],
  "disclaimers": [
    1461508270000,
    7215545057281
  ],
  "avatar": {
    "size": "original",
    "url": "../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8.png"
  }
}

Request Examples

curl -X POST \
https://acme.symphony.com/pod/v2/admin/user/create \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{   
    "userAttributes": {
        "accountType": "NORMAL",
        "emailAddress": "[e-mail]",
        "firstName": "Jane",
        "lastName": "Doe",
        "userName": "janedoe",
        "displayName": "Jane Doe",
        "companyName": "",
        "department": "",
        "division": "",
        "title": "Sales",
        "twoFactorAuthPhone": "",
        "workPhoneNumber": "",
        "mobilePhoneNumber": "",
        "location": "San Francisco",
        "jobFunction": "Sales",
        "assetClasses": ["Commodities"],
        "industries": ["Basic Materials"],
        "marketCoverage": ["LATAM"],
        "responsibility": ["BAU"],
        "function": ["Trade Management"],
        "instrument": ["Securities"],
        "currentKey": {"key": "-----BEGIN PUBLIC KEY-----\nMIICIjAN...==\n-----END PUBLIC KEY-----"
}
        
    },
    "password": {
        "hSalt": "password",
        "hPassword": "password",
        "khSalt": "password",
        "khPassword": "password"
    }
}'

curl -X POST \
https://acme.symphony.com/pod/v2/admin/user/create \
-H "sessionToken: SESSION_TOKEN" -H "Content-Type: application/json" \
-d '{
  "userAttributes": {
    "accountType": "SYSTEM",
    "emailAddress": "[e-mail]",
    "userName": "apiuser",
    "displayName": "API User",
    "companyName": "Symphony",
    "department": "Client Application",
    "division": "Technology",
    "workPhoneNumber": "[phone]",
    "mobilePhoneNumber": "[phone]",
    "twoFactorAuthPhone": "[phone]",
    "recommendedLanguage": "english",
    "location": "Sophia Antipolis",
    "jobFunction": "Sales",
    "assetClasses": ["Commodities"],
    "industries": ["Basic Materials"],
    "marketCoverage": ["LATAM"],
    "responsibility": ["BAU"],
    "function": ["Trade Management"],
    "instrument": ["Securities"],
    "currentKey": {
        "key": "-----BEGIN PUBLIC KEY-----MII...Q==-----END PUBLIC KEY-----"
    }

  },
  "roles": ["INDIVIDUAL", "USER_PROVISIONING", "SCOPE_MANAGEMENT", "CONTENT_MANAGEMENT", "MALWARE_SCAN_MANAGER", "MALWARE_SCAN_STATE_USER", "AUDIT_TRAIL_MANAGEMENT"]
}'

📘 Note - Suspension

Since 20.14, userSystemInfo from the payload includes suspension info:

• if user is active, then the suspended attribute is set to false,

• if user is suspended, then the suspended attribute is set to true and both suspendedUntil and suspensionReason are as well included in the payload.

Please note that even if the suspendedUntil date is in the past, the user will remain suspended=true until he first logs on the client after the suspension ended. The suspended info are then automatically updated. See the Suspend User Account endpoint for more information.

🚧 Required Permissions

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges. See Bot Permissions for a list of roles and associated privileges.

The Password Object

The password object is optional for end-user accounts (NORMAL). For example, if your organization utilizes SSO, you may not want to specify the password.

Please note the password object is not used for service accounts (SYSTEM) and therefore cannot be entered in the request payload.

The following code snippets can be used to generate hashed passwords. Two implementations are provided, one using built-in Java classes and the other using Bouncy Castle Java Cryptography APIs.

@Test
public void test() throws NoSuchAlgorithmException, InvalidKeySpecException {
  String password = "ARandomPassword";
  SecureRandom sr = new SecureRandom();
  byte[] salt = new byte[16];
  sr.nextBytes(salt);
  assertTrue(Arrays.equals(generateStrongPasswordHash(password, salt), getSaltedPassword(password, salt)));
}

private static byte[] generateStrongPasswordHash(String password, byte[] salt)
throws NoSuchAlgorithmException, InvalidKeySpecException {
  int iterations = 10000;
  char[] pb = password.toCharArray();
  PBEKeySpec spec = new PBEKeySpec(pb, salt, iterations, 256);
  SecretKeyFactory skf = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256");
  byte[] hash = skf.generateSecret(spec).getEncoded();
  return hash;
}

public static byte[] getSaltedPassword(String password, byte[] salt) {
  PKCS5S2ParametersGenerator gen = new PKCS5S2ParametersGenerator(new SHA256Digest());
  byte[] bytes = password.getBytes(StandardCharsets.UTF_8);
  gen.init(bytes, salt, 10000);
  byte[] newPasswordGen = ((KeyParameter) gen.generateDerivedParameters(256)).getKey();
  return newPasswordGen;
}