Get User

Returns details for a particular user.
get
https://yourpodURL.symphony.com/pod
/v2/admin/user/{uid}
Retrieve V2 User details for a particular user
Parameters
Path
uid*
string
User ID as a decimal integer
Header
sessionToken*
string
Session authentication token.
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.

📘 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.
See End-User Account Attributes V2 for information about the user attributes.

🚧 Roles and Privileges

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges. See Bot Permissions for a list of roles and associated privileges.
Last modified 2mo ago