Find Users

Finds a list of users based on a specified role or feature entitlement.

Find a user based on attributes

POSTyourpodURL.symphony.com/pod/v1/admin/user/find

Query parameters

Header parameters

Body

application/json

rolestring

The user role

featurestring

statusenum

ENABLEDDISABLED

Response

200400401403500

Success

Body

application/json

userAttributesUserAttributes (object)

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/v1/admin/user/find', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "userAttributes": {
      "emailAddress": "[email protected]",
      "firstName": "Jane",
      "lastName": "Doe",
      "userName": "jane.doe",
      "displayName": "Jane Doe",
      "accountType": "NORMAL",
      "assetClasses": [
        "Commodities"
      ],
      "industries": [
        "Financials",
        "Healthcare"
      ]
    },
    "userSystemInfo": {
      "id": 9826885173258,
      "status": "ENABLED",
      "suspended": true,
      "suspensionReason": "The user will be OOO due to a mandatory leave",
      "suspendedUntil": 1601546400,
      "createdDate": 1499347606000,
      "createdBy": "9826885173252",
      "lastUpdatedDate": 1499348554853,
      "lastLoginDate": 1504839044527
    },
    "roles": [
      "INDIVIDUAL"
    ]
  },
  {
    "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"
    ]
  }
]

This endpoint returns only exact matches of the specified criteria, while Search Users can return inexact matches.

To filter users by feature, first call User Features to retrieve valid feature entitlement values.

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