Create an AWS configuration object, depending on the credential provider type.

NOTE: APIs for AWS configs apply only to instances of the that are hosted on AWS and configured for user mode of authentication. These configuration objects can be assigned to individual users as needed.


Version:  v4

Required Permissions

Request

Request Type: POST

Endpoint:

/v4/awsConfigs


Request Body - default credential provider:

If the credential provider has been set to default, then individual users must provide their own AWS key/secret combinations. The following is an example request for such an AWS configuration object:

{ 
    "credentialProvider": "default",
    "personId": 4,
    "key": "<my_key>",
    "secret": "<my_secret>",
    "defaultBucket": "testing",
    "extraBuckets":["extra-one"]
}

Request Body - temporary credential provider:

If the credential provider type is set to temporary, then you can use a request similar to the following to create an AWS configuration object that uses the specified IAM role for authentication:

{
    "credentialProvider": "temporary",
    "personId": 4,
    "activeRoleId":"<role_object_id>",
    "defaultBucket":"testing",
    "extraBuckets":["extra-one"]
} 

Response

Response Status Code - Success:  201 - Created

Response Body - default credential provider:

{
    "extraBuckets": [
        "extra-one"
    ],
    "id": 5,
    "defaultBucket": "testing",
    "credentialProvider": "default",
    "externalId": null,
    "activeRoleId": null,
    "createdAt": "2019-04-16T23:03:30.257Z",
    "updatedAt": "2019-04-16T23:03:30.336Z",
    "credential": {
        "id": 22
    }
}

Response Body - temporary credential provider:

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

Reference

ParameterDescription
personId

(optional) When creating an AWS configuration, an administrator can insert the personId parameter to assign the configuration to the internal identifier for the user.

If this parameter is not included, the AWS configuration is assigned to the user who created it.

NOTE: An AWSConfig object can only be assigned at the time of its creation. Each object can be assigned to a single user.

For more information, see API AWSConfigs Get v4.