Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-01-027446226.6 KB
salesforce-oauth

Authorize Salesforce

Start Salesforce OAuth flow

Parameters:

  • instance_id: Identifier for the instance requesting authorization
  • client_id: Optional client ID for white labeling
  • scope: Optional scopes to request (space-separated)
  • redirect_url: Optional URL to redirect to after authorization completes
  • instance_url: Optional Salesforce instance URL for sandbox or custom domains
get/oauth/salesforce/authorize

Query parameters

instance_idstring required

Unique identifier for the client instance requesting authorization

Unique identifier for the client instance requesting authorization

client_idstring nullable

Client ID for white labeling, if not provided will use default credentials

Client ID for white labeling, if not provided will use default credentials

scopestring nullable

Optional OAuth scopes to request (space-separated string)

Optional OAuth scopes to request (space-separated string)

redirect_urlstring nullable

Optional URL to redirect to after authorization completes

Optional URL to redirect to after authorization completes

instance_urlstring nullable

Salesforce instance URL (e.g., https://mycompany.salesforce.com). If not provided, will use default login.salesforce.com

Salesforce instance URL (e.g., https://mycompany.salesforce.com). If not provided, will use default login.salesforce.com

Response

Successful Response

{"stackTrail":"paths:/oauth/salesforce/authorize:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}