Update User

Updates an existing user.

Update an existing V2 User

POSTyourpodURL.symphony.com/pod/v2/admin/user/{uid}/update

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

emailAddressstring

firstNamestring

lastNamestring

userNamestring

displayNamestring

companyNamestring

departmentstring

divisionstring

titlestring

workPhoneNumberstring

mobilePhoneNumberstring

twoFactorAuthPhonestring

smsNumberstring

accountTypeenum

NORMALSYSTEMSDL

locationstring

recommendedLanguagestring

jobFunctionstring

assetClassesarray of string

industriesarray of string

marketCoveragearray of string

responsibilityarray of string

functionarray of string

instrumentarray of string

currentKeyV2UserKeyRequest (object)

User RSA key information.

previousKeyV2UserKeyRequest (object)

User RSA key information.

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/{uid}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "userAttributes": {
    "emailAddress": "[email protected]",
    "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 Example

curl -X POST \
https://acme.symphony.com/pod/v1/admin/user/7215545078541/update \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{   
    "accountType": "NORMAL",
    "firstName": "Jane",
    "lastName": "Doe",
    "username": "janedoe",
    "displayName": "Jane Doe",
    "companyName": "Symphony",
    "department": "",
    "division": "",
    "title": "Sales Manager",
    "workPhoneNumber": "",
    "mobilePhoneNumber": "",
    "twoFactorAuthPhone": "",
    "location": "San Francisco",
    "jobFunction": "Sales",
    "assetClasses": ["Commodities"],
    "industries": ["Basic Materials"],
    "marketCoverage": ["EMEA"],
    "responsibility": ["BAU"],
    "function": ["Trade Management"],
    "instrument": ["Securities"],
    "currentKey": {
        "key":"-----BEGIN PUBLIC KEY-----\nMIICIj...==\n-----END PUBLIC KEY-----",
        "action":"SAVE"
    }    
}'

📘 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.

❗️ Known Issues

There is a known bug where the "Industries" and "Asset Classes" fields cannot be cleared once set. For example, if you set assetClasses on a user to [Conglomerates, Healthcare], you can update the user and set it to [Conglomerates], but you cannot update the user and clear it by setting it to [].