ClientApplication class
Tüm ClientApplications için temel soyut sınıf - genel ve gizli
Yöntemler
| acquire |
OAuth2.0 Yetkilendirme Kodu akışının ilk adımından alınan Yetkilendirme Kodunu değiştirerek bir belirteç alır.
|
| acquire |
Yeni bir belirteç kümesi için sağlanan yenileme belirtecini değiştirerek bir belirteç alır. Bu API yalnızca ADAL'dan MSAL'ye geçiş yapmak istediğiniz senaryolar için sağlanır. Aksi takdirde, sessiz senaryolar için kullanmanız |
| acquire |
Kimlik bilgileri için istemci uygulamalarının kullanıcı adını ve parolasını değiştirerek parola verme ile belirteçleri alır En son OAuth 2.0 Güvenlik En İyi Güncel Uygulaması, parolanın verilmesine tamamen izin vermez. Microsoft belgelerinde ve önerilerinde bu öneriyle https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 ilgili diğer ayrıntılar şunlardır:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| acquire |
Kullanıcı belirtecin istendiği hesabı belirttiğinde sessizce belirteç alır. Bu API, kullanıcının bir hesap nesnesi sağlamasını bekler ve varsa belirteci almak için önbelleği arar.
Ayrıca kullanıcının access_token ve id_token önbelleğini atlamak için gönderebileceği isteğe bağlı bir "forceRefresh" boole değeri de vardır.
refresh_token süresinin dolması veya bulunmaması durumunda bir hata oluşturulur ve kullanıcının herhangi bir etkileşimli belirteç alma API'sini çağırması için rehberlik sağlanır (örneğin: |
| clear |
Önbelleği temizleme |
| get |
Kullanıcının uygulamaya kimlik bilgileri girip onay vermesine izin vererek yetkilendirme isteğinin URL'sini oluşturur. URL, uygulama nesnesinde yapılandırılan yetkilinin /authorize uç noktasını hedefler. Kullanıcı kimlik bilgilerini ve onaylarını girdikten sonra, yetkili istekte gönderilen yeniden yönlendirme URI'sine bir yanıt gönderir ve daha sonra aracılığıyla |
| get |
Günlükçü örneğini verir |
| get |
Uygulama için belirteç önbelleğini alır. |
| set |
Yapılandırmalardaki varsayılan günlükçü kümesini yeni Günlükçü ile yeni yapılandırmalarla değiştirir |
Yöntem Ayrıntıları
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
OAuth2.0 Yetkilendirme Kodu akışının ilk adımından alınan Yetkilendirme Kodunu değiştirerek bir belirteç alır.
getAuthCodeUrl(AuthorizationCodeUrlRequest) OAuth2.0 Yetkilendirme Kodu akışının ilk adımının URL'sini oluşturmak için kullanılabilir. AuthorizationCodeUrlRequest ve AuthorizationCodeRequest içindeki redirectUri ve kapsam değerlerinin aynı olduğundan emin olun.
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
Parametreler
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
Döndürülenler
Promise<AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
Yeni bir belirteç kümesi için sağlanan yenileme belirtecini değiştirerek bir belirteç alır.
Bu API yalnızca ADAL'dan MSAL'ye geçiş yapmak istediğiniz senaryolar için sağlanır. Aksi takdirde, sessiz senaryolar için kullanmanız acquireTokenSilent() önerilir. kullanırken acquireTokenSilent()MSAL, belirteçlerin önbelleğe alınmasını ve yenilenmesini otomatik olarak işler.
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
Parametreler
- request
- RefreshTokenRequest
Döndürülenler
Promise<null | AuthenticationResult>
acquireTokenByUsernamePassword(UsernamePasswordRequest)
Uyarı
Bu API artık kullanım dışıdır.
- Use a more secure flow instead
Kimlik bilgileri için istemci uygulamalarının kullanıcı adını ve parolasını değiştirerek parola verme ile belirteçleri alır
En son OAuth 2.0 Güvenlik En İyi Güncel Uygulaması, parolanın verilmesine tamamen izin vermez. Microsoft belgelerinde ve önerilerinde bu öneriyle https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 ilgili diğer ayrıntılar şunlardır:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
Parametreler
- request
- UsernamePasswordRequest
UsenamePasswordRequest
Döndürülenler
Promise<null | AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
Kullanıcı belirtecin istendiği hesabı belirttiğinde sessizce belirteç alır.
Bu API, kullanıcının bir hesap nesnesi sağlamasını bekler ve varsa belirteci almak için önbelleği arar.
Ayrıca kullanıcının access_token ve id_token önbelleğini atlamak için gönderebileceği isteğe bağlı bir "forceRefresh" boole değeri de vardır.
refresh_token süresinin dolması veya bulunmaması durumunda bir hata oluşturulur ve kullanıcının herhangi bir etkileşimli belirteç alma API'sini çağırması için rehberlik sağlanır (örneğin: acquireTokenByCode()).
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
Parametreler
- request
- SilentFlowRequest
Döndürülenler
Promise<AuthenticationResult>
clearCache()
Önbelleği temizleme
function clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
Kullanıcının uygulamaya kimlik bilgileri girip onay vermesine izin vererek yetkilendirme isteğinin URL'sini oluşturur. URL, uygulama nesnesinde yapılandırılan yetkilinin /authorize uç noktasını hedefler.
Kullanıcı kimlik bilgilerini ve onaylarını girdikten sonra, yetkili istekte gönderilen yeniden yönlendirme URI'sine bir yanıt gönderir ve daha sonra aracılığıyla acquireTokenByCode(AuthorizationCodeRequest)belirteç almak için kullanılabilecek bir yetkilendirme kodu içermelidir.
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
Parametreler
- request
- AuthorizationUrlRequest
Döndürülenler
Promise<string>
getLogger()
getTokenCache()
Uygulama için belirteç önbelleğini alır.
function getTokenCache(): TokenCache
Döndürülenler
setLogger(Logger)
Yapılandırmalardaki varsayılan günlükçü kümesini yeni Günlükçü ile yeni yapılandırmalarla değiştirir
function setLogger(logger: Logger)
Parametreler
- logger
- Logger
Günlükçü örneği