認証
スコープ
App がアクセスできるデータの範囲
概要
スコープは App がアクセスできるデータの範囲を制御します。App のインストール時に Workspace の管理者がスコープを承認し、承認されたスコープ(granted_scopes)の範囲でのみデータにアクセスできます。
スコープ一覧
| スコープ | 対象 | PII |
|---|---|---|
workspaces:read | Workspace 基本情報・フィールドスキーマ | |
customer_visits:read | 来店記録 | |
customers:read | 顧客情報 | ⚠️ |
transcripts:read | 書き起こし(会話の生データ) | ⚠️ |
staff:read | スタッフ情報 | |
analyses:read | AI 分析結果 | |
reports:read | スタッフレポート | |
audio_sources:write | 音声データの投入 | |
apps:read | App 設定・インストール状況の参照 | |
apps:write | App の登録・設定変更・シークレット再生成 |
⚠️ マークのスコープは個人情報(PII)を含む可能性があるデータへのアクセスを許可します。
ルール
フラット構造
スコープは包含関係を持ちません。たとえば transcripts:read は customer_visits:read を含意しません。必要なスコープを個別に要求してください。
granted_scopes が権限の唯一の正
App 側で requested_scopes を増やしても、既存のインストールの granted_scopes は変わりません。スコープの拡張には管理者による**再インストール(再同意)**が必要です。
スコープ不足時の動作
- REST API: スコープ不足のリクエストは
403 Forbiddenを返します - 承認画面:
scopeパラメータがrequested_scopesを超えている場合はinvalid_scopeエラーになります