スコープの概要


スコープは、Genesys Cloud Public APIのエンドポイントを分類するGenesys定義の名前です。アプリが特定のスコープを持つことを承認されると、そのスコープを必要とするAPI内のエンドポイントにのみアクセスできます。アプリケーションは、持たないスコープを必要とするエンドポイント呼び出すことはできません。

すべてのAPI呼び出しには、読み取り専用または読み取り/書き込みのスコープが必要です。スコープ :読み取り専用 接尾辞は読み取り専用です。接尾辞のないスコープは、読み取り/書き込み操作を許可します。

例えば、Genesys Cloudユーザーへのアクセスを可能にする2つのスコープについて考えてみましょう。するアプリのアクセスを許可するにはユーザー関連のエンドポイントを、管理者は、管理者がアプリを変更できるようにしたいかどうかに基づいて、アプリに次のスコープのいずれかを割り当てますユーザーデータかどうかを。

スコープ名 users users:readonly

説明

ユーザー scopeは、アプリがGenesys Cloudユーザーに関するデータを読み取って変更できるようにします。

アプリは、GET、POST、PUTを使用PATCH、および呼び出すためのメソッドを削除することができユーザー -relatd APIエンドポイントを。

ユーザー:読み取り専用 scopeでは、アプリはGenesys Cloudからユーザーデータを読み取ることができます。

読み取り専用スコープはGETメソッドを使用しますが、 分析データまたは検索のためにAPI呼び出しにデータを送信するためにPOSTを使用する必要がある場合を除きます。

このような場合、アプリはデータを変更せず、POSTからデータを取得するだけです。応答データを取得するために情報を送信する必要がある場合でも、全体的なシナリオは依然として読み取り専用です。

Genesys Cloudは、グループ、ボイスメール、アーキテクト、ステーション、検索などのスコープなど、多くの追加スコープをサポートしています。ほとんどのスコープは、 :読み取り専用 サフィックス。スコープの完全なリストについては、以下を参照してください。 スコープGenesysクラウド開発者センター.

注意: アプリがAPIを呼び出すことができエンドポイントそれがで必要な範囲を持っている場合はエンドポイント 、それがアクセスしたり、そのデータを変更する権限を持っている人によって使用されている場合のみです。スコープだけではアクセスを許可しません。アプリの現在のユーザー API呼び出しの動作を許可する権限を持っている必要があります。スコープとアクセス許可の両方が必要です。