BaseAuthRequest type

Pakiet:
@azure/msal-common

BaseAuthRequest

  • authority — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. Wartość domyślna to https://login.microsoftonline.com/common. Jeśli używasz tego samego urzędu dla wszystkich żądań, urząd powinien ustawić dla obiektu aplikacji klienckiej, a nie żądać, aby uniknąć wielokrotnego rozpoznawania punktów końcowych urzędu.
  • correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii.
  • scopes — tablica zakresów, do których aplikacja żąda dostępu.
  • authenticationScheme — typ pobranego tokenu. Wartość domyślna to "Bearer". Można również wpisać "pop" lub "SSH".
  • claims — żądanie oświadczeń ciągyfikowanych, które zostanie dodane do wszystkich /authorize i /token wywołań
  • shrClaims — obiekt oświadczeń ciągyfikowanych, który zostanie dodany do podpisanego żądania HTTP
  • shrNonce — sygnatura czasowa wygenerowana przez serwer, która została zaszyfrowana i zakodowana w formacie base64URL, która zostanie dodana do podpisanego żądania HTTP.
  • shrOptions — obiekt zawierający opcje podpisanego żądania HTTP
  • resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania.
  • resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania.
  • sshJwk — ciągyfikowany klucz internetowy JSON reprezentujący klucz publiczny, który może być podpisany przez certyfikat SSH.
  • sshKid — identyfikator klucza, który jednoznacznie identyfikuje klucz publiczny SSH wymieniony powyżej.
  • azureCloudOptions — wyliczenie ciągów wygody dla użytkowników w celu udostępnienia identyfikatorów chmury publicznej/suwerennej
  • requestedClaimsHash — ciąg skrótu SHA 256 żądanego ciągu oświadczeń, używany jako część klucza pamięci podręcznej tokenu dostępu, dzięki czemu tokeny mogą być filtrowane według żądanych oświadczeń
  • tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
  • tokenBodyParameters — ciąg do ciągu mapy parametrów niestandardowych dodanych do treści wywołania /token
  • storeInCache — obiekt zawierający wartości logiczne wskazujące, czy mają być przechowywane tokeny w pamięci podręcznej, czy nie (wartość domyślna to prawda)
  • scenarioId — identyfikator scenariusza do śledzenia niestandardowych monitów użytkownika
  • popKid — identyfikator klucza identyfikujący klucz publiczny dla żądania tokenu poP
  • embeddedClientId — identyfikator klienta osadzonego. Po określeniu parametrów identyfikator klienta brokera (brk_client_id) i identyfikator przekierowania (brk_redirect_uri) są ustawiane z wartościami z konfiguracji, przesłaniając odpowiednie dodatkowe parametry, jeśli istnieją.
  • httpMethod — metoda HTTP do użycia dla żądania /authorize. Wartość domyślna to GET, ale można ustawić wartość POST, jeśli żądanie wymaga parametrów treści
  • authorizePostBodyParameters — ciąg do ciągu mapy parametrów niestandardowych dodanych do treści wywołania /authorize, gdy parametr httpMethod jest ustawiony na POST
  • skipBrokerClaims — jeśli jest używana wartość true i przepływ obsługiwany przez brokera (na przykład w przypadku wystąpienia parametrów brokera lub osadzonego identyfikatoraClientId), wartość clientCapabilities z konfiguracji zostanie wykluczona z oświadczeń; ignorowane dla przepływów bez brokera.
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
}