How to use API keys
Creates, scopes, rotates and revokes gateway API keys; the full value is shown only at creation time.
What this section is for
Creates, scopes, rotates and revokes gateway API keys; the full value is shown only at creation time.
Before you start
You need access to IAM.Router, the correct tenant/workspace and permission to change this configuration. Prepare a non-sensitive example value such as docs-staging-2026-08.
Buttons and forms
| Control | What it does |
|---|---|
| Create key | Opens the creation flow. The object is not persisted until the final save action. |
| Policy mode | Performs the action named in the interface. Review the resulting state or message before continuing. |
| Rotate key | Performs the action named in the interface. Review the resulting state or message before continuing. |
| Delete key | Starts a destructive flow and must show a confirmation before the change is applied. |
| Refresh | Reloads data from the server and keeps the current page context. |
Form fields
| Field | Safe example | Input rule |
|---|---|---|
Label | docs-staging-2026-08 | Include purpose and environment; do not use a person’s name. |
Primary path in the interface
- Open the application link above and sign in with the least-privileged role required for this section.
- Select the intended tenant or workspace. Do not continue while the header shows a different tenant.
- In the navigation, click API keys. The expected address is https://app.iamrouter.ru/keys.
- Click Create key. Enter the documented safe values:
Label=docs-staging-2026-08. Do not paste a production secret into a free-text field. - Review every field before the final Save, Run, Publish or Confirm action. If a preview or validation control exists, run it first.
- Review the validation message or changed row. The result must match this purpose: Creates, scopes, rotates and revokes gateway API keys; the full value is shown only at creation time.
- Only then continue to the next dependent section. Copy the request/correlation ID when the interface shows one.
Second path: direct link and CLI/API
- Open the deep link https://app.iamrouter.ru/keys instead of navigating through the sidebar.
- Confirm the tenant/workspace after the page loads; a deep link must not silently switch scope.
- Before automating the API path, run this product-specific read-only or validation command. It proves reachability but does not bypass application permissions:
export IAM_ROUTER_URL=https://api.iamrouter.ru
export IAM_ROUTER_TOKEN='<token>'
curl --fail --silent --show-error "$IAM_ROUTER_URL/healthz"
How to verify the result
The new key is stored in a secret store, the old key is revoked after overlap and policy mode matches the client.
If it did not work
| Symptom | What to do |
|---|---|
| 401 / sign-in screen | Sign in again, then return to this page. Do not put a session token in a URL. |
| 403 | Check the selected tenant and request the documented role; retrying with the same role will not help. |
| 404 | Verify the exact path and whether the feature is enabled in this environment. |
| 409 | Search for an object named docs-staging-2026-08; continue with it or choose a unique name. |
| 422 / validation error | Correct only the highlighted fields. Keep identifiers lowercase unless the form explicitly allows otherwise. |
| 429 | Wait for the displayed retry interval or reduce the request scope; do not start parallel retries. |
| 5xx / timeout | Refresh once after the server has recovered; do not repeat a destructive action while its result is unknown. Save the correlation ID and timestamp for support. |