Back to Cherwell Integrations
Handler · Version 2

Cherwell User Retrieve

Download GitHub


This handler retrieves a Cherwell user and returns a JSON representation of the found user. Execution starts by retrieving an Access Token from Cherwell using the client id/secret and username/password info values. Once that is successfully retrieved, the user is retrieved. Lastly, the fields returned are converted from an array to a simplified map of field information in the form of {displayName: value}.

Name Description Sample
Error Handling Determine what to return if an error is encountered.
Login Id Internal Cherwell Login ID of the user record to retrieve. CSDAdmin
Login Id Type Login ID Type. Options are Internal or Windows. Internal
Name Description
Handler Error Message Will include "User not found ()" if the login it provided is not found, otherwise any other error.
User JSON A JSON representation of the user that matches the id. Will be an empty hash if a user is not found.

Cherwell User Retrieve V2 (2019-11-13)

  • Added auth mode to info values

Cherwell User Retrieve V2 (2019-11-4)

  • Added error message Handling

Cherwell User Retrieve V2 (2019-10-26)

  • Uses Cherwell API V2, which includes the loginidtype input parameter.

Cherwell User Retrieve V1 (2019-10-26)

  • Initial version. See README for details.
Download GitHub

On This Page

Other Versions

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top