API キーとスコープ

API キーを使うと、コンソールにサインインせずにスクリプトや他のシステムから xEvolve API を呼び出せます。各キーには、できることを制限するスコープがあります。

キーの作成

API キーを開き、新しいキーを選びます。
名前を入力し、必要なスコープにチェックを付け、必要に応じて有効期限を日数で設定します。
キーをコピーします。キーは xev_ で始まり、表示されるのは一度だけです。xEvolve が保持するのはハッシュのみです。

キーをベアラートークンとしてワークスペースに送信します。

curl https://<workspace>.xevolve.io/api/v1/connections \
  -H "Authorization: Bearer xev_<key>"

キーの失効は即時に反映されます。キーの作成と失効は監査ログに書き込まれます。

ルール

キーは、自身が持つスコープの範囲内のキーしか作成できません。それ以上を要求すると 403 になります。
必要なスコープのない呼び出しは、API key missing required scope とともに 403 を返します。
コンソールセッションはスコープに制限されず、ユーザーのロールに従います。
多要素認証の設定、セッション管理、サインインイベント、サービスプリンシパルの登録、アバター、保持ポリシー、トライアルの状態は、コンソールセッションのみ受け付けます。API キーには 403 が返ります。

スコープ

スコープ	許可する操作
`files:read`	ファイルの一覧表示、検索、ダウンロード。
`files:write`	ファイルのアップロード。
`transfers:read`	転送の一覧表示と表示。
`transfers:write`	転送の作成、実行、キャンセル。
`connections:read`	接続の一覧表示と表示。
`connections:write`	接続の作成、編集、削除、テスト。
`data-rooms:read`	データルームの一覧表示と表示。
`data-rooms:write`	データルームの作成、編集、管理。
`schedules:read`	スケジュールと実行履歴の一覧表示。
`schedules:write`	スケジュールの作成、編集、削除、実行。
`watchers:read`	フォルダー監視の一覧表示。
`watchers:write`	監視の作成、編集、削除。
`workflows:read`	ワークフローと実行履歴の一覧表示。
`workflows:write`	ワークフローの作成、編集、削除、実行。
`parameters:read`	グローバルパラメーターの一覧表示と表示。
`parameters:write`	グローバルパラメーターの作成、編集、削除。
`users:read`	ユーザーの一覧表示と表示。
`users:write`	ユーザーの編集と削除。
`agents:read`	マネージドエージェントの一覧表示と表示。
`agents:write`	マネージドエージェントの作成、編集、削除、テスト。
`webhooks:read`	Webhook と配信の一覧表示。
`webhooks:write`	Webhook の作成、編集、削除。
`activity:read`	アクティビティログとダッシュボードのカウンターの読み取り。
`notifications:read`	通知設定と通知ログの読み取り。
`notifications:write`	通知設定の編集またはテスト。
`api-keys:read`	API キーの一覧表示。
`api-keys:write`	API キーの作成と失効 (呼び出し元のキーが持つスコープの範囲内)。

API キーと Webhook には Team 以上のプランが必要です。プランと上限に、月ごとに許可される API リクエスト数が記載されています。