DCRを使用したAPIクライアントの作成

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

認証に動的クライアント登録(DCR)プロバイダーを使用するAPIクライアントを作成できます。 これにより、APIコンシューマーは、API Platform Adminによる手動プロビジョニングを必要とせずに、Developer Portalで独自の認証情報を生成できます。

前提条件

開始する前に、次のタスクが完了していることを確認してください:

クライアント詳細の設定

クライアント詳細を設定するには、次の手順を完了します。 これらの手順は、すべての認証方法で同じです。

1
APIクライアントの追加
1

プラットフォーム>API platformに移動します。

2

クライアントタブを選択します。

3

+ Add new clientをクリックします。

新規クライアントを追加新規クライアントを追加

2
クライアント詳細の設定
1

クライアントの名前を入力します。 クライアントの会社名や部門名など、わかりやすい識別子を使用します。

クライアント詳細のセットアップクライアント詳細のセットアップ

2

クライアントの説明を入力します。

3

クライアントロゴをアップロードします。 JPG/PNG画像をドラッグアンドドロップするか、Upload from deviceをクリックしてファイルを選択します。 このロゴは、ポータル内でクライアントを視覚的に識別します。

4

ポータルアクセスを有効にするには、クライアントにポータルへのアクセスを許可トグルを有効にします。 これにより、公開済みのAPIコレクションを参照し、APIキーを管理する権限がクライアントに付与されます。 クライアントがテストまたは社内目的でAPIトークンのみを必要とする場合は、トグルを無効のままにできます。

5

ポータルの認証方法に基づいて、クライアントの識別情報を入力します:

6

次へをクリックしてアクセス設定を定義画面に進み、クライアントのAPIアクセスを設定します。

アクセス設定の定義

アクセス設定の手順では、クライアントがAPIで認証する方法を決定します。 認証方法を選択し、DCR固有の設定を構成します。

次のセクションでは、サポートされる各認証方法のDCR対応設定について説明します:

DCRを使用したOpenID Connect

DCRプロバイダーでOpenID Connectを使用するAPIクライアントを設定するには、次の手順を完了します。

1

認証方式ドロップダウンメニューで、OpenID Connect(DCR有効)を選択します。

認証方法を選択認証方法を選択

2

API collections to includeドロップダウンメニューを使用して、1つ以上のAPIコレクションを選択します。 これにより、クライアントがポータルでアクセスおよび呼び出しできるAPIが定義されます。 APIアクセスを付与する前にディスカバリーを許可するため、コレクションなしでクライアントを作成することもできます。

3

任意です。 クライアントのAPI利用状況を制御するには、ポリシーを割り当てます。 ポリシーでは、レート制限や利用状況クォータなどのルールを定義します。

4

次へをクリックします。

5

ディスカバリー方法ドロップダウンメニューを使用して、DCRプロバイダーを選択します。

DCRプロバイダーオプションは、設定 > Developer Portal > 動的クライアント登録で少なくとも1つのDCRプロバイダーを設定した後にのみ、ディスカバリー方法ドロップダウンメニューに表示されます。 その他のディスカバリーURLおよびJSON Web Key Set(JWKS)URLオプションは、既存のOpenID Connect設定フローに従います。 詳細については、OpenID Connect認証を参照してください。

6

DCRプロバイダードロップダウンメニューを使用して、このクライアントで使用するプロバイダーを選択します。 ドロップダウンには、OpenID Connect認証方法を使用する、設定済みのすべてのDCRプロバイダーが一覧表示されます。

DCRプロバイダーを選択DCRプロバイダーを選択

7

次へをクリックして認証を設定手順に進み、残りの設定を完了します。

設定が完了すると、WorkatoによってAPIクライアントが作成されます。 クライアントは、認証方法とDCRプロバイダーの詳細とともにクライアントページに表示されます。

DCRを使用したOAuth 2.0 Token Introspection

DCRプロバイダーでOAuth Token Introspection 2.0を使用するAPIクライアントを設定するには、次の手順を完了します。

1

認証方式ドロップダウンメニューで、OAuth 2.0トークンイントロスペクション(DCR有効)を選択します。

認証方法を選択認証方法を選択

2

DCRプロバイダードロップダウンメニューを使用して、このクライアントで使用するプロバイダーを選択します。 ドロップダウンには、OAuth 2.0 Token Introspection認証方法を使用する、設定済みのすべてのDCRプロバイダーが一覧表示されます。

プロバイダーなし(手動設定)を選択して、DCRプロバイダーを使用せずにトークンイントロスペクションを手動で設定します。 これには、HTTPコネクションとイントロスペクションエンドポイントを個別に設定する必要があります。 詳細については、OAuth 2.0 Token Introspection認証を参照してください。

3

API collections to includeドロップダウンメニューを使用して、1つ以上のAPIコレクションを選択します。 これにより、クライアントがポータルでアクセスおよび呼び出しできるAPIが定義されます。 APIアクセスを付与する前にディスカバリーを許可するため、コレクションなしでクライアントを作成することもできます。

4

任意です。 クライアントのAPI利用状況を制御するには、ポリシーを割り当てます。 ポリシーでは、レート制限や利用状況クォータなどのルールを定義します。

5

次へをクリックしてクライアントを作成します。

設定が完了すると、WorkatoによってAPIクライアントが作成されます。 クライアントは、認証方法とDCRプロバイダーの詳細とともにクライアントページに表示されます。

Last updated: