APIトークンのスコープ
APIトークンを生成する際、そのトークンに対するスコープを選択します。選択されたスコープによって、実行できるAPIが異なります。
ここでは、それぞれのスコープで実行可能なAPIを説明します。
「Read」スコープで実行可能なAPI
「Read」スコープでは、ユーザー情報や組織情報などのデータの取得を許可します。
- ユーザーを取得する
- ユーザーが所属する組織を取得する
- ユーザーが所属するグループ(ロール)を取得する
- ユーザーの利用サービスを取得する
- 組織を取得する
- 組織の所属ユーザーを取得する
- グループを取得する
- グループの所属ユーザーを取得する
- インポートの結果を確認する
- ユーザー情報をエクスポートする
- ユーザーの利用サービスをエクスポートする
- 組織情報をエクスポートする
- ユーザーが所属する組織をエクスポートする
- 役職情報をエクスポートする
- グループ情報をエクスポートする
- ユーザーが所属するグループ(ロール)をエクスポートする
「Read and Write」スコープで実行可能なAPI
「Read and Write」スコープでは、ユーザー情報や組織情報などのデータの取得および変更を許可します。
ただし、「Administrators」グループに所属するユーザー情報の変更や、ユーザーが所属するグループ情報の変更はできません。
- 「Read」スコープで実行可能なAPI
- ユーザーを追加する
- ユーザーのログイン名を更新する
- ユーザーが所属する組織を更新する
- ユーザーの利用サービスを更新する
- 組織を追加する
- 組織を更新する
- 組織を削除する
- 組織コードを更新する
- グループを追加する
- グループを更新する
- グループを削除する
- グループコードを更新する
- ファイルをアップロードする
- ユーザーの利用サービスをインポートする
- 組織情報をインポートする
- ユーザーが所属する組織をインポートする
- 役職情報をインポートする
- グループ情報をインポートする
次のAPIは、「Administrators」グループに所属するユーザー情報を含まない場合に実行できます。
「Dangerous Zone」スコープで実行可能なAPI
「Dangerous Zone」スコープでは、すべてのUser APIの実行を許可します。「Administrators」グループに所属するユーザー情報の変更や、ユーザーが所属するグループ情報の変更も可能です。