Salesforce

Delete a Salesforce org registration

delete

Removes the stored credentials for a Salesforce organization

Authorizations

Query parameters

usernamestringRequired

Username of the Salesforce org to delete, or sandbox name for sandboxes with no sfdxAuthUrl

Responses

200

Organization successfully deleted

404

Organization not found

delete

HTTPcURLJavaScriptPython

DELETE /sfp/api/auth/salesforce/org?username=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Get Salesforce org frontdoor URL (sandbox or scratch org)

get

Returns or redirects to a frontdoor URL for a sandbox or scratch org. If prodOrg is not specified for sandbox, uses the first registered production org.

Authorizations

Query parameters

targetstringRequired

Scratch org username or sandbox name

prodOrgstringOptional

Production org username or alias (for sandbox)

redirectbooleanOptional

Redirect to frontdoor URL (default true)

Responses

200Success

get

HTTPcURLJavaScriptPython

GET /sfp/api/auth/salesforce/frontdoor?target=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200Success

No content

List registered Salesforce orgs

get

Returns a list of all registered Salesforce organizations with optional filtering by type, alias, or registration type

Authorizations

Query parameters

typestringOptional

Filter organizations by type (e.g., "Developer Edition", "Production", "Sandbox")

aliasstringOptional

Filter organizations by alias

categorystring · enumOptional

Filter organizations by category ("test", "snapshot", "release") - preferred field

Possible values:

registrationTypestring · enumOptionalDeprecated

Filter organizations by registration type ("test", "snapshot", "release") - legacy field

Possible values:

envNamestringOptional

Filter organizations by environment name

Responses

200

List of registered organizations

application/json

get

HTTPcURLJavaScriptPython

GET /sfp/api/auth/salesforce/orgs HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200

List of registered organizations

[
  {
    "username": "text",
    "instanceUrl": "text",
    "alias": "text",
    "orgId": "00D1a000000xxxxx",
    "organizationType": "Enterprise Edition",
    "instanceName": "NA139",
    "category": "test",
    "envName": "Production",
    "createdAt": "2025-05-24T07:13:07.693Z"
  }
]

Register or update a Salesforce org

post

Registers a new Salesforce organization or updates an existing one.

      For complete registrations:
      - Provide sfdxAuthUrl (Generate using: sf org:display -u [e-mail] --verbose --json)
      - The connection is validated before registration
      
      For sandbox registrations:
      - sfdxAuthUrl is optional for sandbox orgs
      - When sfdxAuthUrl is not provided, the system will validate the sandbox
      - using devhub credentials, assuming the sandbox was created by the same 
      - user whose sfdxAuthUrl is available in the system
      - Just-in-time authentication will be used when accessing the org
      
      Optional registrationType can be specified: 'test', 'snapshot', or 'release'
      
      If an org with the same username exists, it will be updated.

Authorizations

Body

aliasstringOptional

Optional alias for the Salesforce org

Example: devhub

instanceUrlstringRequired

Instance URL of the Salesforce org

Example: https://mycompany.my.salesforce.comPattern: https://*.salesforce.com

usernamestringRequired

Username of the Salesforce integration user

Example: [e-mail]

sfdxAuthUrlstringOptional

SFDX Auth URL (generated using sf org:display -u [e-mail] --verbose --json). Optional for sandbox orgs.

Example: force://CLIENT_ID:CLIENT_SECRET:[e-mail]

categorystring · enumOptional

Optional category for the org (preferred field)

Example: testPossible values:

registrationTypestring · enumOptionalDeprecated

Optional registration type for categorizing orgs (legacy field)

Example: testPossible values:

sandboxNamestringOptional

Explicitly provide sandbox name when registering a sandbox without sfdxAuthUrl. If not provided, it will be extracted from the username.

Example: dev1

envNamestringOptional

Optional environment name for better identification

Example: Production

Responses

201

Organization successfully registered/updated

application/json

400

Invalid input or connection failed

post

HTTPcURLJavaScriptPython

POST /sfp/api/auth/salesforce/register HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "alias": "devhub",
  "instanceUrl": "https://mycompany.my.salesforce.com",
  "username": "[e-mail]",
  "sfdxAuthUrl": "force://CLIENT_ID:CLIENT_SECRET:[e-mail]",
  "category": "test",
  "sandboxName": "dev1",
  "envName": "Production"
}

{
  "username": "text",
  "instanceUrl": "text",
  "alias": "text",
  "orgId": "00D1a000000xxxxx",
  "organizationType": "Enterprise Edition",
  "instanceName": "NA139",
  "category": "test",
  "envName": "Production"
}

Test connection to a Salesforce org

post

Tests if the stored credentials for a given org are still valid

Authorizations

Query parameters

usernamestringRequired

Username of the Salesforce org to test, or sandbox name for sandboxes with no sfdxAuthUrl

Responses

200

Connection test results

application/json

404

Organization not found

post

HTTPcURLJavaScriptPython

POST /sfp/api/auth/salesforce/test-connection?username=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "isValid": true,
  "username": "text",
  "orgId": "text",
  "organizationType": "text",
  "instanceName": "text",
  "error": "text"
}

Get details of a specific Salesforce org

get

Returns detailed information about a specific registered Salesforce organization. Owner role and application tokens receive additional authentication details.

Authorizations

Query parameters

usernamestringRequired

Username of the Salesforce org to retrieve, or sandbox name for sandboxes with no sfdxAuthUrl

Responses

200

Organization details

application/json

404

Organization not found

get

HTTPcURLJavaScriptPython

GET /sfp/api/auth/salesforce/org?username=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "username": "text",
  "instanceUrl": "text",
  "alias": "text",
  "orgId": "00D1a000000xxxxx",
  "organizationType": "Enterprise Edition",
  "instanceName": "NA139",
  "category": "test",
  "envName": "Production",
  "createdAt": "2025-05-24T07:13:07.693Z"
}