Update User

Updates an existing user.

Update an existing V2 User

post

/v2/admin/user/{uid}/update

Path parameters

uidinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

emailAddressstring

Example: [e-mail]

firstNamestring

Example: John

lastNamestring

Example: Doe

userNamestring

Example: johndoe

displayNamestring

Example: John Doe

companyNamestring

Example: Company

departmentstring

Example: Department

divisionstring

Example: Division

titlestring

Example: Trader

workPhoneNumberstring

Example: [phone]

mobilePhoneNumberstring

Example: [phone]

twoFactorAuthPhonestring

Example: [phone]

smsNumberstring

Example: [phone]

locationstring

Example: New York

recommendedLanguagestring

Example: english

jobFunctionstring

Example: Trader

currentKeyobject

User RSA key information.

previousKeyobject

User RSA key information.

accountTypestring · enum

Example: NORMAL

Options: NORMAL, SYSTEM, SDL

assetClassesstring[]

Example: ["Equities"]

industriesstring[]

Example: ["Healthcare","Technology"]

marketCoveragestring[]

Example: ["EMEA"]

responsibilitystring[]

Example: ["BAU"]

functionstring[]

Example: ["Trade Processing"]

instrumentstring[]

Example: ["Equities"]

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v2/admin/user/{uid}/update' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"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]","location":"New York","recommendedLanguage":"english","jobFunction":"Trader","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"},"accountType":"NORMAL","assetClasses":["Equities"],"industries":["Healthcare","Technology"],"marketCoverage":["EMEA"],"responsibility":["BAU"],"function":["Trade Processing"],"instrument":["Equities"]}'

200

400

401

403

500

200

{
  "roles": [
    "INDIVIDUAL"
  ],
  "userSystemInfo": {
    "id": 7215545078461,
    "status": "ENABLED",
    "suspended": true,
    "suspensionReason": "The user will be OOO due to a mandatory leave",
    "suspendedUntil": 1601546400,
    "createdDate": 1461508270000,
    "createdBy": "7215545057281",
    "lastUpdatedDate": 1461508270000,
    "lastLoginDate": 1461508270000,
    "deactivatedDate": 1461508270000
  },
  "userAttributes": {
    "emailAddress": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Company",
    "department": "Departament",
    "division": "Division",
    "title": "Junior Trader",
    "twoFactorAuthPhone": "[phone]",
    "workPhoneNumber": "[phone]",
    "mobilePhoneNumber": "[phone]",
    "accountType": "NORMAL",
    "location": "New York",
    "jobFunction": "Trader",
    "assetClasses": [
      "Equities"
    ],
    "industries": [
      "Healthcare",
      "Technology"
    ]
  }
}

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