BaseAuthRequest type

パッケージ:
@azure/msal-common

BaseAuthRequest

  • authority - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。 既定値は https://login.microsoftonline.com/common です。 すべての要求に同じ権限を使用する場合は、権限エンドポイントを複数回解決しないように、要求ではなくクライアント・アプリケーション・オブジェクトに権限を設定する必要があります。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authenticationScheme - 取得されたトークンの種類。 既定値は "Bearer" です。 "pop" または "SSH" と入力することもできます。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • shrClaims - 署名付き HTTP 要求に追加される文字列化された要求オブジェクト
  • shrNonce - 暗号化され base64URL でエンコードされたサーバー生成のタイムスタンプ。これは、署名済み HTTP 要求に追加されます。
  • shrOptions - 署名付き HTTP 要求のオプションを含むオブジェクト
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • sshJwk - SSH 証明書によって署名できる公開キーを表す文字列化された JSON Web キー。
  • sshKid - 上記の SSH 公開キーを一意に識別するキー ID。
  • azureCloudOptions - ユーザーがパブリック/ソブリン クラウド ID を提供するための便利な文字列列挙型
  • requestedClaimsHash - 要求された要求文字列の SHA 256 ハッシュ文字列。アクセス トークン キャッシュ キーの一部として使用されるため、要求された要求によってトークンをフィルター処理できます
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • tokenBodyParameters - /token 呼び出しの本文に追加されたカスタム パラメーターの文字列マップへの文字列
  • storeInCache - トークンをキャッシュに格納するかどうかを示すブール値を含むオブジェクト (既定値は true)
  • scenarioId - カスタム ユーザー プロンプトを追跡するシナリオ ID
  • popKid - PoP トークン要求の公開キーを識別するキー ID
  • embeddedClientId - 埋め込みクライアント ID。指定すると、ブローカー クライアント ID (brk_client_id) パラメーターとリダイレクト URI (brk_redirect_uri) パラメーターが構成の値で設定され、対応する追加パラメーターが存在する場合はオーバーライドされます。
  • httpMethod - /authorize 要求に使用する HTTP メソッド。 既定値は GET ですが、要求に本文パラメーターが必要な場合は POST に設定できます
  • authorizePostBodyParameters - httpMethod が POST に設定されている場合に/authorize 呼び出しの本文に追加されたカスタム パラメーターの文字列マップへの文字列
  • skipBrokerClaims - true でブローカー フローが使用されている場合 (たとえば、ブローカー パラメーターまたは embeddedClientId が存在する場合)、構成からの clientCapabilities は要求から除外されます。非ブローカー フローでは無視されます。
type BaseAuthRequest = {
  authenticationScheme?: AuthenticationScheme
  authority: string
  authorizePostBodyParameters?: StringDict
  azureCloudOptions?: AzureCloudOptions
  claims?: string
  correlationId: string
  embeddedClientId?: string
  httpMethod?: HttpMethod
  maxAge?: number
  popKid?: string
  requestedClaimsHash?: string
  resourceRequestMethod?: string
  resourceRequestUri?: string
  scenarioId?: string
  scopes: string[]
  shrClaims?: string
  shrNonce?: string
  shrOptions?: ShrOptions
  skipBrokerClaims?: boolean
  sshJwk?: string
  sshKid?: string
  storeInCache?: StoreInCache
  tokenBodyParameters?: StringDict
  tokenQueryParameters?: StringDict
}