認証
ベアラー トークンとして API キーを送信します。キーには apikeys.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/api-keys \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Mints a new per-org API key and returns the full `zdk_…` token **once** — only its hash is stored, so a lost token is replaced, never recovered. The requested `scopes` must be permissions the caller already holds in the target org; asking for one you do not hold is a `403` (a key can never out-scope its creator). Send an `Idempotency-Key` so a retry after a lost response returns the same token rather than orphaning a key. Requires `apikeys.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
Idempotency-Key (header) | string | いいえ | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
name | string | はい | — |
scopes | string[] | いいえ | RBAC permission keys to grant. Each must be a permission the caller holds in the target org (a key can never out-scope its creator); an unheld scope is a `403`, an unknown one a… |
sandbox | boolean | いいえ | Mint a sandbox (test-mode) key. Defaults to false. |
org_id | Uuid | null | いいえ | The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | はい | — |
prefix | string | はい | The key's public lookup id (the middle segment of the token). |
scopes | string[] | はい | The RBAC permission keys this key may exercise. |
sandbox | boolean | はい | A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2). |
last_used_at | object | いいえ | When the key last authenticated a request; null if never used. |
revoked_at | object | いいえ | Always null on a listed/fetched key — revoked keys are not returned. |
created_at | string | はい | — |
token | string | はい | The full `zdk_<mode>_<prefix>_<secret>` token. Shown **once, here only** — store it now; it cannot be retrieved again, only replaced. |
このエンドポイントが返すエラー
401 · 403 · 409 · 422 · 429