---
title: Manage ClientSecrets
slug: api/manage-clientsecrets
createdAt: 2026-07-21T10:10:18.578Z
---

If authentication is to be performed using a ClientSecret, it must be created in advance for each ClientId. ClientSecrets are managed via the "My ClientSecrets" menu item.

The "Verwaltung von Client-Secrets" role is required to create and manage ClientSecrets. Your assigned consultant must assign this role to you.

## Create a ClientSecret

![](https://archbee-image-uploads.s3.us-east-1.amazonaws.com/9vqSx7YIe-nloIBlmgxLr/vlxFDqYgq0DHTsiOOjOnO_image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=AKIAYQNQCIXNP4ETOSXW%2F20260721%2Fus-east-1%2Fs3%2Faws4_request\&X-Amz-Date=20260721T101703Z\&X-Amz-Expires=86400\&X-Amz-Signature=432c0bfe6724d8bf40072c79d2b4331cce7d549a801e9a298718a5d80e683769\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject)

1. **AuthClient:** Here, you must select the ClientId for which the ClientSecret is to apply. If you are unable to make a selection, please contact your assigned consultant.
2. **Valid until:** The validity period of the ClientSecret. It is preset to one year in the future. However, it can also be adjusted.
3. **User:** Here, you must select the user in whose context the requests will run. The user must have an API license and the "External API Zugriff" role. If you are unable to make a selection, please contact your assigned consultant.
4. **Description:** A description for the ClientSecret must be entered here.
5. **Secret:** The ClientSecret will appear here once you have generated it in Step 6.
6. **Generate:** Click here to generate the ClientSecret.
7. **Copy to Clipboard:** Clicking this button copies the ClientSecret to the clipboard.

:::hint{type="warning"}
**ATTENTION:**
****
Be sure to copy the ClientSecret into the insert screen! Once you save it, the ClientSecret cannot be recovered and will no longer be visible!

Be sure to save the ClientSecret somewhere secure!
:::

The data set can then be saved, and the ClientSecret can be used for authentication.

## Edit a ClientSecret

You can manage the ClientSecret in the record's edit screen.

![](https://archbee-image-uploads.s3.us-east-1.amazonaws.com/9vqSx7YIe-nloIBlmgxLr/Z3cRpgorhB--K76KltmjR_image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=AKIAYQNQCIXNP4ETOSXW%2F20260721%2Fus-east-1%2Fs3%2Faws4_request\&X-Amz-Date=20260721T101941Z\&X-Amz-Expires=86400\&X-Amz-Signature=7a0bfc2ba9540877b0b37dd89bc874e1c5776a3553a4e4b76eb86efd5ca5fcca\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject)

1. **Valid until:** The validity period of the ClientSecret can be adjusted here. For example, to extend its validity.
2. **Deactivate:** You can deactivate the ClientSecret here. Authentication can no longer take place using deactivated ClientSecrets.
3. **Description:** You can edit the description here.