DeviceTokenCredentials class
- Extends
コンストラクター
| Device |
デバイス上のユーザーを認証するために、userCodeInfo (user_code、device_code を含む) を使用して新しいアクセス トークンを取得する新しい DeviceTokenCredentials オブジェクトを作成します。 この資格情報を使用すると、スクリプトは URL とコードを提供します。 ユーザーは URL とコードをコピーし、ブラウザに貼り付けて、そこで認証する必要があります。 成功すると、スクリプトはアクセストークンを取得します。 |
プロパティ
| username |
継承されたプロパティ
| auth |
|
| client |
|
| domain | |
| environment | |
| token |
|
| token |
メソッド
| get |
最初にキャッシュからトークンを取得しようとします。 失敗した場合は、ADAL からトークンを取得しようとします。 |
継承されたメソッド
| set |
|
| sign |
Authentication ヘッダーを使用して要求に署名します。 |
コンストラクターの詳細
DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)
デバイス上のユーザーを認証するために、userCodeInfo (user_code、device_code を含む) を使用して新しいアクセス トークンを取得する新しい DeviceTokenCredentials オブジェクトを作成します。
この資格情報を使用すると、スクリプトは URL とコードを提供します。 ユーザーは URL とコードをコピーし、ブラウザに貼り付けて、そこで認証する必要があります。 成功すると、スクリプトはアクセストークンを取得します。
new DeviceTokenCredentials(clientId?: string, domain?: string, username?: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)パラメーター
- clientId
-
string
Active Directory アプリケーション クライアント ID。
- domain
-
string
このアプリケーションを含むドメインまたはテナント ID。 デフォルト値は「common」です。
- username
-
string
「user@example.com」の形式のアカウントのユーザー名。
- tokenAudience
- TokenAudience
トークンが要求される対象ユーザー。 有効な値は、'graph'、'batch'、または 'https://vault.azure.net/' のような他のリソースです。 tokenAudience が 'graph' の場合は、ドメインも指定する必要があり、その値は既定の "共通" テナントにすることはできません。 文字列である必要があります (好ましくは guid 形式)。 例については、「Active Directory クイック スタート for .Net」を参照してください。
- environment
- Environment
認証に使用する Azure 環境。 既定の環境は、一般に "パブリック Azure クラウド" として知られている "Azure" です。
- tokenCache
-
TokenCache
トークン キャッシュ。 既定値は、adal の MemoryCache オブジェクトです。
プロパティの詳細
username
username: stringプロパティ値
string
継承されたプロパティの詳細
authContext
clientId
domain
environment
tokenAudience
tokenCache
メソッドの詳細
getToken()
最初にキャッシュからトークンを取得しようとします。 失敗した場合は、ADAL からトークンを取得しようとします。
function getToken(): Promise<TokenResponse>戻り値
Promise<TokenResponse>
tokenResponse (tokenType と accessToken は 2 つの重要なプロパティです)。
継承済みメソッドの詳細
setDomain(string)
signRequest(WebResource)
Authentication ヘッダーを使用して要求に署名します。
function signRequest(webResource: WebResource): Promise<WebResource>パラメーター
- webResource
- WebResource
署名する WebResource。
戻り値
Promise<WebResource>