no versions found for ApplicationFrameworkReferences / Utility/auth/authagent_getHeaders / en

AuthAgent: getHeaders()

リクエストから認証ヘッダを生成します。

この関数は非同期関数です。

構文

authAgent.getHeaders(request) => Promise<{ authorization } | null>

引数

  • request: { method, url }

    ヘッダを付与する対象のリクエストです。以下のプロパティを持つオブジェクトです。

    • method: string

      リクエストのメソッドです。

    • url: string

      リクエストの URL です。

返値: Promise<({ authorization } | null)>

認証ヘッダのプロミスです。返されたオブジェクトは以下のプロパティを持っています。

  • authorization: string --- Authorization ヘッダ。

ヘッダが生成されなかった場合は null が返されます。