DeviceTokenCredentials class
- Rozszerzenie
Konstruktory
| Device |
Tworzy nowy obiekt DeviceTokenCredentials, który pobiera nowy token dostępu przy użyciu userCodeInfo (zawiera user_code, device_code) na potrzeby uwierzytelniania użytkownika na urządzeniu. Gdy to poświadczenie zostanie użyte, skrypt udostępni adres URL i kod. Użytkownik musi skopiować adres URL i kod, wkleić go w przeglądarce i uwierzytelnić tam. W przypadku powodzenia skrypt pobierze token dostępu. |
Właściwości
| username |
Właściwości dziedziczone
| auth |
|
| client |
|
| domain | |
| environment | |
| token |
|
| token |
Metody
| get |
Początkowo próbuje pobrać token z pamięci podręcznej. Jeśli to się nie powiedzie, spróbuje pobrać token z biblioteki ADAL. |
Metody dziedziczone
| set |
|
| sign |
Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie). |
Szczegóły konstruktora
DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)
Tworzy nowy obiekt DeviceTokenCredentials, który pobiera nowy token dostępu przy użyciu userCodeInfo (zawiera user_code, device_code) na potrzeby uwierzytelniania użytkownika na urządzeniu.
Gdy to poświadczenie zostanie użyte, skrypt udostępni adres URL i kod. Użytkownik musi skopiować adres URL i kod, wkleić go w przeglądarce i uwierzytelnić tam. W przypadku powodzenia skrypt pobierze token dostępu.
new DeviceTokenCredentials(clientId?: string, domain?: string, username?: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)Parametry
- clientId
-
string
Identyfikator klienta aplikacji usługi Active Directory.
- domain
-
string
Identyfikator domeny lub dzierżawy zawierający tę aplikację. Wartość domyślna to "common"
- username
-
string
Nazwa użytkownika konta w postaci: "user@example.com".
- tokenAudience
- TokenAudience
Odbiorcy, dla których żądano tokenu. Prawidłowe wartości to "graph", "batch" lub dowolny inny zasób, taki jak "https://vault.azure.net/". Jeśli tokenAudience ma wartość "graph", należy również podać domenę, a jej wartość nie powinna być domyślną dzierżawą "common". Musi to być ciąg (preferowanie w formacie guid). Zobacz Przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net, aby zapoznać się z przykładem.
- environment
- Environment
Środowisko platformy Azure do uwierzytelniania za pomocą polecenia. Domyślne środowisko to "Azure" powszechnie znane jako "Publiczna chmura platformy Azure".
- tokenCache
-
TokenCache
Pamięć podręczna tokenów. Wartość domyślna to obiekt MemoryCache z biblioteki adal.
Szczegóły właściwości
username
username: stringWartość właściwości
string
Szczegóły właściwości dziedziczonej
authContext
authContext: AuthenticationContextWartość właściwości
AuthenticationContext
dziedziczone zTokenCredentialsBase.authContext
clientId
domain
environment
tokenAudience
tokenCache
Szczegóły metody
getToken()
Początkowo próbuje pobrać token z pamięci podręcznej. Jeśli to się nie powiedzie, spróbuje pobrać token z biblioteki ADAL.
function getToken(): Promise<TokenResponse>Zwraca
Promise<TokenResponse>
TokenResponse (tokenType i accessToken są dwiema ważnymi właściwościami).
Szczegóły metody dziedziczonej
setDomain(string)
function setDomain(domain: string)Parametry
- domain
-
string
dziedziczone zTokenCredentialsBase.setDomain
signRequest(WebResource)
Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).
function signRequest(webResource: WebResource): Promise<WebResource>Parametry
- webResource
- WebResource
Element WebResource do podpisania.
Zwraca
Promise<WebResource>
dziedziczone zTokenCredentialsBase.signRequest