Overview

The  supports multiple methods of authenticating to AWS resources. At the topmost level, authentication can be broken down into two modes: system and user.

• System mode: One set of credentials is used for each user of the platform to authenticate to AWS.

• User mode: Individual user accounts must be configured with AWS credentials.

  NOTE: This section covers how to manage AWS credentials through the APIs for individual users (user mode). When in system mode, please manage AWS configuration through the application.

  
  

Per-User Authentication Methods

To connect to AWS resources and access S3 data, the following information is required for each user, depending on the method of authentication.

Method 1 - AWS Key and Secret

If users are providing key-secret combinations, the following information is required. 

Method 2 - AWS IAM Role ARNs

Users can access AWS resources by assigning an awsConfig object to the account.

The following information is required:

Authentication objects

For each authentication method, the above pieces of information must be provided for each user.

These pieces of information are defined in an awsConfig object. An awsConfig object is a set of AWS configuration properties that can be created, modified, and assigned to individual users via API.

For Method 2, the awsConfig object maps to an awsRole object. An awsRole object references an IAM role and an awsConfig object. When you create an awsConfig object and its credential provider is set to temporary, the awsRole object is automatically created for you: 

• • Each awsRole object maps to a single IAM role.
  • Each awsRole object is mapped to an awsConfig object. 
  • The awsConfig object is then assigned to individual users. 
  • Through this mechanism, you have more flexibility in assigning the active role to users.
  • As needed, the awsConfig object can be mapped at a later time to another awsRole object through the role attribute. 

This workflow steps through the process for all these methods.

Basic Workflow

1. Choose your method of authentication.
2. Locate the internal identifier for the user to which to assign the configuration object.
3. Create an awsConfig object, assigning the object to the user as part of the process.
4. Verify that the assignment is working.

Step - Acquire information

Acquire all of the information listed above for the awsConfig object you wish to create.

Step - Locate user

Now, you need to locate the internal identifier for the user to which you wish to assign this AWS configuration.

Request:

Response:

{
    "data": [
        {
            "id": 3,
            "email": "4070250@example.com",
            "name": "Test User4070250",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": false,
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-04-16T16:27:51.143Z",
            "updatedAt": "2019-04-16T16:27:56.630Z",
            "outputHomeDir": "/trifacta/queryResults/4070250@example.com",
            "fileUploadPath": "/trifacta/uploads",
            "awsConfig": {
                "id": 2
            }
        },
        {
            "id": 2,
            "email": "32870@example.com",
            "name": "Test User32870",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": false,
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-04-16T16:27:19.511Z",
            "updatedAt": "2019-04-16T16:27:26.703Z",
            "outputHomeDir": "/trifacta/queryResults/32870@example.com",
            "fileUploadPath": "/trifacta/uploads",
            "awsConfig": {
                "id": 1
            }
        },
        {
            "id": 1,
            "email": "<admin_email>",
            "name": "Administrator",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": true,
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-04-16T07:44:04.299Z",
            "updatedAt": "2019-04-16T16:28:16.379Z",
            "outputHomeDir": "/trifacta/queryResults/admin@example.com",
            "fileUploadPath": "/trifacta/uploads",
            "awsConfig": {
                "id": 3
            }
        }
    ]
}

For more information, see API People Get v4.

Step - Create awsConfig object

Create the AWS configuration object.

Request:

{
    "credentialProvider": "default",
    "personId": 2,
    "key": "<my_key>",
    "secret": "<my_secret>",
    "defaultBucket": "main_bucket",
    "extraBuckets":["extra-bucket1","extra-bucket2"]
}

{
    "credentialProvider": "temporary",
    "personId": 2,
    "role":"<my_iam_role_object>",
    "defaultBucket":"main_bucket",
    "extraBuckets":["extra-bucket1","extra-bucket2"]
}

Response for Method 2:

{
    "extraBuckets": [
        "extra-bucket1",
        "extra-bucket2"
    ],
    "id": 6,
    "defaultBucket": "main_bucket",
    "credentialProvider": "temporary",
    "externalId": null,
    "activeRoleId":"4",
    "updatedAt": "2019-04-16T23:06:32.049Z",
    "createdAt": "2019-04-16T23:06:32.047Z",
    "credential": null
}

Step - Verify Authentication

To verify that the above configuration works:

1. User id=2 should login to the application.
2. User uploads assets through the Import Data page.
3. User creates a short recipe that modifies these assets.
4. User runs a job on that recipe to generate output to the default S3 bucket in CSV or JSON for downloading.
5. User verifies that the results can be downloaded.

Step - For Method 2, assign new IAM role to awsConfig object

If you need to change the IAM role ARN for a user, you can modify the awsConfig object for that user with the new role information. 

The following request modifies the awsConfig id=6.

Request:

{
    "role":"<my_iam_role_object_3>"
}

Response:

{
    "extraBuckets": [
        "extra-bucket1",
        "extra-bucket2"
    ],
    "id": 6,
    "defaultBucket": "main_bucket",
    "credentialProvider": "temporary",
    "externalId": null,
    "activeRoleId":"<awsRoleId>",
    "updatedAt": "2019-04-16T23:06:32.049Z",
    "createdAt": "2019-04-16T23:06:32.047Z",
    "credential": null
}

Step - Switching Authentication Methods

Suppose you have created your awsConfig objects to use the AWS Key-Secret method of authenticating. You have now created a set of IAM roles that you would like to assign to your .

The generalized workflow for completing this task is the following:

1. Acquire the identifiers for all of the awsConfigs you wish to modified. For each awsConfig, retain the personId, so that you can map your configuration changes to individuals. See API AWSConfigs Get v4.
   1. For more information on getting your list of users, see API People Get v4.

2. For each user account (personId), you must identify the IAM role that you wish to assign it.

3. Use the following modification to the awsConfig object to switch to using the IAM role for the user:

Request:

{
    "credentialProvider": "temporary",
    "role":"<my_iam_role_object>"
}

Response for Method 2:

{
    "extraBuckets": [
        "extra-bucket1",
        "extra-bucket2"
    ],
    "id": <awsConfigId>,
    "defaultBucket": "main_bucket",
    "credentialProvider": "temporary",
    "externalId": null,
    "activeRoleId":"<awsRoleId>",
    "updatedAt": "2019-04-16T23:06:32.049Z",
    "createdAt": "2019-04-16T23:06:32.047Z",
    "credential": null
}

Notes: