Class UserTokenClient

constructor

• new UserTokenClient(msAppId: string): UserTokenClient

  Creates a new instance of UserTokenClient.

  Parameters

  • msAppId: string

    The Microsoft application ID.

  Returns UserTokenClient

• new UserTokenClient(axiosInstance: AxiosInstance): UserTokenClient

  Creates a new instance of UserTokenClient.

  Parameters

  • axiosInstance: AxiosInstance

    The axios instance.

  Returns UserTokenClient

client

exchangeTokenAsync

• exchangeTokenAsync(
      userId: string,
      connectionName: string,
      channelIdComposite: string,
      tokenExchangeRequest: TokenExchangeRequest,
  ): Promise<TokenResponse>

  Exchanges the token.

  Parameters

  • userId: string

    The user ID.

  • connectionName: string

    The connection name.

  • channelIdComposite: string

    The channel ID.

  • tokenExchangeRequest: TokenExchangeRequest

    The token exchange request.

  Returns Promise<TokenResponse>

  A promise that resolves to the exchanged token.

getAadTokens

• getAadTokens(
      userId: string,
      connectionName: string,
      channelIdComposite: string,
      resourceUrls: AadResourceUrls,
  ): Promise<Record<string, TokenResponse>>

  Gets the AAD tokens.

  Parameters

  • userId: string

    The user ID.

  • connectionName: string

    The connection name.

  • channelIdComposite: string

    The channel ID.

  • resourceUrls: AadResourceUrls

    The resource URLs.

  Returns Promise<Record<string, TokenResponse>>

  A promise that resolves to the AAD tokens.

getSignInResource

• getSignInResource(
      msAppId: string,
      connectionName: string,
      conversation: ConversationReference,
      relatesTo?: ConversationReference,
  ): Promise<SignInResource>

  Gets the sign-in resource.

  Parameters

  • msAppId: string

    The application ID.

  • connectionName: string

    The connection name.

  • conversation: ConversationReference

    The conversation reference.

  • OptionalrelatesTo: ConversationReference

    Optional. The related conversation reference.

  Returns Promise<SignInResource>

  A promise that resolves to the signing resource.

getTokenOrSignInResource

• getTokenOrSignInResource(
      userId: string,
      connectionName: string,
      channelIdComposite: string,
      conversation: ConversationReference,
      relatesTo: ConversationReference,
      code: string,
      finalRedirect?: string,
      fwdUrl?: string,
  ): Promise<TokenOrSinginResourceResponse>

  Gets the token or sign-in resource.

  Parameters

  • userId: string

    The user ID.

  • connectionName: string

    The connection name.

  • channelIdComposite: string

    The channel ID.

  • conversation: ConversationReference

    The conversation reference.

  • relatesTo: ConversationReference

    The related conversation reference.

  • code: string

    The code.

  • finalRedirect: string = ''

    The final redirect URL.

  • fwdUrl: string = ''

    The forward URL.

  Returns Promise<TokenOrSinginResourceResponse>

  A promise that resolves to the token or sign-in resource response.

getTokenStatus

• getTokenStatus(
      userId: string,
      channelIdComposite: string,
      include?: string,
  ): Promise<TokenStatus[]>

  Gets the token status.

  Parameters

  • userId: string

    The user ID.

  • channelIdComposite: string

    The channel ID.

  • include: string = ...

    The optional include parameter.

  Returns Promise<TokenStatus[]>

  A promise that resolves to the token status.

getUserToken

• getUserToken(
      connectionName: string,
      channelIdComposite: string,
      userId: string,
      code?: string,
  ): Promise<TokenResponse>

  Gets the user token.

  Parameters

  • connectionName: string

    The connection name.

  • channelIdComposite: string

    The channel ID.

  • userId: string

    The user ID.

  • Optionalcode: string

    The optional code.

  Returns Promise<TokenResponse>

  A promise that resolves to the user token.

signOut

• signOut(
      userId: string,
      connectionName: string,
      channelIdComposite: string,
  ): Promise<void>

  Signs the user out.

  Parameters

  • userId: string

    The user ID.

  • connectionName: string

    The connection name.

  • channelIdComposite: string

    The channel ID.

  Returns Promise<void>

  A promise that resolves when the sign-out operation is complete.

updateAuthToken

• updateAuthToken(token: string): void

  Parameters

  • token: string

  Returns void

StaticcreateClientWithScope

• createClientWithScope(
      baseURL: string,
      authProvider: AuthProvider,
      scope: string,
      headers?: HeaderPropagationCollection,
  ): Promise<UserTokenClient>

  Creates a new instance of UserTokenClient with authentication.

  Parameters

  • baseURL: string

    The base URL for the API.

  • authProvider: AuthProvider

    The authentication provider.

  • scope: string

    The scope for the authentication token.

  • Optionalheaders: HeaderPropagationCollection

    Optional headers to propagate in the request.

  Returns Promise<UserTokenClient>

  A new instance of ConnectorClient.