API Reference
Start typing to search…

Get the onboarding config for a cloud asset integration.

get
https://api.cast.ai/inventory/v1beta/organizations//cloud-asset-integrations:getOnboardingConfig

Get the onboarding config for a cloud asset integration. Returns structured configuration including provider-specific permissions and identifiers needed for programmatic onboarding (e.g. Terraform).

Path Params
string
required

The ID of the organization.

Query Params
string
enum

The cloud provider.

Allowed:
gcpConfig.organizationIds
array of strings

Optional GCP organization IDs. If provided, the onboarding script will attempt to create organization-level IAM bindings only for the specified organizations.

gcpConfig.organizationIds
string

Optional GCP project ID. If provided, the onboarding script will create a service account in this project.

gcpConfig.projectIds
array of strings

Optional GCP project IDs. If provided, the onboarding script will create IAM bindings only in these projects.

gcpConfig.projectIds
string

Optional Azure tenant ID. If provided, the onboarding script will setup the integration for the specified tenant. Otherwise, it will programatically obtain the tenant ID from the Azure CLI.

azureConfig.subscriptionIds
array of strings

Optional list of Azure subscription IDs to restrict the integration to. If provided, the onboarding script will only setup access for these subscriptions. Otherwise, it will setup access for all available subscriptions.

azureConfig.subscriptionIds
string

S3 bucket name containing a CUR export. If provided, the onboarding script will create an IAM policy to allow access to the specified bucket.

string

Region of the S3 bucket containing the CUR export. Must be provided if s3_bucket_name is provided.

string

Optional AWS account ID containing the CUR export for organization-scoped integrations. If not provided, defaults to management account ID.

boolean

If true, the onboarding script will force account-scoped integration even if it's ran by a management account.

awsConfig.accountIds
array of strings

Optional list of AWS account IDs to restrict the integration to. For organization-scoped integrations, the onboarding script will only deploy roles to these accounts. The integration will only sync resources from these accounts.

awsConfig.accountIds
string
enum

The scope of the cloud asset integration. If not provided, defaults to ALL.

Allowed:
Responses

Updated about 2 hours ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 hours ago