OAuth2 認証のためのクライアントシークレットの作成と使用

カスタムコネクタは、Open Authorization (OAuth) 2.0 authorization framework 認証をサポートし、組み込みのエディタでクライアントシークレットを作成してコールバック URL を生成できるようにします。一般的に OAuth2 を使用するカスタムコネクタの構成プロセスは次のとおりです。

1. 組み込みのエディタでクライアントシークレットを作成します。

2. JSON でシークレットを参照します。

3. 認証、トークン、および範囲のサードパーティの URL を指定します。

   メモ  Refresh Token はサポートされていません。カスタムコネクタ作成の制限を参照してください。

4. サードパーティ App で生成されたコールバック URL を承認します。

重要  この機能はまだすべてのユーザが利用できるわけではありません。

クライアントシークレットの作成:

1. [Custom Connectors] タブをクリックします。

   

2. 既存のコネクタをクリックするか [Create a new connector] をクリックします。

   

3. エディタで、[Secret Keys] をクリックします。

   

4. 表示されるウインドウで、[Secret Name] と [Secret Value] の値を入力し、[Save] をクリックします。[Add new secret pair] をクリックするとさらにシークレットペアを追加できます。一般的に、認証には 2 つのシークレットキーが必要です。1つはクライアント ID 用、もう 1 つはクライアントシークレット用です。

   

   シークレット名は、clientID や clientSecret などにできますが、各シークレット値はコネクタを作成するサードパーティ App または API からのものである必要があります。

   重要  保存された後、シークレット値は変更できません。
   

シークレットの参照

シークレットを作成したら、二重中括弧 ( {{ }} ) を使用して auth_components オブジェクトで参照する必要があります。「スキーマの定義」を参照してください。

認証、トークン、および範囲 URL の指定

クライアント ID とクライアントシークレットに加えて、auth_components オブジェクトで authorizationURL、tokenURL、および scope を指定する必要があります。適切な値の詳細については、App の開発者用ドキュメントを参照してください。次の例は Google カレンダーサンプルの URL を示します:

生成されたコールバック URL の認証

最後に、Claris Connect によって生成されたコールバック URL をサードパーティ App または API で認証して 2 つが相互に通信できるようにします。コールバック URL を生成するには、まずコネクタをテストする必要があります。

1. エディタで、[Save & Test] をクリックします。

2. デバッガで、認証と各アクションをテストした後、[Return to Editor] をクリックします。

3. エディタに戻り、 上にポインタを合わせて [Copy Callback URL] をクリックします。

   

4. App または API でコールバック URL を認証または登録します。これを行う方法がわからない場合は、App または API の関連する開発者用ドキュメントを参照してください。

クライアントシークレットの削除

1. 削除するシークレットのカスタムコネクタに移動します。

2. [Secret Keys] をクリックします。

3. 上にポインタを合わせて [Delete] をクリックし、[Save] をクリックします。

   

メモ 

• シークレットはコネクタごとに作成されます。あるコネクタのシークレットを別のコネクタの認証に使用することはできません。