SAP Cloud ALM

This documentation explains how to create a connector for SAP Cloud ALM in order to enable Cloud ALM monitoring and data collection.

• Cloud ALM Health Monitoring Monitor

Describes how to connect the Redpeaks collector to a SAP Cloud ALM environment.

1. + Add Connector → Web Service
2. Authentication type → CLOUD_ALM
3. Authentication server → OAuth token endpoint URL (see section below)
4. ClientId → OAuth Client ID (see section below)
5. ClientSecret → OAuth Client Secret (see section below)
6. URL → Cloud ALM API base URL (see section below)
7. Save and test

All credentials for the SAP Cloud ALM API are obtained from SAP Business Technology Platform (BTP) — there is no independent client registration inside Cloud ALM.

Prerequisites

• Your user must have the Global Account Administrator role in the SAP Cloud ALM global account.
• The user must be a member of the subaccount that contains the SAP Cloud ALM subscription.

Step 1: Configure Entitlements

1. Open the SAP BTP Cockpit.
2. Select the global account that contains your SAP Cloud ALM entitlement, then open the subaccount that contains your SAP Cloud ALM subscription.
3. In the left menu, go to Entitlements → Edit → Add Service Plans.
4. Select the entitlement SAP Cloud ALM API.
5. Under Available Plans, check standard.
6. Choose Add 1 Service Plan → Save.

Step 2: Create or Update the SAP Cloud ALM API Service Instance

1. In the subaccount, go to Services → Instances and Subscriptions.
2. If an instance already exists, choose Actions (⋯) → Update.
3. If no instance exists, choose Create.
4. Under Basic Info, provide:
   1. Service: SAP Cloud ALM API
   2. Plan: standard
   3. Runtime Environment: Other
   4. Instance Name: A meaningful name (maximum 32 characters; alphanumeric, periods, hyphens; use underscores instead of spaces)
5. (Recommended) Add the required scopes by inserting the following JSON in the Parameters section (see JSON below).
6. Choose Create (or Update).

JSON for Parameters section:

{
    "xs-security": {
        "xsappname": "<Your Instance Name>",
        "authorities": [
            "$XSMASTERAPPNAME.calm-api.<Required Scope 1>",
            "$XSMASTERAPPNAME.calm-api.<Required Scope 2>"
        ],
        "oauth2-configuration": {
            "credential-types": ["binding-secret"]
        }
    }
}

Replace <Your Instance Name> with your instance name (or the instance GUID when updating). Replace the scopes with the ones you need (see API Scopes).

Step 3: Create a Service Binding (recommended) and get the credentials

1. Next to the instance, choose Actions (⋯) → Create Binding.
2. Enter a name for the binding → Create.
3. Next to the new binding, choose Actions (⋯) → View.

Alternative: Create a Service Key

1. Next to the instance, choose Actions (⋯) → Create Service Key.
2. Enter a name → Create.
3. View or download the JSON.

Result – Where to find the values in the JSON

After viewing the Service Binding (or Service Key), you will see a JSON similar to this:

{
  "endpoints": {
    "Api": "https://eu15.alm.cloud.sap/api"
  },
  "uaa": {
    ...
    "clientid": "sb-...",
    "clientsecret": "...",
    "url": "https://<your-subaccount>.authentication.eu15.hana.ondemand.com",
    ...
  }
}

1. URL (Cloud ALM API base URL) = value of endpoints.Api Remove the trailing /api at the end. Example: https://eu15.alm.cloud.sap (without /api).
2. ClientId = value of clientid (inside the uaa section)
3. ClientSecret = value of clientsecret (inside the uaa section)
4. Authentication server (OAuth Token Endpoint) = value of uaa.url
   1. Do NOT add /oauth/token at the end. Example:

      https://<your-subaccount>.authentication.eu10.hana.ondemand.com

5. URL (Cloud ALM API base URL) = value of endpoints.Api
   1. Remove the trailing /api at the end. Example:

      https://eu15.alm.cloud.sap

• You only need one service instance / binding per Cloud ALM tenant.
• Instance name restrictions: maximum 32 characters. Allowed characters: alphanumeric, periods (.), hyphens (-). Use underscores instead of spaces.
• The clientsecret is only shown once when you create the binding/key. Save it securely.

• If you cannot see the SAP Cloud ALM API service: make sure the standard plan entitlement has been added to the subaccount (Global Account → Entitlements → Edit).
• Ensure your user has the Global Account Administrator role and is a member of the subaccount.
• For scope-related issues or further support, create a case on component SV-CLM-API.

This procedure is based on the official SAP documentation: Enabling SAP Cloud ALM APIs.