Skip to main content
Sign in

Creating workflows for Fleet users

  • April 17, 2024 08:18
  • Updated

Let Oomnitza be your single source of truth!

You'll get visibility of your users as data from Fleet is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Fleet in minutes

Get the information and insights that you need by creating configurable workflows for:

  • Onboarding and offboarding users
  • Getting a SaaS user role
  • Creating and adjusting users as part of a user change or user onboarding workflow

Navigation

small_blue_link.svgCreate user workflows

small_blue_link.svgCreating a SaaS user role workflow

Before you start

Before you can create workflows with Oomnitza, you need to have added your Fleet credentials to Oomnitza and set your domain as a global variable. We recommend that you also create an extended integration for Fleet users. You can use the information retrieved in this integration to trigger workflows.

Related Links

small_blue_link.svgAdding your Fleet domain as a global variable

small_blue_link.svgAdding your Fleet credentials to Oomnitza

small_blue_link.svgCreating an extended integration for Fleet users

Create user workflows

To create a user workflow, you must complete these steps:  

  1. Click Configuration > Workflows 
  2. Click Add (+) and select People from the list.
  3. Drag and drop the API block onto the Sandbox.
  4. Click Edit on the API block and enter FleetDM in the search field. 
  5. Select a preset:
  6. To choose a preset, click the forward arrow (>).
  7. Select the credentials that you created earlier.
  8. Enter any mandatory information when prompted.
  9. Select Advanced Mode.
  10. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. Once you have the entire response, you can then parse the JSON response values to custom Oomnitza fields, as per the example below.
  11. Connect the Blocks. 
  12. Save, validate, and activate your workflow.

generic_response_mapping.PNG

Using the Reset User Password preset

The Reset User preset reset a user's password.

The selected user is logged out of Fleet and will be prompted to reset their password during their next login attempt. Additionally, as a security measure, all active Fleet API tokens associated with this user will be revoked.

The user to be reset is referenced in the Advanced Mode > Information tab in the property{{fleetdm_user_id}}.

small_blue_link.svgFleet API Documentation: Require password reset.

Using the Delete User preset

The Delete User preset deletes a specified user from Fleet.

The user to be deleted is referenced in the Advanced Mode > Information tab in the property{{fleetdm_user_id}}.

small_blue_link.svgFleet API Documentation: Delete user.

Using the Modify User Information preset

The Modify User Information preset modifies a specified user.

The user to be modified is referenced in the Advanced Mode > Information tab in the property{{fleetdm_user_id}}.

Name Description
name The user's name.
position The user's position.
email

The user's email.

Important
You cannot modify the user's email.
sso_enabled Determines whether SSO is enabled for the user.
api_only If enabled, the user is an "API-only" user and cannot use the web UI.
password

To change their own email or password, the user is required to provide their current password. However, an administrator can modify another user's information without requiring the user's current password.
new_password The user's new password.
global_role The role assigned to the user. In Fleet 4.0.0, 3 user roles were introduced (admin, maintainer, and observer). In Fleet 4.30.0 and 4.31.0, the observer_plus and gitops roles were introduced respectively.

small_blue_link.svgFleet API Documentation: Modify user

Using the Get User Information preset

The Get User Information preset returns all information about a specific user.

The user to be retrieved is referenced in the Advanced Mode > Information tab in the property{{fleetdm_user_id}}.

small_blue_link.svgFleet API Documentation: Get user information

Using the Create User without an Invitation preset

The Create User without an Invitation preset creates a user account without requiring an invitation. The user is enabled immediately. By default, the user is forced to reset their password upon the first login.

Name Description
name Required. The user's full name or nickname.
email Required. The user's email address.
password The user's password (required for non-SSO users).
admin_forced_password_reset Determines whether the user will be forced to reset their password upon their first login
sso_enabled Determines whether SSO is enabled for the user.
api_only If enabled, the user is an "API-only" user and cannot use the web UI.
global_role The role assigned to the user. In Fleet 4.0.0, 3 user roles were introduced (admin, maintainer, and observer). In Fleet 4.30.0 and 4.31.0, the observer_plus and gitops roles were introduced respectively.

small_blue_link.svgFleet API Documentation: Create a user account without an invitation

Using the Create User with an Invitation preset

The Create User with an Invitation preset creates a user account after an invited user submits a registration form.

Name Description
name Required. The name of the user.
email Required. The email address of the user.
password The user's password (required for non-SSO users).
invite_token Required. Token provided to the user in the invitation email.
global_role The role assigned to the user. In Fleet 4.0.0, 3 user roles were introduced (admin, maintainer, and observer). In Fleet 4.30.0 and 4.31.0, the observer_plus and gitops roles were introduced respectively. 

small_blue_link.svgFleet API Documentation: Create a user account with an invitation

articles_icon.svg Reference articles for workflows

Creating a SaaS User Role workflow

This workflow block enables you to read a user’s global role from Fleet. The workflow uses the Fleet Get user information API to return a list of global roles. These global roles include the following:

  • admin
  • maintainer
  • observer

Prerequisites

Before you create a SaaS user workflow, you should have already run your extended user integration and selected User plus SaaS User to populate the Fleet software entry in the Software > SaaS menu.

To create a Saas User workflow using the Fleet User Role preset, complete the following steps:

  1. Click Configuration > Workflows 
  2. Click Add (+) and select Software SaaS Users from the list.
  3. Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
  4. Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
  5. Click the Edit icon.
  6. Enter Fleet in the search field and choose the Fleet User Role preset.
  7. Click the right arrow >.
  8. Enter your Credentials.
  9. Select the Deactivate User checkbox to deactivate the SaaS user in SaaS > Fleet > Users if they are not found in your Fleet instance.
  10. Click SAVE.
  11. Connect the blocks.
  12. Validate, launch, and save your workflow.

To view active Fleet users in the SaaS Users UI, complete the following steps:

  1. Click Software from the menu.
  2. Select the Saas tab, and select your software entry for Fleet.
  3. Click Users in the side pane.           
  4. The Role column will be populated with the global role information to confirm that this user has been found in your Fleet SaaS

Reference articles for creating workflows

Related articles

Comments

0 comments

Please sign in to leave a comment.