Welcome to Zuora Product Documentation

Explore our rich library of product information

Manage key pairs

Learn how to manage key pairs for secure API access using the Zephr REST API.

The Zephr REST API is secured using key pair authentication.

After creating a key pair, a request can be signed using a hash-based message authentication code (HMAC), which allows the request to include the role and identity of the admin user who owns the key pair.

Key pairs created in the Admin Console allow an integration service to act on behalf of the admin user who generates them.
Note:

Zephr recommends that you create a generic admin user in your Admin Console for key pair generation; for example, team@<yourcompany>.com . This is because keypairs are user-specific. This means that key pairs are not lost if an admin user's access is removed.

You can do the following:

  • Create a key pair
  • Add notes to a key pair
  • Delete a key pair