_authpingフローの構築

_authpingフローは、プラットフォームがAPIを呼び出して有効な認証であることを確認するためのシステムフローです。

このアクションは検証チェックとして機能し、コネクターを初めて認証するとき、新規コネクターを追加するとき、またはフローを開くときに実行されます。

プラットフォームが認識できるように、フローには_authpingという名前を付ける必要があります。_authpingフローはプラットフォームのみが使用するため、エンドユーザーには表示されません。このフローにはオプションや入力のフィールドはありません。

次の例は、完全な_authpingフローがOkta Workflowsにどのように表示されるかを示します。

はじめに

この共通フローを構築するには、事前に次を行う必要があります。

  • コネクターを作成する。「コネクターの作成」を参照してください。

  • 認証を構築する。「認証」を参照してください。

このタスクを開始する

  1. ページ右上端の[+ New Flow(新規フロー)]をクリックし、[Flows(フロー)]タブで新規フローを作成します。

  2. ページの左端にある[Authping]をクリックします。

  3. ツールバーの[Save(保存)]ボタンをクリックし、フローに_authpingという名前を付けます。_authpingは予約名であり、完全に一致させる必要があることに注意してください。

  4. フローの説明フィールドに「Connection health check(接続ヘルスチェック)」と入力し、[Save all data that passes through the Flow(フローを通過するすべてのデータを保存)]ボックスをチェックして[Save(保存)]をクリックします。

  5. エラー処理のIf Errorカードをフローの最初のカードとして追加します。

  6. カードの[Try(試行)]セクションにFlow Control Call Flowカードを追加します。

  7. [Choose Flow(フローの選択)]ボタンをクリックし、事前に作成したhttpHelperフローを選択します。カードには、httpHelperフローに定義されている入力が自動的に入力されます。

  8. 「ping」として使用するエンドポイントの相対URLを手動で入力します。エンドポイントはサーバーからの認可を必要とし、ping応答には、標準的なHTTPステータスコードを含む小型のデータパケットが含まれている必要があります。

  9. リクエストメソッドを手動で入力します(GET、PATCH、POST、PUT、DELETE)。

  10. 呼び出しに必要な追加情報を、クエリ、ヘッダー、本文のフィールドに入力します。必要なオブジェクトを構築するために、Call Flowカードの前にObject Constructカードを追加する必要がある場合があります。

  11. Helper Flowカードの出力には、httpHelperフローの出力と同じキーを定義する必要があります。

    • status_code(数値)

    • headers(オブジェクト)

    • body(オブジェクト)

  12. If Error関数内のCall Flowカードの右にFlow Control Assignカードを追加します。[Click or drop here to create(クリックまたはドラッグして作成)]をクリックし、フィールドにmessageという名前を付けます。

  13. 新規フィールドに成功メッセージを手動で追加します。例:This account is successfully connected(このアカウントは正常に接続されています)

  14. Error Ifカードの上部右にある[View Outputs(出力の表示)]リンクをクリックし、カードの出力セクションを展開します。

  15. 出力セクションで[Click or drag to create(クリックまたはドラッグして作成)]をクリックし、「status_code」と入力します。「Drag output here(出力をこちらにドラッグ)」という入力が2つ表示されます。

  16. Call Flowカードのstatus_code出力フィールドをstatus_codeフィールドの下の2つの入力にドラッグします。

  17. 出力セクションで[Click or drag to create(クリックまたはドラッグして作成)]をクリックし、「message」と入力します。

  18. Assignカードのmessage出力フィールドをmessageフィールドの下の2つの入力にドラッグします。

  19. If Errorカードの上部のドロップダウンを選択し、[If Error]を選択します。ここでは、サービス固有のエラー処理を管理できます。

  20. サービスに応じて、If Errorカードの左パネルにあるErrorオブジェクトに追加のキーを追加し、サービスから返されるオブジェクトからステータスコードとエラーメッセージを抽出します。[Enter key name(キー名の入力)]をクリックしてキーを追加します。

  21. 新しいキーをIf Errorカードの対応出力にドラッグします。

  22. エラー処理のIf Error関数カードの右に True/False Compare カードを追加します。

  23. If Errorカードの出力にあるstatus_codeフィールドをCompareカードのvalue aフィールドにドラッグし、比較がequal toに設定されていることを確認します。

  24. value bフィールドには、リクエストに成功した場合のステータスコードを入力します。これは、ほとんどの場合は200です。

  25. フィールドのドロップダウンをクリックし、[customize(カスタマイズ)]をクリックしてTrue/False Compareカードの出力フィールドにworkingという名前を付けます。これらのフィールドの命名はベストプラクティスであり、必須ではありません。

  26. Compareカードのworking出力をReturn Statusカードのworkingフィールドにドラッグします。

  27. Object Constructカードを追加します。

  28. [Click or drop here to create(クリックまたはドラッグして作成)]をクリックし、statusCodeというラベルを追加します。

  29. If Errorカードの出力にあるstatus_codeフィールドをConstructカードの新しいstatusCodeフィールドにドラッグします。

  30. Constructカードに別の入力フィールドを追加し、bodyという名前を付けます。

  31. Assign Ifカードのmessage出力フィールドをConstructカードのbodyフィールドにドラッグします。

  32. Object Constructカードの出力フィールドにserviceResponseという名前を付けます。

  33. ConstructカードのserviceResponse出力を、Return StatusカードのserviceResponseフィールドにドラッグします。

  34. Connector AuthpingカードのauthオブジェクトをCall FlowカードのConnection入力フィールドにドラッグします。

  35. フローを保存し、テストします。

次の手順

カスタムAPIアクションカードの構築