UserToken class

Class representing a UserToken.

Constructors

UserToken(TokenApiClientContext)

Create a UserToken.

Methods

exchangeAsync(string, string, string, TokenExchangeRequest, RequestOptionsBase)
exchangeAsync(string, string, string, TokenExchangeRequest, RequestOptionsBase, ServiceCallback<any>)
exchangeAsync(string, string, string, TokenExchangeRequest, ServiceCallback<any>)
getAadTokens(string, string, AadResourceUrls, ServiceCallback<[key: string]: TokenResponse>)
getAadTokens(string, string, AadResourceUrls, UserTokenGetAadTokensOptionalParams)
getAadTokens(string, string, AadResourceUrls, UserTokenGetAadTokensOptionalParams, ServiceCallback<[key: string]: TokenResponse>)
getToken(string, string, ServiceCallback<TokenResponse>)
getToken(string, string, UserTokenGetTokenOptionalParams)
getToken(string, string, UserTokenGetTokenOptionalParams, ServiceCallback<TokenResponse>)
getTokenStatus(string, ServiceCallback<TokenStatus[]>)
getTokenStatus(string, UserTokenGetTokenStatusOptionalParams)
getTokenStatus(string, UserTokenGetTokenStatusOptionalParams, ServiceCallback<TokenStatus[]>)
signOut(string, ServiceCallback<any>)
signOut(string, UserTokenSignOutOptionalParams)
signOut(string, UserTokenSignOutOptionalParams, ServiceCallback<any>)

Constructor Details

UserToken(TokenApiClientContext)

Create a UserToken.

new UserToken(client: TokenApiClientContext)

Parameters

client
TokenApiClientContext

Reference to the service client.

Method Details

exchangeAsync(string, string, string, TokenExchangeRequest, RequestOptionsBase)

function exchangeAsync(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest, options?: RequestOptionsBase): Promise<Models.UserTokenExchangeAsyncResponse>

Parameters

userId

string

connectionName

string

channelId

string

exchangeRequest

TokenExchangeRequest

options

RequestOptionsBase

Returns

Promise<Models.UserTokenExchangeAsyncResponse>

Promise<Models.UserTokenExchangeAsyncResponse>

exchangeAsync(string, string, string, TokenExchangeRequest, RequestOptionsBase, ServiceCallback<any>)

function exchangeAsync(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest, options: RequestOptionsBase, callback: ServiceCallback<any>)

Parameters

userId

string

connectionName

string

channelId

string

exchangeRequest

TokenExchangeRequest

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<any>

The callback

exchangeAsync(string, string, string, TokenExchangeRequest, ServiceCallback<any>)

function exchangeAsync(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest, callback: ServiceCallback<any>)

Parameters

userId

string

connectionName

string

channelId

string

exchangeRequest

TokenExchangeRequest

callback

ServiceCallback<any>

The callback

getAadTokens(string, string, AadResourceUrls, ServiceCallback<[key: string]: TokenResponse>)

function getAadTokens(userId: string, connectionName: string, aadResourceUrls: AadResourceUrls, callback: ServiceCallback<[key: string]: TokenResponse>)

Parameters

userId

string

connectionName

string

aadResourceUrls
AadResourceUrls
callback

ServiceCallback<[key: string]: TokenResponse>

The callback

getAadTokens(string, string, AadResourceUrls, UserTokenGetAadTokensOptionalParams)

function getAadTokens(userId: string, connectionName: string, aadResourceUrls: AadResourceUrls, options?: UserTokenGetAadTokensOptionalParams): Promise<Models.UserTokenGetAadTokensResponse>

Parameters

userId

string

connectionName

string

aadResourceUrls
AadResourceUrls

Returns

Promise<Models.UserTokenGetAadTokensResponse>

Promise<Models.UserTokenGetAadTokensResponse>

getAadTokens(string, string, AadResourceUrls, UserTokenGetAadTokensOptionalParams, ServiceCallback<[key: string]: TokenResponse>)

function getAadTokens(userId: string, connectionName: string, aadResourceUrls: AadResourceUrls, options: UserTokenGetAadTokensOptionalParams, callback: ServiceCallback<[key: string]: TokenResponse>)

Parameters

userId

string

connectionName

string

aadResourceUrls
AadResourceUrls
options
UserTokenGetAadTokensOptionalParams

The optional parameters

callback

ServiceCallback<[key: string]: TokenResponse>

The callback

getToken(string, string, ServiceCallback<TokenResponse>)

function getToken(userId: string, connectionName: string, callback: ServiceCallback<TokenResponse>)

Parameters

userId

string

connectionName

string

callback

ServiceCallback<TokenResponse>

The callback

getToken(string, string, UserTokenGetTokenOptionalParams)

function getToken(userId: string, connectionName: string, options?: UserTokenGetTokenOptionalParams): Promise<Models.UserTokenGetTokenResponse>

Parameters

userId

string

connectionName

string

Returns

Promise<Models.UserTokenGetTokenResponse>

Promise<Models.UserTokenGetTokenResponse>

getToken(string, string, UserTokenGetTokenOptionalParams, ServiceCallback<TokenResponse>)

function getToken(userId: string, connectionName: string, options: UserTokenGetTokenOptionalParams, callback: ServiceCallback<TokenResponse>)

Parameters

userId

string

connectionName

string

options
UserTokenGetTokenOptionalParams

The optional parameters

callback

ServiceCallback<TokenResponse>

The callback

getTokenStatus(string, ServiceCallback<TokenStatus[]>)

function getTokenStatus(userId: string, callback: ServiceCallback<TokenStatus[]>)

Parameters

userId

string

callback

ServiceCallback<TokenStatus[]>

The callback

getTokenStatus(string, UserTokenGetTokenStatusOptionalParams)

function getTokenStatus(userId: string, options?: UserTokenGetTokenStatusOptionalParams): Promise<Models.UserTokenGetTokenStatusResponse>

Parameters

userId

string

Returns

Promise<Models.UserTokenGetTokenStatusResponse>

Promise<Models.UserTokenGetTokenStatusResponse>

getTokenStatus(string, UserTokenGetTokenStatusOptionalParams, ServiceCallback<TokenStatus[]>)

function getTokenStatus(userId: string, options: UserTokenGetTokenStatusOptionalParams, callback: ServiceCallback<TokenStatus[]>)

Parameters

userId

string

options
UserTokenGetTokenStatusOptionalParams

The optional parameters

callback

ServiceCallback<TokenStatus[]>

The callback

signOut(string, ServiceCallback<any>)

function signOut(userId: string, callback: ServiceCallback<any>)

Parameters

userId

string

callback

ServiceCallback<any>

The callback

signOut(string, UserTokenSignOutOptionalParams)

function signOut(userId: string, options?: UserTokenSignOutOptionalParams): Promise<Models.UserTokenSignOutResponse>

Parameters

userId

string

Returns

Promise<Models.UserTokenSignOutResponse>

Promise<Models.UserTokenSignOutResponse>

signOut(string, UserTokenSignOutOptionalParams, ServiceCallback<any>)

function signOut(userId: string, options: UserTokenSignOutOptionalParams, callback: ServiceCallback<any>)

Parameters

userId

string

options
UserTokenSignOutOptionalParams

The optional parameters

callback

ServiceCallback<any>

The callback