OAuth 2.0クライアント資格情報を使用する
OAuth 2.0は、リモートAPIやユーザーデータなどのリソースセットへのアクセス権を付与する認可プロトコルです。
OAuth 2.0の詳細については、OAuth 2.0とは何か?を参照してください。
このタスクを開始する
クライアント資格情報付与タイプを使ってOAuth 2.0認証を追加する手順は次のとおりです。
-
概要(Overview)タブをクリックします。
-
認証方法が存在しない場合は、認証設定(Set up authentication)をクリックします。存在する場合は、認証を追加(Add Authentication)をクリックします。
-
認証(Authentication)ダイアログで、ディスプレイ名を入力し、認証タイプ(Auth Type)ドロップダウンリストから
OAuth 2.0を選択します。 -
付与タイプ(Grant Type)ドロップダウンメニューでは、
Client Credentialsを選択します。 -
クライアント認証タイプ(Client Authentication Type)ドロップダウンで、次のいずれかのオプションを選択します。
-
Send as basic auth header (client_secret_basic)(基本認証ヘッダーとして送信):認証では、クライアント資格情報はHTTP認証ヘッダーとして送信されます。これが推奨されるオプションです。 -
Send as basic auth body (client_secret_post)(基本認証本文として送信):認証では、クライアント資格情報はリクエストの本文として送信されます。
-
-
次のフィールドに値を追加します。
| フィールド | 定義 |
|---|---|
|
パス(Paths) |
|
|
トークンURL(Token URL) |
フローがクライアント資格情報を送信する場所。 このフィールドは完全なURLでなければなりません。たとえば |
|
資格情報(Credentials) |
|
|
クライアントID(Client ID) |
サービスによって提供される公開された文字列。これは、OAuthアプリケーションの識別と認証URLの構築に使用されます。 このフィールドの値は、接続の作成時にエンドユーザーが指定します。 注:
このフィールドは削除できず、プレビュー(Preview)ウィンドウには編集不可能なフィールドとして表示されます。 |
|
クライアントシークレット(Client Secret) |
サービスによって提供されるプライベート文字列値。この値は、サービスに対してアプリケーションIDを認証するために使用されます。 このフィールドの値は、接続の作成時にエンドユーザーが指定します。 注:
このフィールドは削除できず、プレビュー(Preview)ウィンドウには編集不可能なフィールドとして表示されます。 |
|
スコープ(任意)(Scopes (Optional)) |
|
|
名前(Name) |
各スコープは、サービスからの接続リクエストの詳細なアクセスレベルを定義します。接続にOAuthスコープを追加する方法は次のとおりです。
注:
コネクター認証の任意のコンポーネントを変更した場合(新規スコープのカスタマイズなど)、その更新は開発環境で過去に確立されたアクションカードや接続には適用されません。ただし、Oktaが提供する完成済みのコネクターには、ファーストパーティコネクター、サードパーティコネクターを問わず、この制限はありません。 |
|
スコープ区切り文字(Scopes Delimiter) |
ユーザーが個々のスコープを区切って入力するための区切り文字を指定します。 選択肢は |
|
パラメーター(任意)(Parameters (Optional)) |
パラメーターを使用することで、インスタンスやサブドメインなど、認証に必要な追加情報をコネクターユーザーから収集できます。これらのフィールドは、ユーザーが接続を最初に作成する際に表示され、必須です。 ラベル(Label):コネクターのセットアップ時に新規接続(New Connection)ダイアログに表示されるパラメーターの名前。 キー(Key):サービスで使用されるキー/値ペアのテキスト値。たとえば タイプ(Type):3つのフィールドタイプから選択できます。
クライアント資格情報付与タイプでは、デフォルトでクライアントID(Client ID)パラメーターとクライアントシークレット(Client Secret)パラメーターが表示されます。テキストを追加してこれらのラベル用に一意の名前を作成することはできますが、これらのパラメーターは削除できません。 |
|
構成値(任意)(Config Values (Optional)) |
コネクターに対してユーザーを認証する方法を定義するために、その他の構成値が必要になる場合があります。構成値を追加(Add Config Value)をクリックします。 ラベル(Label):コネクターのセットアップ時に新規接続(New Connection)ダイアログに表示される構成値の名前。 定義(Definition):このフィールドに静的な値が入力されるか、ヘルパーフローからの値が入力されるかを示します。
タイプ(Type):2つのフィールドタイプから選択できます。
可視性(Visible)トグルは、コネクターの認証ダイアログに構成値を表示するかどうかを決定します。 |
次の手順
この認証方式を作成したら、認証方式を通じて呼び出しを管理するhttpHelperフローを作成する必要があります。httpHelperフローを構築するを参照してください。