> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-xdr/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/ibm-cloud-cloud-onboarding/prerequisites-for-onboarding-ibm-cloud.md).

# Prerequisites for onboarding IBM Cloud

Before you begin onboarding IBM Cloud, review the required permissions, tools, and credentials.

Before you begin onboarding IBM Cloud, ensure that you meet the following prerequisites.

## Permissions

You need permissions in both Cortex XDR and IBM Cloud.

* **Cortex XDR:** You must have a Cortex XDR role with Data Sources - View & Edit permissions to add and configure cloud instances. This permission is included in the following built-in roles: Instance Administrator, Security Admin, and IT Admin.
* **IBM Cloud:** You must be able to create service IDs, API keys for service IDs, custom roles, and access policies in the IBM Cloud account, and attach tags to service IDs. The user who runs the Terraform template typically needs the Administrator role on all account management services and all IAM-enabled services in the account. IBM Cloud lets you assign access only for roles you hold yourself, so the template can grant the service ID its Viewer, Reader, and custom roles only if you hold at least those roles.

To attach tags to the service ID, your IBM Cloud API key also needs the `global-search-tagging.tag.attach-user-tag` permission. The Administrator and Editor platform roles include this permission.

## IBM Cloud administrator API key

Terraform authenticates to IBM Cloud with an API key that you create for your own IBM Cloud user. Create the key before you begin. For instructions, see [Managing user API keys](https://cloud.ibm.com/docs/account?topic=account-userapikey) in the IBM Cloud documentation.

You use this administrator API key only to run the Terraform template. Cortex XDR never receives or stores it. It's a different key from the service ID API key that the template creates for Cortex XDR. For details, see [IBM Cloud security model and authentication](https://cortex-docs.paloaltonetworks.com/cortex-xdr/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/ibm-cloud-cloud-onboarding/ibm-cloud-security-model-and-authentication.md).

## Tools

Install the following tools on the machine where you run the Terraform template:

* Terraform version 1.4 or later. You can download Terraform from the [Terraform website](https://developer.hashicorp.com/terraform/install).
* Access to the Terraform Registry, so that `terraform init` can download the IBM Cloud Terraform provider (`IBM-Cloud/ibm`) version 2.4.0 or later.

## Additional prerequisites

Before you begin onboarding IBM Cloud, ensure that:

* The IBM Cloud administrator API key that you use to run Terraform belongs to the account you want to onboard. Terraform creates the Cortex XDR resources in the account of this API key.
* You have a secure location to store the Terraform files and the Terraform state file for each account you onboard. You need them later to rotate the API key or to offboard the account.

{% hint style="info" %}
**Note:** If you are moving from Prisma Cloud and you already onboarded the IBM Cloud account there, you can onboard the same account to Cortex XDR. The Cortex XDR template creates its own service ID and custom roles, and the custom role action sets are designed so they can coexist with roles that other vendors create.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-xdr/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/ibm-cloud-cloud-onboarding/prerequisites-for-onboarding-ibm-cloud.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
