Class AuthFlowREST

Implements the RESTful authentication flow for Microsoft Graph API. Extends AuthFlowBase class.

Hierarchy

AuthFlowBase
- AuthFlowREST

Index

Constructors

Properties

accessToken clientId

Methods

getAccessToken getRefreshToken getTokens refreshAccessToken

Constructors

constructor

new AuthFlowREST(options?): AuthFlowREST
Creates an instance of AuthFlowREST.
Parameters
- options: {
      clientId?: string;
      clientSecret?: string;
      redirectUri?: string;
  } = {}
  
  Configuration options for the authentication flow.
  - Optional clientId?: string
    
    The client ID for authentication.
  - Optional clientSecret?: string
    
    The client secret for authentication.
  - Optional redirectUri?: string
    
    The redirect URI for authentication.
Returns AuthFlowREST
Overrides AuthFlowBase.constructor
- Defined in libs/langchain-community/src/tools/outlook/auth/rest.ts:59

Properties

`Protected` accessToken

accessToken: string = ""

The access token obtained through authentication.

Memberof

AuthFlowBase

`Protected` clientId

clientId: string

The client ID used for authentication.

Memberof

AuthFlowBase

Methods

getAccessToken

getAccessToken(): Promise<string>
returns a valid access token.

Returns Promise<string>
A Promise resolving to the access token.
Overrides AuthFlowBase.getAccessToken
- Defined in libs/langchain-community/src/tools/outlook/auth/rest.ts:286

getRefreshToken

getRefreshToken(): string
return the refresh token

Returns string
The refresh token.
- Defined in libs/langchain-community/src/tools/outlook/auth/rest.ts:239

getTokens

getTokens(): Promise<{
accessToken: string;
refreshToken: string;
}>
Login to get the access and refresh token by user login.

Returns Promise<{
accessToken: string;
refreshToken: string;
}>
A Promise resolving to the access and refresh tokens.
- Defined in libs/langchain-community/src/tools/outlook/auth/rest.ts:195

refreshAccessToken

refreshAccessToken(): Promise<string>
Refreshes the access token using the refresh token.

Returns Promise<string>
A Promise resolving to the refreshed access token.
- Defined in libs/langchain-community/src/tools/outlook/auth/rest.ts:248

Generated using TypeDoc