MicrosoftAppCredentials class
MicrosoftAppCredentials 認証の実装
- Extends
コンストラクター
| Microsoft |
MicrosoftAppCredentials クラスの新しいインスタンスを初期化します。 |
プロパティ
| app |
|
| Empty | 空の資格情報のセット。 |
| o |
使用する OAuth エンドポイントを取得します。 使用する OAuth エンドポイントを設定します。 |
| o |
使用する OAuth スコープを取得します。 使用する OAuth スコープを設定します。 |
継承されたプロパティ
| app |
|
| token |
継承されたメソッド
| get |
OAuth アクセス トークンを取得します。 |
| is |
サービス URL が信頼されたホスト用かどうかを確認します。 |
| sign |
資格情報を HTTP 要求に適用します。 |
| trust |
信頼されたホストにサービス URL のホストを追加します。 有効期限が指定されていない場合、有効期限は現在 (utc) の日付 + 1 日になります。 |
コンストラクターの詳細
MicrosoftAppCredentials(string, string, string, string)
MicrosoftAppCredentials クラスの新しいインスタンスを初期化します。
new MicrosoftAppCredentials(appId: string, appPassword: string, channelAuthTenant?: string, oAuthScope?: string)パラメーター
- appId
-
string
Microsoft アプリ ID。
- appPassword
-
string
Microsoft アプリのパスワード。
- channelAuthTenant
-
string
随意。 oauth トークン テナント。
- oAuthScope
-
string
随意。 トークンのスコープ。
プロパティの詳細
appPassword
appPassword: stringプロパティ値
string
Empty
oAuthEndpoint
使用する OAuth エンドポイントを取得します。 使用する OAuth エンドポイントを設定します。
string oAuthEndpointプロパティ値
string
使用する OAuthEndpoint。
oAuthScope
使用する OAuth スコープを取得します。 使用する OAuth スコープを設定します。
string oAuthScopeプロパティ値
string
使用する OAuth スコープ。
継承されたプロパティの詳細
appId
appId: stringプロパティ値
string
tokenCacheKey
tokenCacheKey: stringプロパティ値
string
継承済みメソッドの詳細
getToken(boolean)
OAuth アクセス トークンを取得します。
function getToken(forceRefresh?: boolean): Promise<string>パラメーター
- forceRefresh
-
boolean
トークンの更新を強制する場合は True。キャッシュされたトークンが存在する場合は false。
戻り値
Promise<string>
実行するキューに登録された作業を表す Promise。
注釈
promise が成功した場合、結果にはアクセス トークン文字列が含まれます。
isTrustedServiceUrl(string)
警告
この API は非推奨になりました。
サービス URL が信頼されたホスト用かどうかを確認します。
static function isTrustedServiceUrl(serviceUrl: string): booleanパラメーター
- serviceUrl
-
string
サービス URL
戻り値
boolean
サービス URL のホストが信頼されている場合は True。それ以外の場合は False。
signRequest(WebResource)
資格情報を HTTP 要求に適用します。
function signRequest(webResource: WebResource): Promise<WebResource>パラメーター
- webResource
-
WebResource
WebResource HTTP 要求。
戻り値
Promise<WebResource>
非同期操作を表す Promise。
trustServiceUrl(string, Date)
警告
この API は非推奨になりました。
信頼されたホストにサービス URL のホストを追加します。 有効期限が指定されていない場合、有効期限は現在 (utc) の日付 + 1 日になります。
static function trustServiceUrl(serviceUrl: string, expiration?: Date)パラメーター
- serviceUrl
-
string
サービス URL
- expiration
-
Date