new OAuth2(options)
OAuth2 class
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | OAuth2 config options
Properties
|
Methods
-
authenticate(username, password, callback) → {Promise.<TokenResponse>}
-
OAuth2 Username-Password Flow (Resource Owner Password Credentials)
Parameters:
Name Type Argument Description username
String Salesforce username password
String Salesforce password callback
Callback.<TokenResponse> <optional>
Callback function Returns:
- Type
- Promise.<TokenResponse>
-
getAuthorizationUrl(params) → {String}
-
Get Salesforce OAuth2 authorization page URL to redirect user agent.
Parameters:
Name Type Description params
Object Parameters Properties
Name Type Description scope
String Scope values in space-separated string state
String State parameter Returns:
Authorization page URL- Type
- String
-
refreshToken(refreshToken, callback) → {Promise.<TokenResponse>}
-
OAuth2 Refresh Token Flow
Parameters:
Name Type Argument Description refreshToken
String Refresh token callback
Callback.<TokenResponse> <optional>
Callback function Returns:
- Type
- Promise.<TokenResponse>
-
requestToken(code, callback) → {Promise.<TokenResponse>}
-
OAuth2 Web Server Authentication Flow (Authorization Code) Access Token Request
Parameters:
Name Type Argument Description code
String Authorization code callback
Callback.<TokenResponse> <optional>
Callback function Returns:
- Type
- Promise.<TokenResponse>