Manage your Astra enterprise
You can create multiple Astra organizations to separate resources, billing, projects, access, and more. Organizations are either standalone or part of an enterprise:
-
Standalone organizations: Organizations on the Free plan have no relationship to each other, and they are managed independently.
-
Enterprise organizations: On the Marketplace or Enterprise subscription plan, you can use enterprise organization management to centrally manage multiple related organizations under one enterprise. Enterprise organizations still have their own administrators, users, and resources; there are limits on administrative actions from the enterprise level, as explained in What is enterprise organization management.
All organizations on a Marketplace or Enterprise subscription plan belong to an enterprise, even if the enterprise has only one organization.
When you create additional organizations, you can choose to link them to the existing enterprise or not. If the organization isn’t linked to an enterprise, then it is created as a standalone organization on the Free plan.
Your Astra account can belong to both types of organizations, and you can be both an Enterprise Administrator and an Organization Administrator.
What is enterprise organization management
Enterprise organization management is a centralized administration feature that allows you to manage multiple organizations under one enterprise.
Enterprise organization management is limited to specific administrative activities for the organizations within an enterprise:
- At the enterprise scope, you can do the following
-
-
Change the enterprise display name.
-
Add organizations to the enterprise.
-
Manage enterprise users and roles.
-
Manage enterprise application tokens.
-
View the credit balance and consumption breakdown for all organizations in your enterprise.
-
Get usage reports for all organizations in your enterprise.
-
- At the enterprise scope, you cannot do the following
-
-
Manage subscription plans and payment methods.
Subscription plans are managed exclusively at the organization level. Payment methods aren’t managed within the Astra Portal. For example, the payment method for a Marketplace subscription plan is managed in the relevant cloud marketplace account.
-
Directly interact with resources in organizations, such as databases. This interaction happens at the organization level only.
Enterprise organization management separates organization and enterprise permissions so that you can grant the appropriate level of access to each user throughout your administrative hierarchy.
-
Manage organizations that are outside your enterprise, even if you are the Organization Administrator for that organization.
Enterprise organization management strictly applies to the organizations attached to your enterprise. If you need to manage an organization that is outside your enterprise, you must switch to that organization.
-
Access enterprise settings
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
In the Settings navigation menu, click the category of settings that you want to manage:
-
General:
-
Overview: Manage organizations in your enterprise
-
Billing: View credit balance, inspect consumption breakdown, and download usage reports
-
Users: Manage enterprise users
-
Get the enterprise ID
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
On the General page, click copy_all Copy to copy the enterprise ID.
Change the enterprise name
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
On the General page, click edit Edit to change the enterprise’s display name.
Change the enterprise email address
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
On the General page, click Update email, enter the desired email address, and then click Update email.
DataStax sends a verification email to the new email address. To confirm this change, you or another Enterprise Administrator must have access to the new email address.
-
Follow the link in the verification email to finalize the change.
Manage enterprise application tokens
Use enterprise application tokens to authenticate DevOps API operations that require enterprise permissions.
For instructions and more information, see Manage application tokens.
Manage organizations in your enterprise
At the enterprise level, you can view, add, and remove organizations in your enterprise.
All other organization administration takes place at the organization level. For information about organization settings, see Manage Astra organizations.
View organizations in your enterprise
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization or enterprise, and then select your enterprise.
-
In the Settings navigation menu, click Overview to view a list of all organizations in your enterprise.
Add an organization to your enterprise
You can create new organizations directly in your enterprise and transfer existing organizations into your enterprise.
Transfer an organization to your enterprise
-
Transfer between enterprises
-
Transfer a standalone organization to an enterprise
|
If either enterprise is managed by an IBM SaaS account, you must contact IBM Support for assistance with transferring organizations. Manual transfers aren’t possible for IBM SaaS-managed enterprises. |
If you are the administrator for multiple enterprises that aren’t managed by IBM SaaS accounts, you can transfer organizations between them:
-
If you aren’t the administrator for both enterprises, contact the other enterprise administrator to get access to that enterprise. If this is not possible, contact IBM Support for assistance with the enterprise transfer.
-
When you have access to both enterprises, in the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization or enterprise, and then select the enterprise that the organization currently belongs to.
-
On your enterprise’s Overview page, find the organization you want to transfer, click More, and then select Move organization.
This option is available only if you are an Enterprise Administrator for two or more enterprises.
-
Select the enterprise where you want to send the organization.
-
Click Move Organization to initiate the transfer process.
The transfer process can take a few minutes.
|
Once an organization belongs to an enterprise, you can only transfer it to other enterprises. It cannot be reverted to a standalone organization. |
Standalone organizations are organizations that don’t belong to any enterprise. If the organization already belongs to another enterprise, follow the steps to transfer between enterprises.
You can contact IBM Support to request a transfer only if all of the following conditions are met:
-
The organization isn’t a default (personal) organization.
-
You are the Enterprise Administrator.
-
You are the organization’s Organization Administrator.
Remove an organization from your enterprise
After you add an organization to your enterprise, you can either delete the organization or transfer the organization to another enterprise.
Restrict organization deletion
An Enterprise Administrator can prevent Organization Administrators from deleting organizations that belong to the enterprise:
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
On the Settings navigation menu, click Security.
-
Enable Restrict deletion.
Once this setting is enabled, only users with the Manage Enterprise Organization permission can delete organizations that belong to the enterprise.
Manage enterprise billing and usage
On your enterprise’s Billing page, you can see aggregate credit balance and consumption for all organizations in your enterprise, as well as consumption breakdowns by organization, resource type, and activity type. For more information, see View credit balance and consumption details.
Additionally, you can download usage reports:
Download a complete monthly enterprise usage report
-
Astra Portal
-
DevOps API
In the Astra Portal, you can download usage reports in CSV format for all organizations in an enterprise:
-
In the Astra Portal header, click Settings.
-
In the Settings navigation menu, click the name of the active organization, and then select your enterprise.
-
In the Settings navigation menu, click Billing.
-
In the Usage Reports section, click Usage reports, and then select the report that you want to download:
-
Download daily usage (CSV): Download daily usage history for the given month.
-
Download PCU allocation (CSV): Download a PCU usage report for the given month. This report is available only for organizations with PCU groups in months where PCU usage occurred.
PCU usage isn’t included in the daily usage report.
-
-
Open and review the usage report.
Daily usage report contents
The daily usage report CSV file includes the following columns:
-
PRODUCT: The name of the Astra product or service generating usage. -
ORG_ID: The organization ID. -
ORG_NAME: The organization name. -
RESOURCE_ID: The ID of the resource generating usage, such as a database or streaming tenant. -
RESOURCE_NAME: The resource name. -
REGION: The region where the resource is deployed and generating usage. -
CLOUD_PROVIDER: The cloud provider that hosts the givenREGION. -
CLASSIFICATION: The region pricing classification, such asstandardorpremium. -
ZONE: Indicates if usage is coming from a specific zone, includingna(North America),apac(Asia Pacific), oremea(Europe, Middle East, Africa). -
CLUSTER_SIZE: For Astra Managed Cluster databases, this is the cluster size, such asc10orc20. For Astra DB Serverless databases, this is empty. -
AZ_COUNT: For Astra DB Serverless databases, this is3because these databases are triple replicated to three availability zones. For Astra Managed Cluster databases, this is empty regardless of actual replication. -
USAGE_TYPE: The specific type of usage that was generated. -
USAGE: The amount of usage generate. -
USAGE_UNIT: The unit of measurement forUSAGE, such ashour,gib, ormillion. -
CURRENCY_TYPE: The currency type used for billing. -
UNIT_PRICE: The price per unit of usage in the givenCURRENCY_TYPE. -
CALCULATED_COST: The total cost for an amount ofUSAGEduring the given time period defined by theTIMESTAMPcolumns. -
BREAKDOWN_START_TIMESTAMP: The beginning of the period for which usage was calculated. -
BREAKDOWN_END_TIMESTAMP: The end of the period for which usage was calculated.
The daily usage report doesn’t include PCU usage.
-
Use the DevOps API to generate and download a detailed monthly usage report for all organizations and resources in your enterprise.
It can take some time to generate the report, depending on the number of organizations and resources in your enterprise, because this report contains detailed usage data. To get usage summaries for specific organizations or resources, see Get filtered usage for a specific time range and Get filtered usage for the current month.
-
Initialize report generation with
POST v2/enterprises/billing-reports/generate-report:curl -sS -L -X POST "https://api.astra.datastax.com/v2/enterprises/billing-reports/generate-report" \ --header "Authorization: Bearer ENTERPRISE_APPLICATION_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "month": "REPORT_MONTH_NUMBER_STRING", "year": "REPORT_YEAR_NUMBER_STRING" }'Replace the following:
-
ENTERPRISE_APPLICATION_TOKEN: Your enterprise application token. -
REPORT_MONTH_NUMBER_STRINGandREPORT_YEAR_NUMBER_STRING: The month and year for which you want to generate the report represented as string-formatted numbers, such as"02"and"2025".This endpoint cannot retrieve data prior to November 2024.
-
-
From the response, get the
reportId. -
Get a link to download the generated report as a CSV file with
GET v2/enterprises/billing-reports/REPORT_ID:curl -sS -L -X GET "https://api.astra.datastax.com/v2/enterprises/billing-reports/REPORT_ID" \ --header "Authorization: Bearer ENTERPRISE_APPLICATION_TOKEN" \ --header "Content-Type: application/json"Replace the following:
-
ENTERPRISE_APPLICATION_TOKEN: Your enterprise application token. -
REPORT_ID: ThereportIdreturned from/v2/enterprises/billing-reports/generate-report.
-
-
From the response, use the
csvDownloadUrlto retrieve the generated report.The availability of the download link depends on the report
status:-
PENDING: The report is queued for generation -
INITIATED: The report is being generated -
COMPLETED: The report is ready for download -
FAILED: The report failed to generate
-
-
Open and review the usage report.
Usage report contents
The usage report CSV file includes the following columns:
-
PRODUCT: The name of the Astra product or service generating usage. -
ORG_ID: The organization ID. -
ORG_NAME: The organization name. -
RESOURCE_ID: The ID of the resource generating usage, such as a database or streaming tenant. -
RESOURCE_NAME: The resource name. -
REGION: The region where the resource is deployed and generating usage. -
CLOUD_PROVIDER: The cloud provider that hosts the givenREGION. -
CLASSIFICATION: The region pricing classification, such asstandardorpremium. -
ZONE: Indicates if usage is coming from a specific zone, includingna(North America),apac(Asia Pacific), oremea(Europe, Middle East, Africa). -
CLUSTER_SIZE: For Astra Managed Cluster databases, this is the cluster size, such asc10orc20. For Astra DB Serverless databases, this is empty. -
AZ_COUNT: For Astra DB Serverless databases, this is3because these databases are triple replicated to three availability zones. For Astra Managed Cluster databases, this is empty regardless of actual replication. -
USAGE_TYPE: The specific type of usage that was generated. -
USAGE: The amount of usage generate. -
USAGE_UNIT: The unit of measurement forUSAGE, such ashour,gib, ormillion. -
CURRENCY_TYPE: The currency type used for billing. -
UNIT_PRICE: The price per unit of usage in the givenCURRENCY_TYPE. -
CALCULATED_COST: The total cost for an amount ofUSAGEduring the given time period defined by theTIMESTAMPcolumns. -
BREAKDOWN_START_TIMESTAMP: The beginning of the period for which usage was calculated. -
BREAKDOWN_END_TIMESTAMP: The end of the period for which usage was calculated.
This report doesn’t include PCU usage.
-
Get filtered usage for the current month
Use POST v2/enterprises/consumption to get a usage summary for the current month, optionally filtering on specific organizations or resources.
To get usage for previous months or periods shorter than one month, see Get filtered usage for a specific time range.
curl -sS -L -X POST "https://api.astra.datastax.com/v2/enterprises/consumption" \
--header "Authorization: Bearer ENTERPRISE_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"organizations":
[
{
"orgId": "ORGANIZATION_ID",
"products": [
{
"productName": "pcu",
"resourceIds": [
"RESOURCE_ID",
"RESOURCE_ID"
]
}
]
}
]
}'
Replace the following:
-
ENTERPRISE_APPLICATION_TOKEN: Your enterprise application token. -
ORGANIZATION_ID: Provide one or more organization IDs to retrieve usage for specific organizations in your enterprise. If you specify multiple organizations, each organization must belong to its own object within theorganizationsarray.To retrieve usage for all organizations in your enterprise, omit
organizations. However, DataStax recommends specifying at least one organization due to the amount of data this request can return for enterprises with many organizations. If you need to get usage data for your entire enterprise, consider downloading an enterprise usage report CSV file. -
PRODUCT_NAMEandRESOURCE_ID:productsis an optional array that you can use to retrieve usage for specific resources in an organization.If included, the
productsarray consists of one or more objects, where each object contains aproductNamestring and an array ofresourceIds. For example, the followingproductsobject queries two Astra DB Serverless databases:"products": [ { "productName": "serverless", "resourceIds": [ "dda7ced6-e615-4023-8e7a-1e4429d43437", "0985a909-ecef-46e0-acf2-e1a8ebd51485" ] } ]Valid values for
productNameincludeserverless(Astra DB Serverless databases),managed_cluster(Astra Managed Cluster databases),pcu, orstreaming(Astra Streaming tenants).To retrieve usage for all resources associated with a specific product, omit
resourceIdsor pass an empty array. To retrieve usage for all products and resources, omitproducts.For examples of product names and resource IDs, send a request without
products. The response includes usage forproducts, includingproductNameandresourceIdvalues that you can use to filter subsequent requests.
A successful request returns the following usage summary data in JSON format:
-
totalCost: Total cost for the queried usage (current month, organization, products, and resources). -
currencyType: The currency in which costs are calculated. -
creditsInfo: The type of credits, based on the subscription plan. -
total: Total credits available for the current month. -
consumed: Credits consumed in the current month. -
remaining: Credits remaining for the current month. -
organizations: An array of objects providing usage and cost breakdowns by organization, further subdivided by products and resources. Individual resources can be broken into additional usage categories, such as regional usage.
To get a detailed usage report, see Download a complete monthly enterprise usage report.
Get filtered usage for a specific time range
Use POST v2/enterprises/consumption to get a usage summary for a specific time range of up to 31 days, optionally filtering on specific organizations or resources:
curl -sS -L -X POST "https://api.astra.datastax.com/v2/enterprises/consumption" \
--header "Authorization: Bearer ENTERPRISE_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"fromDate": "START_DATE_TIME",
"toDate": "END_DATE_TIME",
"organizations":
[
{
"orgId": "ORGANIZATION_ID",
"products": [
{
"productName": "pcu",
"resourceIds": [
"RESOURCE_ID",
"RESOURCE_ID"
]
}
]
}
]
}'
Replace the following:
-
ENTERPRISE_APPLICATION_TOKEN: Your enterprise application token. -
START_DATE_TIMEandEND_DATE_TIME: An optional date range for which you want to retrieve usage details. The entire range cannot exceed 31 days, and both dates must be in ISO RFC3339 format, such as"2021-05-06T06:13:23.57Z".This endpoint cannot retrieve data prior to November 2024.
-
ORGANIZATION_ID: Provide one or more organization IDs to retrieve usage for specific organizations in your enterprise. If you specify multiple organizations, each organization must belong to its own object within theorganizationsarray.To retrieve usage for all organizations in your enterprise, omit
organizations. However, DataStax recommends specifying at least one organization due to the amount of data this request can return for enterprises with many organizations. If you need to get usage data for your entire enterprise, consider downloading an enterprise usage report CSV file. -
PRODUCT_NAMEandRESOURCE_ID:productsis an optional array that you can use to retrieve usage for specific resources in an organization.If included, the
productsarray consists of one or more objects, where each object contains aproductNamestring and an array ofresourceIds. For example, the followingproductsobject queries two Astra DB Serverless databases:"products": [ { "productName": "serverless", "resourceIds": [ "dda7ced6-e615-4023-8e7a-1e4429d43437", "0985a909-ecef-46e0-acf2-e1a8ebd51485" ] } ]Valid values for
productNameincludeserverless(Astra DB Serverless databases),managed_cluster(Astra Managed Cluster databases),pcu, orstreaming(Astra Streaming tenants).To retrieve usage for all resources associated with a specific product, omit
resourceIdsor pass an empty array. To retrieve usage for all products and resources, omitproducts.For examples of product names and resource IDs, send a request without
products. The response includes usage forproducts, includingproductNameandresourceIdvalues that you can use to filter subsequent requests.
A successful request returns the following usage summary data in JSON format:
-
totalCost: Total cost for the queried usage (current month, organization, products, and resources). -
currencyType: The currency in which costs are calculated. -
creditsInfo: The type of credits, based on the subscription plan. -
total: Total credits available for the current month. -
consumed: Credits consumed in the current month. -
remaining: Credits remaining for the current month. -
organizations: An array of objects providing usage and cost breakdowns by organization, further subdivided by products and resources. Individual resources can be broken into additional usage categories, such as regional usage.
To get a detailed usage report, see Download a complete monthly enterprise usage report.
Manage enterprise users and roles
Enterprise role-based access control (RBAC) allows you to separate enterprise access from organization access.
|
Enterprise RBAC isn’t a global RBAC tool. Enterprise access is separate from organization access. For example, an Enterprise Administrator cannot manage resources in an organization unless they are also an Organization Administrator in that organization. When managing enterprise users and roles, consider your enterprise’s security policies and industry best practices for RBAC, such as the principle of least privilege. For more information about RBAC in Astra, see Manage roles and permissions. |
- Enterprise users
-
Enterprise membership is separate from organization membership. Users can belong to an enterprise without belonging to any organizations, and they can belong to individual organizations without access to the enterprise level.
By default, an enterprise invitation adds a user to the enterprise only.
If you want to add user to your enterprise and one or more organizations, you must send separate invitations for the enterprise and each organization. The same principle applies to removing users and editing user roles.
Memberships are managed separately to support the separation of duties and the principle of least privilege throughout the entire enterprise hierarchy. For example, a user who is a Database Administrator in one organization might not need the same level of access in another organization.
For instructions and more information, see Manage users.
- Enterprise roles and permissions
-
Enterprise roles are separate from organization roles. The actions that a user can take at the enterprise level depend on the user’s enterprise role. The actions that a user can take within a specific organization depend on the user’s role in that organization.
You can create custom enterprise roles or use the default enterprise roles:
For more information about enterprise permissions and creating custom enterprise roles, see Manage roles and permissions.