Create an AWS configuration object, depending on the credential provider type. For more information on credential provider types, see Configure for AWS.

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:

{ 
    "mode": "user",
    "credentialProvider": "default",
    "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:

{
    "mode": "user",
    "credentialProvider": "temporary",
    "role":"<my_iam_role>",
    "defaultBucket":"testing",
    "extraBuckets":["extra-one"]
}

 

Response

Response Status Code - Success:  201 - Created

Response Body - default credential provider:

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

Response Body - temporary credential provider:

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

Reference

For more information, see API AWSConfigs Get v4.