Class OAuth2

constructor

• new OAuth2(config): OAuth2

• Parameters

  • config: OAuth2Config

  Returns OAuth2

_transport

authzServiceUrl

clientId

clientSecret

codeVerifier

loginUrl

redirectUri

revokeServiceUrl

tokenServiceUrl

authenticate

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

• OAuth2 Username-Password Flow (Resource Owner Password Credentials)

  Parameters

  • username: string
  • password: string

  Returns Promise<TokenResponse>

getAuthorizationUrl

• getAuthorizationUrl(params?): string

• Get Salesforce OAuth2 authorization page URL to redirect user agent.

  Parameters

  • params: AuthzRequestParams = {}

  Returns string

refreshToken

• refreshToken(refreshToken): Promise<TokenResponse>

• OAuth2 Refresh Token Flow

  Parameters

  • refreshToken: string

  Returns Promise<TokenResponse>

requestToken

• requestToken(codeOrParams, params?): Promise<TokenResponse>

• Send access token request to the token endpoint. When a code (string) is passed in first argument, it will use Web Server Authentication Flow (Authorization Code Grant). Otherwise, it will use the specified grant_type and pass parameters to the endpoint.

  Parameters

  • codeOrParams: string | {
        grant_type: string;
        [name: string]: string;
    }
  • params: {
        [prop: string]: string;
    } = {}

    • [prop: string]: string

  Returns Promise<TokenResponse>

revokeToken

• revokeToken(token): Promise<void>

• OAuth2 Revoke Session Token

  Parameters

  • token: string

  Returns Promise<void>