Class SalesforceOAuth2

Index

Constructors

Properties

authzServiceUrl clientId clientSecret loginUrl redirectUri revokeServiceUrl tokenServiceUrl transport

Methods

authenticate clientCredentialsToken getAuthorizationUrl introspect post refreshToken requestToken revokeToken userInfo

Constructors

constructor

new SalesforceOAuth2(options: SalesforceOAuth2Options): SalesforceOAuth2
Parameters
- options: SalesforceOAuth2Options
Returns SalesforceOAuth2
- Defined in packages/salesforce/src/connection/oath2.ts:41

Properties

`Readonly`authzServiceUrl

authzServiceUrl: string

`Readonly`clientId

clientId: string

`Readonly`clientSecret

clientSecret: string

`Readonly`loginUrl

loginUrl: string

`Readonly`redirectUri

redirectUri: string

`Readonly`revokeServiceUrl

revokeServiceUrl: string

`Readonly`tokenServiceUrl

tokenServiceUrl: string

`Private` `Readonly`transport

transport: Transport

Methods

authenticate

authenticate(username: string, password: string): Promise<OAuth2TokenResponse>
Parameters
- username: string
- password: string
Returns Promise<OAuth2TokenResponse>
- Defined in packages/salesforce/src/connection/oath2.ts:96

clientCredentialsToken

clientCredentialsToken(scope?: string): Promise<OAuth2AccessTokenResponse>
Requests a new access token using OAuth2 Client Credentials grant.
Parameters
- Optionalscope: string
  Optional OAuth scope
Returns Promise<OAuth2AccessTokenResponse>
- Defined in packages/salesforce/src/connection/oath2.ts:135

getAuthorizationUrl

getAuthorizationUrl(params?: { scope?: string; state?: string }): string
Parameters
- Optionalparams: { scope?: string; state?: string }
Returns string
- Defined in packages/salesforce/src/connection/oath2.ts:70

introspect

introspect(
token: string,
type: "access_token" | "refresh_token",
): 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: "access_token" | "refresh_token"
  Type of token to introspect
Returns Promise<Record<string, any>>
- Defined in packages/salesforce/src/connection/oath2.ts:168

`Private`post

post<T>(params: Record<string, string>, options?: { url?: string }): Promise<T>
Post a request to token service
Type Parameters
- T
Parameters
- params: Record<string, string>
  Params as object send as URL encoded data
- Optionaloptions: { url?: string }
Returns Promise<T>
Response body as JSON object
- Defined in packages/salesforce/src/connection/oath2.ts:181

refreshToken

refreshToken(refreshToken: string): 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
- Defined in packages/salesforce/src/connection/oath2.ts:119

requestToken

requestToken(code: string): Promise<OAuth2TokenResponse>
Parameters
- code: string
Returns Promise<OAuth2TokenResponse>
- Defined in packages/salesforce/src/connection/oath2.ts:81

revokeToken

revokeToken(token: string): Promise<undefined>
Parameters
- token: string
Returns Promise<undefined>
- Defined in packages/salesforce/src/connection/oath2.ts:110

userInfo

userInfo(accessToken: string): 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.
- Defined in packages/salesforce/src/connection/oath2.ts:155