AWS Organization - System Data Connector Guide
Gathid can be configured to download identity data from your AWS Organization instance using an API. The following guide will assist you with configuring your system so that Gathid can automatically extract the data.
Overview
This article relates to version 8.2 of the AWS Organization Data Connector.
The connector retrieves a list of AWS Accounts and Organizational Units from your AWS Organization instance via REST API.
It also provides the option to collect users, groups and other identity information from the IAM Identity Center (IDC) service.
Authentication is performed using OAuth 2.0 tokens - further details are provided below.
Click here to review the loader's system properties.
Summary
-
Validate that the new AWS Organization connector is available on your Gathid instance
-
Create an IAM user and assign permissions
-
Obtain credentials from your AWS Organization instance for the Gathid configuration
-
Configure the Prep Script tab in the AWS Organization system loader
-
Optional: Retrieve Identity Center information
- Next Steps
Steps to configure the AWS Organization data connector in Gathid
1. Validate that the AWS Organization connector is available on your Gathid instance
-
As an Administrator user, log into Gathid and navigate to Admin → Systems.
-
You should see a new [system] loader in the list, in a Disabled state. If not, follow the process to add a new system.
REMINDER: To be able to view the Admin menu option in Gathid you need to have the ADMINISTRATOR role.
2. Create an IAM user and assign permissions
If you already have a User available for Gathid access in your AWS Management Account, ensure that you have the correct permissions (see step 2.9 below) assigned to this user. Then continue on to Obtain an Access Key and Secret Key for the Gathid connector.
-
From the AWS Management Console log in to the AWS Management Account with a user that has administrative privileges.
- Navigate to the Identity and Access Management (IAM) service by searching for IAM in the search bar.
- Select IAM Users, and then Create user.
- For Step 1: Specify user details, provide a User name (e.g. "gathid-access") and click Next. (This user does not need access to the AWS Management Console.)
- For Step 2: Set permissions, leave the Permissions options as the default (Add user to group) and click Next. (
- For Step 3: Review and create, click on Create user.
- Return to IAM Users and click on the user that has just been created.
- On the Permissions tab, in the Permissions policies section, click on the Add permissions drop down and select Create inline policy. (If you prefer, create a customer managed policy and attach it to this user.)
- For Step 1: Specify permissions, on the right-hand side of Policy editor, select the JSON tab. Delete the existing JSON and paste the following:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"organizations:DescribeOrganization",
"organizations:ListRoots",
"organizations:ListOrganizationalUnitsForParent",
"organizations:ListAccountsForParent"
],
"Resource": "*"
}]} - Click Next.
- For Step 2: Review and create, under Policy details enter a Policy name (e.g. gathhid-access-policy).
Click on Create policy. This policy gets added to the user as a "Customer inline" policy.
3. Obtain credentials from your AWS Account instance for the Gathid configuration
- After a user has been created and the permissions have been assigned, return to the IAM Users section and click on the user that has just been created.
-
In the Summary section on the right-hand-side, click Create access key.
-
For Step 1: Access key best practices & alternatives, select Other and click Next.
- For Step 2: Set description tag, this is optional so it can be left empty. Click Create access key.
A confirmation message appears at the top of the screen. Do not leave this screen without downloading the credentials as they cannot be recovered. - Either copy the Access key and the Secret Access key or click Download.csv file.
Keep these credentials as they will be required in the step to configure the Gathid loader. - Click Done.
4. Configure the Prep Script tab in the AWS Organization system loader
- As an Administrator, log into Gathid and navigate to Admin → Systems.
- Select the AWS Organization loader and in 1. System Information toggle the System Enabled option to On.
Ensure the correct start time for the loader is set in the Time. This should be close to your instance's stack start time. - Then go to 2. Prep-Scripts (Optional) and edit the AWS Organization Prep Script.
Under Customer Configuration, enter the Access Key and Secret obtained in the previous step.
(If you want to enable "Identity Center data" collection, go to Step 5 below.) - Click on Save Parameters to save the prep-script changes.
Click Save again to save the system loader configuration.
5. Optional: Retrieve Identity Center information
- Log into your AWS Management Account via the AWS Management Console as a user with sufficient privileges.
- In the IAM service, locate the user that has been setup for Gathid access (step 2 above).
- In the Permissions tab find the policy that grants the Gathid access permission and click on it.
- In the Policy editor, add the following permissions to the Action array:
"identitystore:ListUsers",
"identitystore:ListGroups",
"identitystore:ListGroupMemberships",
"sso:ListInstances",
"sso:ListPermissionSets",
"sso:DescribePermissionSet",
"sso:ListAccountAssignmentsForPrincipal" - Click Next and then Save changes.
NOTE: If you are experiencing difficulties saving due to syntax errors, ensure that each item in the Action has a comma after it, except for the very last one before the square bracket. - Because the IDC data store is region specific, we need to obtain both a region and a store ID as follows:
- Navigate to the IAM Identity Center service by searching for IAM Identity Center in the search bar.
- Click on Settings from the left-hand-side menu.
- On the Settings page, in the Details section, locate the Primary Region, (e.g., ‘us-east-1’).
Save this information as it will be required in the step to configure the Gathid loader. - Below, in the Identity Source section, locate the Identity Store ID.
Save this information as it will be required in the step to configure the Gathid loader.
- Return to Gathid and locate the AWS Organization system loader under the Admin, Systems menu item.
Click on 2. Prep-Scripts (Optional) and edit the AWS Organization Prep Script. - Under Optional Data to Collect change the Identity Center data toggle from No to Yes.
Enter the Identity Center Region and the Identity Center Store Id obtained in item 6 of this step. - Click on Save Parameters.
Click Save again.
If IDC is enabled, an external relationship can be created to join Permission Sets to an AWS Account Roles (if enabled).
Next Steps:
System Properties