Salesforce

Delete a Salesforce org registration

delete

Removes the stored credentials for a Salesforce organization

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

usernamestringRequired

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

Responses

200

Organization successfully deleted

No content

403

Forbidden - Requires role: owner

404

Organization not found

delete

/sfp/api/auth/salesforce/org

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

No content

Get Salesforce org frontdoor URL

get

Returns or redirects to a frontdoor URL for a sandbox or scratch org.

    The endpoint will check in order:
    1. Registered orgs with stored auth URLs
    2. Pool instances (if repository is provided)
    3. Dynamic generation using production org credentials
    
    For pool instances, the repository parameter is required to ensure the correct sandbox is accessed.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetstringRequired

Scratch org username, sandbox name, or pool instance name

repositorystringOptional

Repository identifier (org/repo) to search for pool instances

prodOrgstringOptional

Production org username (for dynamic sandbox generation)

redirectbooleanOptional

Redirect to frontdoor URL (default true)

Responses

403

Forbidden - Requires role: member, application

get

/sfp/api/auth/salesforce/frontdoor

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

403

Forbidden - Requires role: member, application

No content

List registered Salesforce orgs

get

Returns a list of all registered Salesforce organizations with optional filtering.

  Filter options:
  - type: Filter by organization type (e.g., "Production", "Sandbox")
  - devhub: Filter to show only DevHub organizations
  - metadata: Filter by metadata key-value pairs using either format:
    - Comma-separated: key1=value1,key2=value2
    - JSON object: {"key1":"value1","key2":"value2"}
  
  Response includes DevHub status, default flag, and metadata for each org.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestringOptional

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

devhubbooleanOptional

Filter to show only DevHub organizations

metadatastringOptional

Filter by metadata key-value pairs. Format: key1=value1,key2=value2 or JSON object

Responses

200

List of registered organizations

application/json

usernamestringRequired

Username of the Salesforce org user

instanceUrlstringRequired

Instance URL of the Salesforce org

orgIdstringRequired

Salesforce Organization ID

Example: 00D1a000000xxxxx

organizationTypestringRequired

Type of the Salesforce org

Example: Enterprise Edition

instanceNamestringRequired

Salesforce instance name

Example: NA139

parentProductionUsernamestringOptional

Parent production org username (for JIT sandboxes)

isJitRegistrationbooleanOptional

Whether this org was registered using JIT authentication

isDevHubbooleanOptional

Whether this org is a DevHub

isDefaultbooleanOptional

Whether this is the default DevHub

metadataobjectOptional

Additional metadata stored as key-value pairs

createdAtstring · date-timeRequired

When the org was registered

403

Forbidden - Requires role: member, application

get

/sfp/api/auth/salesforce/orgs

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

[
  {
    "username": "text",
    "instanceUrl": "text",
    "orgId": "00D1a000000xxxxx",
    "organizationType": "Enterprise Edition",
    "instanceName": "NA139",
    "parentProductionUsername": "text",
    "isJitRegistration": true,
    "isDevHub": true,
    "isDefault": true,
    "metadata": {},
    "createdAt": "2026-02-24T20:05:23.572Z"
  }
]

Register or update a Salesforce org

post

Registers a new Salesforce organization or updates an existing one.

      Requirements:
      - sfdxAuthUrl is required (Generate using: sf org:display -u [email protected] --verbose --json)
      - The connection is validated before registration
      - instanceUrl is optional and will be extracted from sfdxAuthUrl if not provided
      
      Optional fields:
      - isDevHub: Mark this org as a DevHub (default: false)
      - isDefault: Mark this as the default DevHub - only one org can have this set (default: false)
      - metadata: Additional metadata as key-value pairs in JSON format
      
      If an org with the same username exists, it will be updated.
      
      For sandbox registrations without sfdxAuthUrl, use /auth/salesforce/register-sandbox-by-name instead.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

instanceUrlstringOptional

Instance URL of the Salesforce org (will be extracted from sfdxAuthUrl if not provided)

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

usernamestringRequired

Username of the Salesforce integration user

Example: [email protected]

sfdxAuthUrlstringRequired

SFDX Auth URL (generated using sf org:display -u [email protected] --verbose --json)

