スコープの紹介

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

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

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

スコープ名 users users:readonly

説明

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

アプリは、GET、POST、PUT、PATCH、およびDELETEメソッドを使用して、ユーザー関連のAPIエンドポイントを呼び出すことができます。

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

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

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

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

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