APIキーとスコープ
API キーを使うと、人がサインインしなくても、スクリプトやサービスがワークスペースにアクセスできます。キーにはスコープがあるため、用途に必要な範囲に制限できます。
キーを作成する
- 管理者としてサインインし、APIキーを開きます。
- キーに名前を付け、スコープを選択します。必要に応じて有効期限を日数で指定します。
- キーが表示されたらコピーしてください。キーは
xcrt_で始まり、再表示はできません。
キーを作成または失効できるのは、サインイン中の管理者のみです。また、キーには作成者が持つスコープのみを付与できます。他のスコープを選ばない場合、新しいキーには certs:read が付与されます。
キーを使う
curl -H "Authorization: Bearer xcrt_your_key" \
https://api.automate-certificates.com/v1/certificatesスコープ
| スコープ | 許可される操作 |
|---|---|
certs:read | 証明書とそのチャレンジの一覧表示と読み取り。 |
certs:write | 証明書の要求、更新、インポート、失効、削除。 |
targets:read | ターゲットの一覧表示と読み取り。 |
targets:write | ターゲットの作成、変更、削除。 |
deploy:read | デプロイの読み取り。 |
deploy:execute | デプロイの実行とデプロイルールの管理。 |
monitoring:read | 監視結果の読み取り。 |
alerts:read | アラートの読み取り。 |
alerts:write | アラートルールの設定と Webhook の管理。 |
audit:read | 監査ログの読み取り。 |
スコープ付きキーではできないこと
メンバー、ロール、API キー、ACME アカウント、クラウド認証情報の管理には、サインイン中の管理者またはフルアクセスのキーが必要です。スコープ付きキーは、所有者が管理者であっても 403 insufficient_scope で拒否されます。ディスカバリースキャンや一括更新の実行など、一部の管理者操作では、対応するスコープを持ち、管理者に属するキーが使えます。
上限
各プランで作成できるキーの数は決まっています。リクエストはワークスペースごとに1分あたり120件までに制限されます。