How to create a service key in SAP Cloud ALM - SAP/alm-plug-in-for-grafana GitHub Wiki
SAP Cloud ALM and Service keys
To successfully connect your ALM Plugin for Grafana to SAP Cloud ALM, you need a service key in the SAP Cloud ALM API instance so that the plugin can authenticate against the SAP Cloud ALM tenant. The following steps describe the whole process.
Prerequisites:
- You have access to the subaccount
- A Cloud Foundry space has been created
Step by Step
- Connect to your SAP Cloud ALM subaccount and select the
Instances and Subscription
section under theServices
area, then click on theCreate
button.
- Select the
SAP Cloud ALM API
Service, assign a dedicated space (create one if needed) in the Cloud Foundry environment use a proper name for the instance, then click on theNext
button.
- Copy the following scope and paste it in the instance parameter area (you can chose your own
xsappname
, in this case we selected cloud-alm-api-grafana), then click on theCreate
button.
{
"xs-security": {
"xsappname": "cloud-alm-api-grafana",
"authorities": [
"$XSMASTERAPPNAME.calm-api.analytics.read",
"$XSMASTERAPPNAME.calm-api.analytics.providers.read",
"$XSMASTERAPPNAME.calm-api.demo-tasks.read",
"$XSMASTERAPPNAME.calm-api.projects.read",
"$XSMASTERAPPNAME.calm-api.projects.write",
"$XSMASTERAPPNAME.calm-api.tasks.read",
"$XSMASTERAPPNAME.calm-api.tasks.write",
"$XSMASTERAPPNAME.calm-api.tests.read",
"$XSMASTERAPPNAME.calm-api.integration-monitoring.read",
"$XSMASTERAPPNAME.calm-api.bsm.read",
"$XSMASTERAPPNAME.calm-api.defects.read",
"$XSMASTERAPPNAME.calm-api.requirements.read"
]
}
}
- Once the new instance is generated, create a new service key by selecting the proper line in the
Instances
table and clicking on theAction
button (the three dots on the top right section of the screen)
- Assign a name to the service key and click on the
Create
button
You now have created a Service Key that can be used to configure the ALM Plugin, please refer to Configure a new path in the plugin for further details.