Get User
Returns details for a particular user.
User ID as a decimal integer
Session authentication token.
GET /pod/v2/admin/user/{uid} HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*
{
"userAttributes": {
"emailAddress": "[email protected]",
"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"
}
}
📘 Note - SuspensionSince 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 bothsuspendedUntil
andsuspensionReason
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.
See End-User Account Attributes V2 for information about the user attributes.
🚧 Roles and PrivilegesCalling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges. See Bot Permissions for a list of roles and associated privileges.
Last updated
Was this helpful?