Get User

Returns details for a particular user.

Retrieve V2 User details for a particular user

get

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

Success

application/json

V2 Detailed User record.

featuresinteger · int64[]OptionalExample: [1461508270000,7215545057281]

appsinteger · int64[]OptionalExample: [1461508270000,7215545057281]

groupsinteger · int64[]OptionalExample: [1461508270000,7215545057281]

rolesstring[]OptionalExample: ["ftp","mailto","fdsup","skype"]

disclaimersinteger · int64[]OptionalExample: [1461508270000,7215545057281]

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

get

/v2/admin/user/{uid}

HTTPcURLJavaScriptPython

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": "Departament",
    "division": "Division",
    "title": "Junior Trader",
    "twoFactorAuthPhone": "[phone]",
    "workPhoneNumber": "[phone]",
    "mobilePhoneNumber": "[phone]",
    "accountType": "NORMAL",
    "location": "New York",
    "jobFunction": "Trader",
    "assetClasses": [
      "Equities"
    ],
    "industries": [
      "Healthcare",
      "Technology"
    ]
  },
  "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
  },
  "roles": [
    "INDIVIDUAL"
  ]
}

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