Creating workflows for Qualys users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Qualys in minutes

You'll get visibility of your Qualys users by creating configurable workflows to automate tasks such as:

• • Workflows for creating and editing new user
  • Workflows for activating and deactivating a user
  • Workflows for updating a users password

Contents

1. Before you start
2. Creating workflows
3. Create user workflows
   1. Qualys Activate User
   2. Qualys Create User
   3. Qualys Deactivate User
   4. Qualys Edit User
   5. Qualys Password Change

Before you start

Before you create workflows, you need to have added your Qualys credentials to Oomnitza. Follow the steps in Adding your Qualys credentials to Oomnitza and add your Basic credentials to Oomnitza.

We recommend that you also create the extended integration for Qualys users. You can use the information retrieved in these integrations to trigger workflows that can create, edit, activate users, and much more.

To save time running the integration you should also have added your Qualys API URL as a global variable in Oomnitza.

Creating workflows

Create user workflows

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

1. Click Configuration > Workflows 
2. Click Add .
3. Select Users from the Objects list.
4. Drag and drop the API block onto the Sandbox.
5. Click Edit on the API block and enter Qualys in the search field. 
6. Select a preset:
   • Qualys Activate User
   • Qualys Create User
   • Qualys Deactivate User
   • Qualys Edit User
   • Qualys Password Change
7. To choose a preset, click the forward arrow (>).
8. Select the credentials that you created in Adding your Qualys credentials to Oomnitza.
9. Your Qualys API URL is derived from the global variable you created in Adding Qualys global variables.
10. Configure the API Block following the preset instructions below, and save your changes.
11. Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to Schedule and add a rule so that the Email Equals <EmployeeEmail> you can trigger a workflow to fetch a user matching a certain name on a specific date. Refer to Using the Begin block. 
12. Connect the Blocks. 
13. Save, validate, and activate your workflow.

 Understanding Workflows

Using the Activate User preset

The Activate User preset activates a user's account that has an "Inactive" status, using a Qualys User Login. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Params tab. You will notice that the Qualys User Login is referenced in the property {{username}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. 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.   

Note
Check the Qualys API documentation to ensure that you have the relevant permissions to activate/deactivate a user. For example, administrators cannot activate/deactivate another manager or administrator account. Unit Managers can only activate/deactivate a user account within their respective business unit. For further information see Qualys API Documentation: Activate User.

Using the Create User preset

The Create User preset enables you to create a new Qualys user. When you select this preset you need to supply the new user information detailed in the below table. You can refer to an existing Oomnitza field in the workflow by entering the field name in lower case, with spaces replaced with an underscore. For example: {{first_name}} or {{city}}. Select the Sign in Email checkbox to send a secure link via email to the user containing their login ID and password. If you do not select the checkbox, an email notification will not be sent to the new user. Instead, an XML report is returned in the response containing the user's login ID and password.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Params tab. You can add more fields that will be used in the request payload, such as the new user's zip code or time zone. See Qualys API Documentation: Parameters for defining Users.
3. Select the Response tab. You can map the message response as per the example in the Activate User preset.

Name	Value	Details
User Role	user_role	Specifies the user role. A valid value is: manager, unit_manager, scanner, reader, contactor administrator. The first user added to a new custom business unit must be unit_manager.
Business Unit	business_unit	Specifies the user’s business unit. A valid value is unassigned, or the title of an existing custom business unit. A custom business unit may be added using the Qualys user interface.
First Name	first_name	The user's first name.  Max length: 50 characters.
Last Name	last_name	The user's last name.  Max length: 50 characters.
Title	title	The user's job title.  Max length: 100 characters.
Phone	phone	The user's phone number.  Max length: 40 characters.
Email	email	The user's email address.  Max length: 100 characters.
Address 1	address1	The user's address line 1.  Max length: 80 characters.
City	city	The user's city.  Max length: 50 characters.
Country	country	The user’s country code. See Country Codes.
State	state	The user’s state code. A valid value depends on the country code specified for the country parameter. You must enter a state code using the state parameter when the country code is either:United States of America, Australia, Canada or India. See State Codes. For other country codes, a state code does not need to be specified. If specified, enter the state code none .

Note
Check the Qualys API documentation to ensure that you have the relevant permissions to add/edit a user. For example, administrators cannot add/edit another manager or administrator account. Unit Managers can only add/edit a user account within their respective business unit. For further information see Qualys API Documentation: Permissions - Users.

Using the Deactivate User preset

The Deactivate User preset enables you to deactivate a Qualys user that has an "Active" status, using a Qualys user Login. You can configure the message payload by following the steps in Using the Activate User preset.

For further information see Qualys API Documentation: Deactivate User.

Using the Edit User preset

The Edit User preset enables you to update or modify a Qualys user by their Qualys User Login. When you select this preset you need to supply the updated user information detailed in the above table. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Params tab. You will notice that the Qualys User Login is referenced in the property {{username}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. Select the Response tab. You can map the message response as per the example in the Activate User preset.

Using the Password Change preset

The Password Change preset enables you to update a Qualys user's password by their Qualys User ID. Select the Sign in Email checkbox to send a secure email to the user containing their new password. If you do not select the checkbox, an email notification will not be sent to the new user. Instead, an XML report is returned in the response containing the user's login ID and password.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Params tab. You will notice that the Qualys User ID is referenced in the property {{qualys_user_id}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow. You can enter multiple User IDs as a comma-separated list. Specify all to change the password for all users in the user’s account, except the requesting user.
3. Select the Response tab. You can map the message response as per the example in the Activate User preset.

Note
Check the Qualys API documentation to ensure that you have the relevant permissions to change a password. For example, administrators cannot change a password for the user making the request, or a manager. Unit Managers cannot change a password for the user making the request, or anyone outside their business unit. For further information see Qualys API Documentation: Change Password.

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block