BaseAuthRequest type

BaseAuthRequest

  • authority - 權限機構的網址,即 MSAL 取得權杖的安全性憑證服務(STS)。 預設為 https://login.microsoftonline.com/common。 如果所有請求都使用相同的權威,權威應該設在客戶端應用程式物件上,而非請求,以避免多次解析權威端點。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • 範圍(scopes)-應用程式請求存取權限的範圍陣列。
  • AuthenticationScheme - 所取得的憑證類型。 預設為「承載者」。 也可以是「pop」或「SSH」類型。
  • claims - 一個被要求的嚴格索賠請求,會被加入所有 /authorize 和 /token 呼叫中
  • shrClaims - 一個被加入已簽署 HTTP 請求的 stringified claims 物件
  • shrNonce - 一個由伺服器產生的時間戳,已加密並以 base64URL 編碼,將被加入 Signed HTTP 請求中。
  • shrOptions - 包含簽署 HTTP 請求選項的物件
  • resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型(例如「GET」、「POST」等)。 用於持有權證明流程。
  • resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。
  • sshJwk - 一個串聯的 JSON Web 金鑰,代表一個公鑰,可由 SSH 憑證簽署。
  • sshKid - 唯一識別上述 SSH 公鑰的金鑰 ID。
  • azureCloudOptions - 方便用戶提供公有/主權雲 ID 的函式列舉
  • requestedClaimsHash - SHA 256 請求權利要求字串的雜湊字串,作為存取權杖快取金鑰的一部分,以便被請求權稱過濾
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
  • tokenBodyParameters - 將自訂參數加入 /token 呼叫主體的字串對字串映射
  • storeInCache - 包含布林值的物件,指示是否要將標記存放在快取中(預設為真)
  • scenarioId - 用於追蹤自訂使用者提示的情境ID
  • popKid - 用於識別 PoP 令牌請求公鑰的金鑰 ID
  • embeddedClientID - 嵌入客戶端 ID。指定時,代理客戶 ID(brk_client_id)與重定向 uri(brk_redirect_uri)參數會以設定檔中的值設定,若有則覆蓋相應的額外參數。
  • httpMethod - 用於 /authorize 請求的 HTTP 方法。 預設為 GET,但如果請求需要 body 參數,也可以設為 POST
  • authorizePostBodyParameters - 當 httpMethod 設為 POST 時,自訂參數的字串對字串映射到 /authorize 呼叫的主體中
  • skipBrokerClaims - 當為真且使用經紀流程(例如存在經紀參數或嵌入客戶 ID)時,設定中的 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
}