動的クライアント登録 ​

動的クライアント登録（DCR）により、WorkatoはAPIコンシューマーに代わって、OktaなどのIDプロバイダー（IdP）にAPIクライアントをプログラムで登録できます。これにより、APIプラットフォーム管理者がIdPで各クライアントを手動で登録し、OAuth 2.0認証情報を個別に配布する必要がなくなります。

DCRは、RFC 7591およびOpenID Connect Dynamic Client Registration仕様で定義された標準プロトコルです。これにより、WorkatoはAPIコンシューマーに代わってIdPに登録リクエストを送信し、その応答としてclient_idとclient_secretを受け取ることができます。

DCRプロバイダーを設定した後、その設定を複数のAPIクライアントで再利用できます。 DCRが有効なクライアントに割り当てられたAPIコンシューマーは、手動プロビジョニングを待たずに、Developer Portalで自身の認証情報を生成できます。

前提条件 ​

DCRの使用を開始する前に、次の項目が揃っていることを確認してください:

• API platformが有効になっている、アクティブなWorkatoワークスペースがある。
• APIプラットフォーム管理者権限がある。
• OAuth 2.0クライアントを登録する権限を持つOktaアカウントがある。現時点では、DCRはIDプロバイダーとしてOktaをサポートしています。
• IdPで認証するよう設定されたアクティブなHTTPコネクションがある、または設定中に作成する予定がある。サポートされる認証タイプには、no-auth、query、basic、header、OAuth 2.0（client credentials）が含まれます。
• IdPで必要なスコープを作成し、定義している。

DCRプロバイダーの追加 ​

次の手順を実行して、API platformにDCRプロバイダーを追加します。

OpenID Connect ​

次の手順を実行して、OpenID Connectを使用するDCRプロバイダーの設定を完了します。

成功メッセージにより、プロバイダーが作成されたことが確認されます。新しいプロバイダーは、認証方法と作成の詳細とともに動的クライアント登録プロバイダーページに表示されます。

プロバイダーが正常に保存されました

プロバイダーの作成に失敗すると、エラーメッセージが表示されます。戻るをクリックして設定を確認および編集するか、ダイアログを閉じて終了します。

OAuth 2.0トークンイントロスペクション ​

次の手順を実行して、OAuth2 Token Introspection 2.0を使用するDCRプロバイダーの設定を完了します。この方法では、イントロスペクションHTTPコネクションとエンドポイントを設定する追加手順が必要です。

成功メッセージにより、プロバイダーが作成されたことが確認されます。新しいプロバイダーは、認証方法と作成の詳細とともに動的クライアント登録プロバイダーページに表示されます。

プロバイダーの作成に失敗すると、エラーメッセージが表示されます。戻るをクリックして設定を確認および編集するか、ダイアログを閉じて終了します。

DCRプロバイダーの編集 ​

既存のDCRプロバイダーのHTTPコネクション、スコープ、その他の設定を更新できます。プロバイダーを作成した後は、認証方法を変更できません。

クライアントへのDCRプロバイダーの割り当て ​

DCRプロバイダーを設定した後、クライアントの作成時にAPIクライアントへ割り当てることができます。 DCRプロバイダーを割り当てると、各クライアントを個別に設定する代わりに、IdPコネクションとスコープ設定を再利用できます。新しいクライアントの認証方法としてOpenID ConnectまたはOAuth Token Introspection 2.0を選択すると、DCRプロバイダーオプションを利用できます。

詳細な手順については、DCRを使用したAPIクライアントの作成を参照してください。

制限事項 ​

DCRを設定する前に、次の制限事項を確認してください:

• DCRはIDプロバイダーとしてOktaをサポートしています。現時点では、追加プロバイダーのサポートは利用できません。
• プロバイダーを作成した後は、認証方法を変更できません。初期設定時に正しい方法を選択してください。