Purpose
Copy your Client ID and understand how the secret is displayed — masked by default, full plaintext only once after regeneration.
Console path: API Keys → Credentials card (visible when API access is Configured).
Prerequisites
- Organization has a provisioned Keycloak M2M client (
Configuredbadge on the API access card)
Credentials card header
| Element | Copy |
|---|---|
| Card title | Credentials |
| Description | Use these values in server-side integrations only. Never embed the secret in browsers or mobile apps. |
Client ID field
| Element | Copy |
|---|---|
| Label | Client ID |
| Hint | Public identifier — safe in config files, not a password. |
| Input | Read-only monospace field with full Client ID |
| Copy button | Clipboard icon; aria-label: Copy Client ID |
| Success toast | Client ID copied |
The Client ID is always visible and copyable. It also appears in the API access summary grid as CLIENT ID.
Secret field
| State | Hint | Input value | Copy |
|---|---|---|---|
| Masked (normal) | Only a masked prefix is stored in the portal. | First up to 4 characters of the stored prefix + 20 bullet characters (e.g. abcd••••••••••••••••••••) | Copy button hidden |
| Revealed (after regenerate) | Copy now — it will not be shown again. | Full plaintext secret | Copy button in field + extra Copy secret button below |
Secret status lines (API access card)
| Condition | Icon | Text |
|---|---|---|
| Secret stored, not just revealed | Green check | Configured (masked) |
| Just regenerated | Green check | New secret ready to copy |
| No secret prefix stored | — (muted) | Not set — regenerate to create one |
After Regenerate secret, a yellow alert appears at the top of the page:
- Title: Copy your new secret now
- Description: This is the only time the full secret is shown. Save it in a password manager before you leave this page.
Copy the secret before navigating away — it cannot be retrieved again from the Console.
Copy behavior
| Event | Toast |
|---|---|
| Copy Client ID success | Client ID copied |
| Copy Secret success | Secret copied |
| Copy failure (clipboard blocked) | Could not copy. Select the text and copy manually. |
Steps
-
Open the Credentials card on API Keys.
-
Click the clipboard icon on Client ID — toast Client ID copied.
-
Paste into your server environment variable or secrets vault (never commit to git).
-
For the secret: if masked, use Rotate secret only when you need a new value — you will see the full secret once after regeneration.
-
When the secret is revealed, use Copy Secret or the field clipboard button immediately.
Related pages
For authentication flows, endpoints, and request examples, see the OmaxTelecom Developer Portal.