Get User

Returns details for a particular user.

Retrieve V2 User details for a particular user

GETyourpodURL.symphony.com/pod/v2/admin/user/{uid}

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

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}', {
    method: 'GET',
    headers: {},
});
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"
  }
}

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

See End-User Account Attributes V2 for information about the user attributes.

🚧 Roles and Privileges

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.