Find Users

Finds a list of users based on a specified role or feature entitlement.
post
https://yourpodURL.symphony.com/pod
/v1/admin/user/find
Find a user based on attributes
Parameters
Query
skip
string
Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.
limit
string
Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.
Header
sessionToken*
string
Session authentication token.
Body
role
string
The user role
feature
string
status
string
Body
Example
Schema
{
"role": "INDIVIDUAL"
}
Responses
200: OK
Success
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.
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.
Last modified 2mo ago