Subscribe to Help Center RSS FeedUse JumpCloud API actions to achieve more advanced and granular directory operations. See Create a Workflow to learn about creating the workflows in details.
To use JumpCloud API Actions while creating a workflow:
- In your Workflow Canvas, click the + icon to add an action.
- In Action Type > Actions > JumpCloud API Actions, select the appropriate API action.
- In the Workflow canvas, click the action card and define the values and parameters as required in the right pane.
- The Node name is a unique string. You can leave this as-is, or rename it if you plan to reference its specific JSON execution response further downstream in subsequent workflow nodes.
- Depending on the specific JumpCloud API endpoint, some actions require a Request Body JSON structure to modify user configurations or pass metadata.
- Path parameters are variables built directly into the endpoint's routing structure.
- Query parameters are appended to the end of the URL path after a question mark (?) to filter, sort, or paginate the requested data.
Instead of typing a static parameters such as the device is into these fields which would cause the workflow to run against the exact same computer every single time, you can use dynamic variable references extracted from your trigger payload. For example, if you input, {input.resource.id}, the automation engine reads the incoming event log, finds the ID of the specific machine that triggered the rule, and passes that variable directly to the execution node.
Depending on whether the variable is required for a trigger event (input.) or action node (action.), the value would differ.
- If value is coming from trigger, use :
input.<field_ref> - If it is coming from any previous actions, already defined in the workflow, use:
actions.<action_name>.<field_ref>
- You can also turn the Pagination toggle on to process large sets of data. Pagination ensures your workflow processes every record in your directory by automatically requesting data in manageable batches.
The details are automatically populated in the action card.
Learn More