Find Users

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

Find a user based on attributes

post

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.

Body

application/json

rolestringOptional

The user role

Example: INDIVIDUAL

featurestringOptional

statusstring · enumOptionalPossible values:

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

post

/v1/admin/user/find

HTTPcURLJavaScriptPython

POST /pod/v1/admin/user/find HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "role": "INDIVIDUAL",
  "feature": "text",
  "status": "ENABLED"
}

[
  {
    "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.