APIキーの発行

Synqlet API へのリクエストには APIキー が必要です。APIキーは組織ごとに、画面の「設定 > APIキー」から発行します。

APIキーを発行する

1. 「設定 > APIキー」を開く

   サイドメニューの設定から「APIキー」の画面を開きます。

2. 「作成」をクリックする

   APIキー作成ダイアログが開きます。

3. APIキー名を入力する

   後から見分けやすいように、用途がわかる名前（例: 本番バッチ連携）を付けます。

4. 「作成」を押す

   APIキーが発行され、キーの文字列が表示されます。

APIキーは作成後に1度だけ表示されます

キーは再表示できません

発行されたAPIキーは 作成直後に1度だけ 表示されます。画面を閉じると二度と表示できません。

表示されている間に コピーボタン でコピーし、安全な場所に保管してください。紛失した場合は、新しいキーを発行し直す必要があります。

APIキーは次の形式の文字列です。

sk_synqlet_<id>_<secret>

このキーをリクエストの X-API-Key ヘッダーに指定して利用します（API の概要 を参照）。

APIキーの権限と作成者について

APIキーは 発行した組織の管理者と同等の権限 を持ちます。組織をまたいだ操作はできません。

APIキーを発行できるのは、「管理者」 または 「APIキーの作成」 を許可されたメンバーです。→ メンバー管理

注意

APIキーの権限は 発行したメンバー本人の権限ではなく、組織の管理者と同等 です。そのため「APIキーの作成」だけを許可したメンバーも、自分で発行したAPIキーを使えば管理者と同じ操作ができます。管理者と同等の権限を渡してよいメンバーにだけ許可してください。

APIキーは発行したメンバーとは独立して動作します。

• 発行したメンバーが組織から外れたり、ユーザーが削除されたりしても、APIキーはそのまま使えます。
• APIキーが行った操作の作成者・更新者・実行者は、メンバーではなく そのAPIキー として記録されます。画面上は鍵のアイコンとAPIキー名で表示され、クリックするとそのAPIキーの詳細画面へ移動します（メンバーによる操作には人のアイコンが付き、メンバー一覧へ移動します）。→ イベント履歴
• 一覧画面の「作成者」「更新者」の絞り込みでは、メンバーとAPIキーの両方が選べます。特定のAPIキーが作ったものだけを一覧できます。
• 操作の記録が残るため、一度使ったAPIキーは削除できません。使うのをやめるときは「有効」をオフにします。

APIキーを使うのをやめる（無効にする）

不要になったキーや漏えいの恐れがあるキーは、「有効」をオフにして無効にします。無効にしたキーでリクエストすると認証に失敗します（401）。あとから有効に戻すこともできます。

ノート

一度でも操作を行ったAPIキーは 削除できません。そのキーが作成・更新・実行したものの記録（作成者・更新者・実行者やイベント履歴）がたどれなくなってしまうためです。削除メニューは選べない状態になり、理由が表示されます。

まだ一度も使っていないキー（発行しただけのキー）は削除できます。

APIキーの取り扱いについて

• APIキーはパスワードと同等の機密情報です。第三者に共有したり、公開リポジトリにコミットしたりしないでください。
• 用途ごとにキーを分けて発行すると、漏えい時の影響範囲を限定できます。
• 不要になったキーや漏えいの恐れがあるキーは、「有効」をオフにして無効にしてください。

発行済みのAPIキーを確認・管理する

「設定 > APIキー」の一覧画面では、発行済みのキーの名前・有効かどうか・作成日時・作成者などを確認できます。一覧からキーの有効・無効の切り替えも行えます。なお、一覧ではキーの文字列そのものは表示されません（マスクされます）。