Example: force://CLIENT_ID:CLIENT_SECRET:[email protected]

isDevHubbooleanOptional

Whether this org is a DevHub

Default: false

isDefaultbooleanOptional

Whether this is the default DevHub (only one org can have this set to true)

Default: false

metadataobjectOptional

Additional metadata stored as key-value pairs

Example: {"environment":"production","region":"us-west"}

skipValidationbooleanOptional

Skip connection validation (for testing purposes only)

Default: false

Responses

201

Organization successfully registered/updated

application/json

400

Invalid input or connection failed

403

Forbidden - Requires role: owner

post

/sfp/api/auth/salesforce/register

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

{
  "instanceUrl": "https://mycompany.my.salesforce.com",
  "username": "[email protected]",
  "sfdxAuthUrl": "force://CLIENT_ID:CLIENT_SECRET:[email protected]",
  "isDevHub": false,
  "isDefault": false,
  "metadata": {
    "environment": "production",
    "region": "us-west"
  },
  "skipValidation": false
}

{
  "username": "text",
  "instanceUrl": "text",
  "orgId": "00D1a000000xxxxx",
  "organizationType": "Enterprise Edition",
  "instanceName": "NA139",
  "parentProductionUsername": "text",
  "isJitRegistration": true,
  "isDevHub": true,
  "isDefault": true,
  "metadata": {}
}

Test connection to a REGISTERED Salesforce org

post

Tests if the stored credentials for a registered org are still valid.

    **Note**: This endpoint only works for orgs that are registered in the system.
    It validates that the stored sfdxAuthUrl can still be used to authenticate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

isValidbooleanRequired

Whether the connection is valid

usernamestringRequired

Username tested

orgIdstringOptional

Organization ID if connection successful

organizationTypestringOptional

Organization type if connection successful

instanceNamestringOptional

Instance name if connection successful

errorstringOptional

Error message if connection failed

403

Forbidden - Requires role: owner, application

404

Organization not found

post

/sfp/api/auth/salesforce/test-connection

POST /sfp/api/auth/salesforce/test-connection?username=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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 can request authentication credentials.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

usernamestringRequired

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

authTypestring · enumOptional

Type of authentication to return: "accessToken" (short-lived, default) or "sfdxAuthUrl" (long-lived refresh token for long-running operations)

Possible values:

Responses

200

Organization details

application/json

usernamestringRequired

Username of the Salesforce org user

instanceUrlstringRequired

Instance URL of the Salesforce org

orgIdstringRequired

Salesforce Organization ID

Example: 00D1a000000xxxxx

organizationTypestringRequired

Type of the Salesforce org

Example: Enterprise Edition

instanceNamestringRequired

Salesforce instance name

Example: NA139

parentProductionUsernamestringOptional

Parent production org username (for JIT sandboxes)

isJitRegistrationbooleanOptional

Whether this org was registered using JIT authentication

isDevHubbooleanOptional

Whether this org is a DevHub

isDefaultbooleanOptional

Whether this is the default DevHub

metadataobjectOptional

Additional metadata stored as key-value pairs

createdAtstring · date-timeRequired

When the org was registered

403

Forbidden - Requires role: member, application

404

Organization not found

get

/sfp/api/auth/salesforce/org

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

{
  "username": "text",
  "instanceUrl": "text",
  "orgId": "00D1a000000xxxxx",
  "organizationType": "Enterprise Edition",
  "instanceName": "NA139",
  "parentProductionUsername": "text",
  "isJitRegistration": true,
  "isDevHub": true,
  "isDefault": true,
  "metadata": {},
  "createdAt": "2026-02-24T20:05:23.572Z"
}

Last updated 9 months ago

Good evening

hashtagDelete a Salesforce org registration

hashtagGet Salesforce org frontdoor URL

hashtagList registered Salesforce orgs

hashtagRegister or update a Salesforce org

hashtagTest connection to a REGISTERED Salesforce org

hashtagGet details of a specific Salesforce org

Delete a Salesforce org registration

Get Salesforce org frontdoor URL

List registered Salesforce orgs

Register or update a Salesforce org

Test connection to a REGISTERED Salesforce org

Get details of a specific Salesforce org