Skip to content

Manage your keys ​

This guide is for the customers of a cloud service that uses CMK: the people who manage the keys of their tenant. It explains how to sign in, give your colleagues access, add your keys, and connect them to the systems that encrypt your data.

Before you start ​

Your cloud service provider gives you:

  • The address of the CMK UI, for example https://ui.example.com, and your tenant ID. CMK runs separately in each region, and your tenant is served by one of them: use the address of your tenant's region. See Your tenant.
  • The identity provider your tenant signs in with. It is usually your own corporate login, connected by the provider during onboarding.

You also need to be a member of a group that CMK knows. When your tenant is created, CMK creates two groups for it; your provider tells you how to become a member of the tenant administrator group. See Sign-in, groups and roles.

Roles at a glance ​

RoleWhat you do
Tenant administratorCreate the groups for key administrators, decide who belongs to which group, and set the approval rules
Key administratorCreate key configurations, add and manage keys, connect systems, and approve changes of colleagues
AuditorSee everything in the tenant without changing anything

Each person has exactly one role in a tenant.

First steps ​

  1. Tenant administrator: sign in and create a group for your key administrators under User Groups. Ask your identity provider team to put the right people in the matching group. See Groups.
  2. Key administrator: create a key configuration under Key Configurations, owned by your key administrator group. See Key configurations.
  3. Key administrator: add a key to the key configuration: import your own key material (BYOK), or link a key from your own keystore (HYOK). See Keys.
  4. Key administrator: make the key the configuration's primary key. The systems connected to the configuration use this key.
  5. Key administrator: connect your systems to the key configuration under Systems. See Systems.

If your tenant requires approvals, some of these steps create an approval request that colleagues must approve first. See Approvals.

Find your way in the UI ​

ScreenWhat you find thereWho sees it
Key ConfigurationsYour key configurations, their keys and connected systemsKey administrators, auditors
SystemsThe systems of your tenant in every region, and the key configuration each one usesKey administrators, auditors
TasksApproval requests that you started or are asked to approveKey administrators, auditors
User GroupsThe groups of your tenant and their rolesEveryone
Settings (from your avatar)Language and approval settingsEveryone; tenant administrators can change the approval settings
Tenant menu (at the top)The name of your tenant, and your other tenants in the same region to switch to; see Your tenantEveryone

Tenant administrators start on User Groups; everyone else starts on Key Configurations.

Automate with the API ​

Everything you can do in the UI, you can also do through the CMK API.

See also ​

EU and German government funding logos

Funded by the European Union – NextGenerationEU.

The views and opinions expressed are solely those of the author(s) and do not necessarily reflect the views of the European Union or the European Commission. Neither the European Union nor the European Commission can be held responsible for them.