AppCredentials class

패키지:

botframework-connector

일반 AppCredentials 인증 구현 및 캐시입니다. ADAL 클라이언트 자격 증명 흐름을 지원합니다. 서브클래스는 refreshToken을 구현하여 토큰을 획득할 수 있습니다.

생성자

AppCredentials(string, string, string)

AppCredentials 클래스의 새 인스턴스를 초기화합니다.

속성

appId
oAuthEndpoint	사용할 OAuth 엔드포인트를 가져옵니다. 사용할 OAuth 엔드포인트를 설정합니다.
oAuthScope	사용할 OAuth 범위를 가져옵니다. 사용할 OAuth 범위를 설정합니다.
tokenCacheKey

메서드

getToken(boolean)	OAuth 액세스 토큰을 가져옵니다.
isTrustedServiceUrl(string)	서비스 URL이 신뢰할 수 있는 호스트에 대한 것인지 여부를 확인합니다.
signRequest(WebResource)	HTTP 요청에 자격 증명을 적용합니다.
trustServiceUrl(string, Date)	신뢰할 수 있는 호스트에 서비스 URL의 호스트를 추가합니다. 만료 시간이 제공되지 않으면 만료 날짜는 현재(utc) 날짜 + 1일이 됩니다.

생성자 세부 정보

AppCredentials(string, string, string)

AppCredentials 클래스의 새 인스턴스를 초기화합니다.

new AppCredentials(appId: string, channelAuthTenant?: string, oAuthScope?: string)

매개 변수

appId

string

앱 ID입니다.

channelAuthTenant

string

선택적. oauth 토큰 테넌트입니다.

oAuthScope

string

토큰의 범위입니다.

속성 세부 정보

appId

appId: string

속성 값

string

oAuthEndpoint

사용할 OAuth 엔드포인트를 가져옵니다. 사용할 OAuth 엔드포인트를 설정합니다.

string oAuthEndpoint

속성 값

string

사용할 OAuthEndpoint입니다.

oAuthScope

사용할 OAuth 범위를 가져옵니다. 사용할 OAuth 범위를 설정합니다.

string oAuthScope

속성 값

string

사용할 OAuth 범위입니다.

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

True이면 서비스 URL의 호스트를 신뢰할 수 있습니다. 그렇지 않으면 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