> 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/ibm-cloud-provider-permissions.md).

# IBM Cloud provider permissions

List of IBM Cloud roles, access policies, and permissions that Cortex XDR requests during onboarding to enable continuous monitoring of your IBM Cloud account.

When you onboard IBM Cloud with the onboarding wizard, Cortex XDR requests only the read-only access it needs for discovery, following the principle of least privilege. IBM Cloud onboarding is performed at the account scope with a single Terraform authentication template. The template creates a read-only service ID, assigns it built-in and custom roles through access policies, and creates an API key for it.

Permissions fall into the following categories:

* **Required for all onboarding:** Base and Discovery Engine permissions. These provide the asset visibility that all Cortex XDR features depend on, and you can't deselect them.
* **Conditional upon selected capabilities:** Not currently applicable. Additional capabilities aren't currently supported for IBM Cloud. For details, see [Capabilities not currently supported](#capabilities-not-currently-supported).

The following reference tables are organized by identity, access policy, and custom role, with the IBM Cloud actions that Cortex XDR requests and their purpose:

* [Base (including Discovery Engine)](#base-including-discovery-engine)
* [Capabilities not currently supported](#capabilities-not-currently-supported)

## Base (including Discovery Engine)

Base and Discovery Engine permissions are the mandatory access policies required to onboard your IBM Cloud account to Cortex XDR. They provide read-only inventory of IBM Cloud resources and account configuration.

{% hint style="warning" %}
**Important:** The Base and Discovery Engine capabilities are mandatory. Cortex XDR deploys them automatically when you onboard an IBM Cloud account. This onboarding includes no other capabilities.
{% endhint %}

### Cortex XDR service ID: `cortex-{suffix}-service-id`

This IBM Cloud service ID is the identity that Cortex XDR authenticates as. Cortex XDR uses an API key for the service ID, which it stores encrypted. The service ID has only Viewer and Reader roles and read-only custom roles. It has no permission to create, change, or delete your resources.

|                   |                                                                                                                                                                             |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Created when      | Account onboarding only.                                                                                                                                                    |
| Assigned to       | Cortex XDR, through the service ID API key that you provide when you manually connect the cloud instance.                                                                   |
| Assignment scope  | IBM Cloud account.                                                                                                                                                          |
| Used by           | Cortex XDR asset discovery to read resource and account configuration.                                                                                                      |
| Regional scope    | All supported IBM Cloud regions for resource discovery. Global for account-level resources.                                                                                 |
| Resources created | Service ID, API key (`cortex-{suffix}-api-key`, plus `cortex-{suffix}-api-key-2` after the first rotation), custom roles, access policies, and user tags on the service ID. |

### Access policies

The template assigns the following access policies to the service ID. Each policy assigns built-in roles, custom roles, or both, to the service ID on a specific IBM Cloud service or resource type.

| Access policy target                        | Roles                           | Purpose                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| All IAM-enabled services in the account     | Viewer, Reader                  | Read the configuration and metadata of resources across all IAM-enabled services in the account. Cortex XDR uses this for asset discovery and security posture assessment. The Viewer and Reader roles are read-only, and can't change any resource or read the data stored in your resources beyond configuration metadata. |
| Resource groups                             | Viewer                          | Read resource groups in the account. Cortex XDR uses this to map resources to their resource groups for asset inventory.                                                                                                                                                                                                     |
| IAM Access Management service, custom roles | Viewer                          | Read the custom roles defined in the account. Cortex XDR uses this for asset inventory.                                                                                                                                                                                                                                      |
| IAM Access Groups service                   | Viewer                          | Read access groups and their members and policies. Cortex XDR uses this for asset inventory.                                                                                                                                                                                                                                 |
| IAM Identity service                        | Viewer, `CortexIamRole{SUFFIX}` | Read service IDs, trusted profiles, and API key metadata, plus the account activity reports and MFA settings that the custom role grants. Cortex XDR uses this for asset inventory and account configuration assessment.                                                                                                     |
| User Management service                     | Viewer                          | Read the users in the account. Cortex XDR uses this for asset inventory.                                                                                                                                                                                                                                                     |
| Activity Tracker Event Routing service      | Viewer                          | Read Activity Tracker targets and routes. Cortex XDR uses this to verify that audit events are routed and retained.                                                                                                                                                                                                          |
| Key Protect service                         | `CortexKmsRole{SUFFIX}`         | Read Key Protect policies and governance configuration through the custom role.                                                                                                                                                                                                                                              |
| Secrets Manager service                     | `CortexSmRole{SUFFIX}`          | List secrets and read secret policies through the custom role.                                                                                                                                                                                                                                                               |
| Support Center service                      | Viewer                          | Read support case metadata in the account. Cortex XDR uses this to complete the inventory of account-level configuration.                                                                                                                                                                                                    |
| Cloud Object Storage service                | `CortexCosRole{SUFFIX}`         | Read bucket security configuration through the custom role.                                                                                                                                                                                                                                                                  |

### Custom roles

The template creates the following custom roles where no built-in IBM Cloud role grants only the read access that Cortex XDR needs. Each custom role contains only read actions. The action set of each role is distinct, so the roles can be created in accounts that already contain read-only roles from other vendors.

In the role names, `{SUFFIX}` is the cloud instance suffix in uppercase, without hyphens or other non-alphanumeric characters.

#### `CortexKmsRole{SUFFIX}` (Key Protect)

This custom role lets Cortex XDR read key management policies and governance configuration in Key Protect. It can't read, use, or change your keys.

| Permission                  | Purpose                                                                                                                                                             |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `kms.instancepolicies.read` | Read Key Protect instance policies. Cortex XDR uses this to assess key management controls, such as dual authorization and allowed networks, at the instance level. |
| `kms.policies.read`         | Read Key Protect key policies, such as rotation policies. Cortex XDR uses this to verify that keys rotate as your encryption governance requires.                   |
| `kms.governance.configread` | Read Key Protect governance configuration. Cortex XDR uses this to verify key management controls across the instance.                                              |

#### `CortexSmRole{SUFFIX}` (Secrets Manager)

This custom role lets Cortex XDR list secrets and read secret policies in Secrets Manager. It can't read secret values.

| Permission                            | Purpose                                                                                                                                                                                 |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `secrets-manager.secret-policies.get` | Read Secrets Manager secret policies, such as rotation policies. Cortex XDR uses this to evaluate whether secrets rotate as your security policy requires.                              |
| `secrets-manager.secrets.list`        | List secrets and their metadata. Cortex XDR uses this to inventory secrets for security posture assessment. This action returns secret metadata only, and doesn't return secret values. |

#### `CortexIamRole{SUFFIX}` (IAM Identity)

This custom role lets Cortex XDR read account activity reports, MFA settings, and service ID details.

| Permission                    | Purpose                                                                                                                                                                                                            |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `iam-identity.report.create`  | Generate an IAM Identity activity report for the account. Cortex XDR uses the report for account configuration assessment. Generating a report doesn't change any identity, key, or access policy in your account. |
| `iam-identity.report.get`     | Read IAM Identity activity reports. Cortex XDR uses this to retrieve the reports that it generates.                                                                                                                |
| `iam-identity.mfa-status.get` | Read the MFA settings of users in the account. Cortex XDR uses this for account configuration assessment.                                                                                                          |
| `iam-identity.serviceid.get`  | Read service ID details. Cortex XDR uses this for asset inventory.                                                                                                                                                 |

#### `CortexCosRole{SUFFIX}` (Cloud Object Storage)

This custom role lets Cortex XDR read the security configuration of Cloud Object Storage buckets. It can't read or change the objects stored in your buckets.

| Permission                                              | Purpose                                                                                                                         |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `cloud-object-storage.bucket.list_bucket_crn`           | List bucket CRNs. Cortex XDR uses this to inventory Cloud Object Storage buckets for asset discovery.                           |
| `cloud-object-storage.bucket.get_firewall`              | Read bucket firewall rules. Cortex XDR uses this to assess network access restrictions on buckets.                              |
| `cloud-object-storage.bucket.get_activity_tracking`     | Read bucket activity tracking configuration. Cortex XDR uses this to verify that bucket access is logged for auditing.          |
| `cloud-object-storage.bucket.get_metrics_monitoring`    | Read bucket metrics monitoring configuration. Cortex XDR uses this to verify observability of bucket usage.                     |
| `cloud-object-storage.bucket.get_protection_management` | Read bucket protection management settings, such as retention and immutability. Cortex XDR uses this to assess data protection. |
| `cloud-object-storage.bucket.get_versioning`            | Read bucket versioning status. Cortex XDR uses this to assess data protection and recoverability.                               |

## Capabilities not currently supported

The following Cortex XDR capabilities aren't currently supported for IBM Cloud onboarding. Cortex XDR requests no permissions for these capabilities:

* Agentless disk scanning (ADS)
* Data security posture management (DSPM)
* Audit logs and flow logs (log collection)
* Registry scanning
* Serverless scanning
* Automation (auto-remediation)

If these capabilities become available for IBM Cloud in a future release, the additional roles and access policies will be documented in dedicated sections of this page.


---

# 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/ibm-cloud-provider-permissions.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.
