Creating workflows for AWS QuickSight users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Amazon QuickSight in minutes

You'll get visibility of your Amazon QuickSight users by creating configurable workflows to automate tasks such as: adding, updating and deleting user accounts.

Contents

1. Before you start
2. Adding your AWS Region as a global variable
3. Creating workflows
4. Create user workflows
   1. Amazon QuickSight Update User
   2. Amazon QuickSight Add User
   3. Amazon QuickSight Delete User

Before you start

Before you create workflows, you need to have added your Amazon QuickSight credentials to Oomnitza. See Adding your AWS credentials to Oomnitza. 

We recommend that you also create the extended integration for Amazon QuickSight users. You can use the information retrieved in this integration to trigger workflows that can create, edit, delete users, and much more.

Adding your AWS Region as a global variable

To save time entering information when you create workflows, you can add the AWS Region as a global variable in Oomnitza.

1. From the menu, go to Configuration>General.
2. Click Global Settings.
3. Click Add new variable (+). 
4. Enter quicksight.region as the Key or variable name.
5. For the value enter your AWS region. To find your AWS region refer to the following table: AWS Regions. For example, use us-west-1 for US West (N. California).
6. Save your changes.

Creating workflows

Create user workflows

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

1. Click Configuration > Workflows 
2. Click Add  and select Users from the Objects list.
3. Drag and drop the API block onto the Sandbox.
4. Click Edit on the API block and enter Amazon QuickSight in the search field. 
5. Select a preset:
   • Amazon QuickSight Update User
   • Amazon QuickSight Add User
   • Amazon QuickSight Delete User
6. To choose a preset, click the forward arrow (>).
7. Select the credentials that you created in Adding your AWS credentials to Oomnitza. 
8. Configure the API Block following the preset instructions below, and save your changes.
9. 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. 
10. Connect the Blocks. 
11. Save, validate, and activate your workflow.

Using the Update User preset

The Update User preset updates the Email address and Role of an AWS user. When you select this preset you must first supply the Email address and Role of the new user.

Enter the mandatory parameters required to make the request by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Review the fields in the Information tab and the Params tab. Ensure that the following fields are populated or replaced with the correct information before you run the workflow:
   • {{AwsAccountId}}: The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
   • {{amazon_namespace}}:The namespace. Currently, you can change this to default.
   • {{alternate_username}}: The Amazon QuickSight user name that you want to update. To retrieve a list of usernames use the QuickSight User Load and update the property name from {{alternate_username}} to {{aws_username}}to call the usernames in the workflow. 
3. Select the Body tab to review the new user information that you entered. 
4. 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.

Did you know?
You can add more details in the Body tab, such as the user's external login ID and custom permissions.  For further information see AWS API Documentation: UpdateUser.

Using the Add User preset

The Add User preset enables you to create a new Amazon QuickSight 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: {{email}} or {{aws_username}}. 

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. Review the fields in the Information tab and the Params tab. Ensure that the following fields are populated or replaced with the correct information before you run the workflow:
   • {{AwsAccountId}}: The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
   • {{amazon_namespace}}:The namespace. Currently, you can change this to default.
3. Select the Body tab. Review the new user information that you entered. 
4. Select the Response tab. You can map the entire response by following the example in the Update User preset.

Name	Value	Mandatory	Details
Email	Email	Yes	The email address of the user that you want to register.
Identity Type	IdentityType	Yes	Accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
User Role	UserRole	Yes	The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
User Name	UserName	No	The Amazon QuickSight user name that you want to create for the user you are registering. Since this value is not mandatory, you can remove it in the message body by going to Advanced Mode>Body.

Did you know?
You can add more details in the Body tab, such as the user's external login ID and custom permissions.  For further information see AWS API Documentation: RegisterUser.

Using the Delete User preset

The Delete User preset deletes a Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user is not deleted as a result of this call. For further information see Amazon QuickSight API Documentation: Delete User.

Enter the mandatory parameters required to make the request by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Review the fields in the Information tab and the Params tab. Ensure that the following fields are populated or replaced with the correct information before you run the workflow:
   • {{AwsAccountId}}: The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
   • {{amazon_namespace}}:The namespace. Currently, you can change this to default.
   • {{alternate_username}}: The Amazon QuickSight user name that you want to update. To retrieve a list of usernames use the QuickSight User Load and update the property name from {{alternate_username}} to {{aws_username}}to call the usernames in the workflow. 
3. Select the Response tab. If the Delete User preset is successful, it returns an AWS Request ID. You can return this value by placing {{response}} or {{response.RequestId}}in the Response field and mapping it to an Oomnitza field.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.