Onboard New Cloud Account
POST {{cb_url}}/public-cloud/account-management/v1/orgs/{{cb_org_key}}/accounts
Onboard New Cloud Account
Permissions Required
| Permission (.notation name) | Operation(s) |
|---|---|
| public.cloud.accounts | CREATE |
Request Schema
{
"cloud_provider_account_id": "<string>",
"cloud_provider": "<string>",
"name": "<string>",
"owner_name": "<string>",
"owner_email": "<string>",
"environment": "<string>",
"credential": {
"role_arn": "<string>",
"external_id": "<string>"
},
"regions": ["<string>"],
"created_by": "<string>",
"updated_by": "<string>",
"event_stream_status": "<string>",
"ssm_document_status": "<string>",
"parent_id": "<string>",
"aws_account_joined_method": "<string>",
"new_accounts_discovered": <boolean>,
"aws_account_type": "<string>",
"is_onboarded": <boolean>,
"account_discovery_status": "<string>"
}
Request Body
{"cloud_provider_account_id"=>"1234567890", "cloud_provider"=>"AWS", "name"=>"AWS Account 1", "owner_name"=>"Test", "owner_email"=>"test@testorg.com", "environment"=>"DEV", "credential"=>{"role_arn"=>"arn:aws:iam::1234567890:role/aws-service-role/spot.amazonaws.com/AWSServiceRoleForEC2Spot", "external_id"=>"afd5813b-e3c6-471a-b30e-3a8577f89111"}, "regions"=>["us-east-1"]}
RESPONSES
status: OK
{"name":"AWS Account 1","owner_name":"Test","owner_email":"test@testorg.com","environment":"DEV","credential":{"verification_status":"IN_PROGRESS","verification_code":null,"verification_message":null,"last_verified_time":null,"role_arn":"arn:aws:iam::1234567890:role/aws-service-role/spot.amazonaws.com/AWSServiceRoleForEC2Spot","external_id":"afd5813b-e3c6-471a-b30e-3a8577f89111","application_id":null,"tenant_id":null,"secret_id":null,"secret":null,"secret_expiry":null,"identity_provider_project_no":null,"service_account_email":null,"identity_pool_id":null,"identity_provider_id":null},"last_updated_time":"2023-08-31T15:26:30.703570Z","regions":["us-east-1"],"created_by":"ABCD1234","updated_by":"ABCD1234","event_stream_status":null,"ssm_document_status":null,"parent_id":null,"aws_account_joined_method":null,"new_accounts_discovered":false,"aws_account_type":"INDEPENDENT","is_onboarded":true,"account_discovery_status":null,"parent_account_id":null,"cloud_provider_account_id":"1234567890","cloud_provider":"AWS"}