List Users

Returns a list of users ID, including user metadata.

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

get

Query parameters

skipintegerOptional

Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.

limitintegerOptional

Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.

Header parameters

sessionTokenstringRequired

Session Authentication token.

Responses

200

Success

application/json

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/list

HTTPcURLJavaScriptPython

GET /pod/v2/admin/user/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

[
  {
    "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: Some properties of the user are not included in the List users response for performance reasons. For example, the disclaimers and features are not present. Please use the dedicated endpoints (List Features and List Disclaimers) instead.

🚧 Required Permissions

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.