Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

CCKM API

SAP APIs

search

SAP APIs

CCKM supports the SAP Data Custodian cloud.

Prerequisites

Before you can manage SAP resources on CCKM:

  1. Get a Service Admin User Account

  2. Create a New Group

  3. Create an Application Technical User or a Standard User in ISM

  4. Add the Standard User to Key Management Service

  5. Add SAP Connection on CipherTrust Manager

Click each link to view details.

Get a Service Admin User Account

Get a Service Admin user account from SAP. You will be provided service account credentials (a Data Custodian URL, tenant, and username.) These are required to access the Data Custodian system.

To log on to the SAP cloud as the Service Admin:

  1. Open the URL for your SAP Data Custodian environment.

  2. Enter your tenant name.

  3. Click Continue.

  4. Enter your Username and Password.

  5. Click Login.

Next, you need to create a new group.

Create a New Group

Key Management Service groups are used to organize encryption keys and KMS users. Every group is associated with a specific application type, key store provider, key store type, and service tier.

A user with the Key Administrator role in KMS can create new groups.

To create a new group:

  1. Log on to the SAP cloud as the Key Admin user.

  2. Navigate to Home > Dashboard. The Key Management Service Dashboard is displayed.

  3. On the Key Management Service tab, select an application, for example General/IAAS Applications.

  4. Click Create Group. The Group Details screen is displayed.

  5. Specify the group details:

    1. Specify the Group Name.

    2. Add the Group Description.

    3. (Optional) If applicable, provide the Landscape type, System ID, and Tenant. These fields are optional.

  6. Click Step 2. The Key Store Selection screen is displayed.

  7. Specify the key store details:

    1. Select SAP Data Custodian Provided Key Store.

    2. Select a Key Store (for example, AWS, ESK, Azure).

    3. Select the Key Store Region where your key store is located.

    4. Click Review to verify the group details. Click Edit to make any changes.

    5. Click Create.

The group is created and its details are displayed. After you have created the group, you need to add a new user to Data Custodian's Identity Service Management (ISM). New Data Custodian users must be added to ISM before they can be added to the Key Management Service.

Create an Application Technical User or a Standard User in ISM

Click the desired tab to view the instructions.

Note

It is recommended to use Technical Users when creating new connections for SAP Data Custodian on the CipherTrust Data Security Platform Service.

Add an application technical user to Data Custodian's Identity Service Management (ISM). SAP Data Custodian users with a key administrator (Key Admin) role in ISM can create new technical users and edit their permissions.

To add a technical user in ISM:

  1. Log on to the SAP cloud as the Key Admin.

  2. Go to top left Menu > Home > Dashboard.

  3. Click the desired application.

  4. Click the desired group.

  5. On the Users tab, click Technical Users.

  6. Click Create Technical User.

  7. Enter the Username and Description (optional), and click Step 2.

  8. Select an Active Time Range and click Step 3.

    To specify the range:

    1. Active From: Allows you to activate the technical user at a specific time. The technical user remains inactive until the Active From time is specified.

    2. Active To: Allows you to deactivate the technical user at a specific time.

  9. Select the following permissions.

    • View all audit logs for this technical user's group

    • Create Keys

    • Modify Keys

    • Delete Keys

    • Backup and restore keys

    • Manage Labels

    • Read all keys in group

    • Crypto

    • Rotate

    • Export all keys in group

    • Service Availability Check

    • Read Dynamic Key References

  10. Click Review.

  11. Click Create.

  12. Click Generate Credential.

  13. Enter Credential Name, select Expiry Date (optional), and click Download.

The credentials (access key, secret key, and API endpoints) are downloaded in a ZIP file named <credential-name>.zip. These credentials are needed to create a SAP connection on the CipherTrust Manager. It is recommended to use the latest API endpoint URL listed in the extracted API endpoints.txt file. Refer to Add SAP Connection on CipherTrust Manager for details.

Add a user to Data Custodian's Identity Service Management (ISM). SAP Data Custodian users with an administrator role in ISM can create new users and edit their service roles.

To add a user in ISM:

  1. Log on to the SAP cloud as the Service Admin.

  2. Go to top left Menu > Tenant Management > Users.

  3. Click Create.

  4. Enter the user's First Name and Last Name.

  5. Enter the user's Email Address.

  6. Select optional ISM administrator Roles to assign to the user.

  7. Select an optional Active Time Range for the user.

    1. Active From: Allows you to activate the user at a specific time.

    2. Active To: Allows you to deactivate the user at a specific time.

  8. Click Review. Verify the user details. Click Edit to make changes, if required.

  9. Click Create.

The user is created. Next, you need to add this user to the Key Management Service, as described below.

Add the Standard User to Key Management Service

Note

This section is applicable to standard (non-technical) SAP users. Skip the section when adding SAP Technical Users.

Add the user created in the previous step to the Key Management Service. Only the Key Management Service users with an Administrator role can add other users to KMS.

To add the user to the Key Administrator service:

  1. Navigate to Tenant Management > Users.

  2. From the All Users section, select the user (created above).

  3. Click Add to Service. You might need to open the menu on the top-right, to see this button.

  4. Select Key Management Service (KMS).

  5. Select the Key Administrator role to assign to the user. The user with the Key Administrator role is referred to as the Key Admin user in this document.

    Note

    Optionally, assign one or more existing groups to the user. Refer to User Roles in the Key Management Service in SAP documentation for more information.

  6. Click Add.

After assigning the Key Administrator role to the user, add SAP connection on CipherTrust Manager.

Add SAP Connection on CipherTrust Manager

Before you can add a SAP group to the CCKM, a connection to your SAP account must already exist on the CipherTrust Manager. After you have created a SAP group, add a connection to the SAP cloud using your SAP tenant and the Key Admin username and password.

A CipherTrust Manager administrator manages connections to external resources on the Access Management > Connections Management page of the CipherTrust Manager GUI. Refer to Connection Manager for details.

What Next?

After completing the prerequisites, you can view linked SAP groups and manage keys on the CipherTrust Manager.

Refer to the following sections:

Tip

The mandatory API request parameters are written in bold.

On this page