本文へスキップ
Sursa Developers

オブジェクト

ApiKeyScope

APIキーのスコープ。各公開操作は、細かいresource:actionスコープをx-scope拡張で宣言します:cards:readとcards:writeはカード、コレクション、フォルダー、searchとaskは検索と質問、import:writeはカスタムソース、webhooks:manageはWebhookとイベントフィード、users:readとusers:writeはユーザーとグループ、analytics:readとaudit:readは分析と監査ログ、finance:readとcatalog:readは財務のクエリとサービスカタログ、files:readとfiles:writeはファイル、permissions:manageはオブジェクトの権限を対象とします。adminは、組織の設定とキーを含むすべてのスコープを対象とします。以前のread、write、adminスコープも引き続き使えます:readはcards:read、search、ask、users:read、analytics:read、finance:read、catalog:read、files:read、writeはreadのセットにcards:write、files:write、users:write、permissions:manageを加えたもの、adminはすべてのスコープを意味します。systemはサービス組織のキーだけが持ちます。

フィールド

string

指定できる値: readwriteadminsystemcards:readcards:writesearchaskimport:writewebhooks:manageusers:readusers:writeanalytics:readaudit:readfinance:readcatalog:readfiles:readfiles:writepermissions:manage

参照元

ApiKeyCreateApiKeyUpdate