Class SalesforceOAuth2

constructor

• new SalesforceOAuth2(options): SalesforceOAuth2

• Parameters

  • options: SalesforceOAuth2Options

  Returns SalesforceOAuth2

Readonly authzServiceUrl

Readonly clientId

Readonly clientSecret

Readonly loginUrl

Readonly redirectUri

Readonly revokeServiceUrl

Readonly tokenServiceUrl

authenticate

• authenticate(username, password): Promise<OAuth2TokenResponse>

• Parameters

  • username: string

  • password: string

  Returns Promise<OAuth2TokenResponse>

getAuthorizationUrl

• getAuthorizationUrl(params?): string

• Parameters

  • Optional params: {
        scope?: string;
        state?: string;
    }

    • Optional scope?: string

    • Optional state?: string

  Returns string

introspect

• introspect(token, type): Promise<Record<string, any>>

• Introspect checks the current state of an OAuth 2.0 access or refresh token.

  Parameters

  • token: string

    Token strign to introspect

  • type: "refresh_token" | "access_token"

    Type of token to introspect

  Returns Promise<Record<string, any>>

refreshToken

• refreshToken(refreshToken): Promise<OAuth2TokenResponse>

• Refreshes the oauth token and returns an OAuth2TokenResponse object.

  Parameters

  • refreshToken: string

    The refresh token used to get a new access token

  Returns Promise<OAuth2TokenResponse>

  New access token

requestToken

• requestToken(code): Promise<OAuth2TokenResponse>

• Parameters

  • code: string

  Returns Promise<OAuth2TokenResponse>

revokeToken

• revokeToken(token): Promise<undefined>

• Parameters

  • token: string

  Returns Promise<undefined>

userInfo

• userInfo(accessToken): Promise<Record<string, any>>

• Retrieves user information using the provided access token.

  Parameters

  • accessToken: string

    The access token to use for authentication.

  Returns Promise<Record<string, any>>

  A promise that resolves to an object containing user information.