Use this to onboard an AWS account in Umbrella Cost.
As an enterprise customer, provide the account id and name.
The MSP request contains slightly more information.
The output from running these commands are two files. These files should be run within AWS.
The process is described in Umbrella Cost documentation.
Your first account must be onboarded using The Umbrella Cost user interface.
Additional accounts can be onboarded using API requests.
Note the account API key must contain account and division for all requests.
To onboard a new account. Use an existing account key and division.
Parameters
| Name | Located In | Description | Required |
|---|---|---|---|
| account_id | Query | The payer account ID to onboard to Umbrella | Yes |
| bucketName | body | The bucket name to be created. Default is "cur-account_ID", provide your own name if you do not want to create it with the default name | Yes |
| bucketRegion | body | Region for bucket creation. Default is "us-east-1" | Yes |
Parameters for MSPs
Dedicated accounts
When the accountType = dedicated
These parameters are mandatory:
- resellerCustomerName
- isCustomerSelfManaged
- autoAssignLinkedAccounts
| Name | Located In | Description | Required |
|---|---|---|---|
| accountType | body | Values: "dedicated" (default) or "shared" | optional |
| resellerCustomerId | body | Reseller customer code. In case accountType = dedicated | optional |
| resellerCustomerName | body | Display name for the reseller customer. Required in case accountType = dedicated | optional |
| isCustomerSelfManaged | body | Relevant for accountType = dedicated, Values: 1 - Self managed, 0 - not self managed | optional |
| resellerCustomerDomain | body | Domain for reseller customer. Will be used for SSO. The domain should match existing domains for the customer, or be a new domain in Umbrella's records | optional |
| autoAssignLinkedAccounts | body | Relevant for accountType = dedicated. Values: 1 - auto assign, 0 - do not auto assign | optional |
| excludedLinkedAccountMatch | body | Exclude all linked accounts that matches the string, example "SP*", relevant in case autoAssignLinkedAccounts is "1" | optional |
Response
This API request will create a script you need to run in AWS. Instructions to run this script appear here.