Update User

Updates an existing user.

Update an existing V2 User

post
Path parameters
uidanyrequired

User ID as a decimal integer

Header parameters
sessionTokenanyrequired

Session authentication token.

Body
emailAddressstringoptional
Example: johndoe@symphony.com
firstNamestringoptional
Example: John
lastNamestringoptional
Example: Doe
userNamestringoptional
Example: johndoe
displayNamestringoptional
Example: John Doe
companyNamestringoptional
Example: Company
departmentstringoptional
Example: Department
divisionstringoptional
Example: Division
titlestringoptional
Example: Trader
workPhoneNumberstringoptional
Example: +15419999999
mobilePhoneNumberstringoptional
Example: +15419999999
twoFactorAuthPhonestringoptional
Example: +15419999999
smsNumberstringoptional
Example: +15419999999
accountTypestring · enumoptional
Example: NORMAL
Available options:
locationstringoptional
Example: New York
recommendedLanguagestringoptional
Example: english
jobFunctionstringoptional
Example: Trader
assetClassesstring[]optional
Example: ["Equities"]
industriesstring[]optional
Example: ["Healthcare","Technology"]
marketCoveragestring[]optional
Example: ["EMEA"]
responsibilitystring[]optional
Example: ["BAU"]
functionstring[]optional
Example: ["Trade Processing"]
instrumentstring[]optional
Example: ["Equities"]
currentKeyobjectoptional

User RSA key information.

previousKeyobjectoptional

User RSA key information.

Responses
curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v2/admin/user/{uid}/update' \
  --header 'Content-Type: application/json' \
  --data '{
    "emailAddress": "johndoe@symphony.com",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Company",
    "department": "Department",
    "division": "Division",
    "title": "Trader",
    "workPhoneNumber": "+15419999999",
    "mobilePhoneNumber": "+15419999999",
    "twoFactorAuthPhone": "+15419999999",
    "smsNumber": "+15419999999",
    "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-----\
  MIICIANBgkqhw0BAQ...cCAwEAAQ==\
  -----END PUBLIC KEY-----",
      "expirationDate": 1467562406219,
      "action": "SAVE"
    },
    "previousKey": {
      "key": "-----BEGIN PUBLIC KEY-----\
  MIICIANBgkqhw0BAQ...cCAwEAAQ==\
  -----END PUBLIC KEY-----",
      "expirationDate": 1467562406219,
      "action": "SAVE"
    }
  }'
{
  "userAttributes": {
    "emailAddress": "johndoe@symphony.com",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Company",
    "department": "Department",
    "division": "Division",
    "title": "Trader",
    "workPhoneNumber": "+15419999999",
    "mobilePhoneNumber": "+15419999999",
    "twoFactorAuthPhone": "+15419999999",
    "smsNumber": "+15419999999",
    "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"
  }
}

Success

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 [].

Last updated

Was this helpful?