List Users

Returns a list of users ID, including user metadata.

Retrieve a list of all users in the company (pod)

GETyourpodURL.symphony.com/pod/v2/admin/user/list

Query parameters

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/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "userAttributes": {
      "emailAddress": "[email protected]",
      "userName": "nexus.user",
      "displayName": "nexus.user",
      "accountType": "SYSTEM"
    },
    "userSystemInfo": {
      "id": 9826885173290,
      "status": "ENABLED",
      "suspended": false,
      "createdDate": 1499375475000,
      "createdBy": "9826885173255",
      "lastUpdatedDate": 1499375475852,
      "lastLoginDate": 1504899124191
    },
    "roles": [
      "USER_PROVISIONING",
      "CONTENT_MANAGEMENT",
      "INDIVIDUAL"
    ]
  },
  {
    "userAttributes": {
      "emailAddress": "[email protected]",
      "firstName": "admin",
      "lastName": "admin",
      "userName": "[email protected]",
      "displayName": "Admin Admin",
      "companyName": "Company Name",
      "department": "Departament",
      "division": "Division",
      "title": "Administrator",
      "twoFactorAuthPhone": "[phone]",
      "workPhoneNumber": "[phone]",
      "mobilePhoneNumber": "[phone]",
      "accountType": "NORMAL",
      "assetClasses": [
        "Currencies"
      ],
      "industries": [
        "Technology"
      ]
    },
    "userSystemInfo": {
      "id": 7696581394433,
      "status": "ENABLED",
      "suspended": false,
      "createdDate": 1438054194000,
      "lastUpdatedDate": 1527532171729,
      "lastLoginDate": 1523912043015
    },
    "roles": [
      "SUPER_COMPLIANCE_OFFICER",
      "INDIVIDUAL",
      "SUPER_ADMINISTRATOR"
    ]
  }
]

📘 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 privilege. See Bot Permissions for a list of roles and associated privileges.