> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/vault/configuring-vault/salesforce-org-setup/register-salesforce-org-client-credentials-flow.md).

# Register Salesforce ORG - Client Credentials Flow

Configure and verify a server-to-server connection between AutoRABIT Vault and Salesforce.

| **Audience:** AutoRABIT Vault administrators and Salesforce administrators responsible for Salesforce org registration and External Client App configuration. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## Overview

This guide explains how to register a Salesforce org in AutoRABIT Vault by using the Client Credentials Flow. The workflow collects the Salesforce org details, presents the External Client App requirements, validates the client credentials, and provides an API connection test after registration.

| **Responsibility boundary:** AutoRABIT Vault provides the Salesforce configuration requirements and validates the completed connection. A Salesforce administrator performs the External Client App configuration in the target Salesforce org. |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## Before You Begin

Confirm that the following access and information are available before starting the registration:

* Access to the AutoRABIT Vault Setup page and permission to register a Salesforce org.
* Salesforce administrative access to create or configure an External Client App.
* The Salesforce username that will run the integration.
* The My Domain URL for the target Salesforce org.
* The Client ID and Client Secret generated for the External Client App.

{% hint style="warning" %}
**Security:** Treat the Client Secret as confidential. Do not include it in documentation, screenshots, tickets, or unsecured communication.
{% endhint %}

## Registration Workflow

* Select the Client Credentials Flow.
* Enter the Salesforce environment details.
* Complete the External Client App configuration in Salesforce.
* Enter and verify the client credentials.
* Test the registered API connection.

## Register the Salesforce Org

{% stepper %}
{% step %}

### Start the Registration

#### Open Salesforce org management

In AutoRABIT Vault, select **Setup** from the navigation menu. On the **Salesforce Orgs List** page, select **REGISTER NEW ORG**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FxvmtYoibkCEvZj9WmJHg%2Fimage.png?alt=media&amp;token=606e0a57-8949-4479-add0-ae11c67b5fa3" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Start a new Salesforce org registration.*

#### Select the authentication method

In the **Source Org Integration** window, select **Client Credentials Flow**. Select **Next** to continue.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FMPkW8KUa0zO6uv2xNSRe%2Fimage.png?alt=media&amp;token=45bf965e-7392-4ee5-accb-b0affed65681" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Select Client Credentials Flow as the authentication method.*
{% endstep %}

{% step %}

### Enter the Environment Details

#### Select the environment type

For **Environment Type**, select **Salesforce**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FNPeN7Q279RTz4eAx0hTj%2Fimage.png?alt=media&amp;token=3b4bbc8d-f3b8-4d86-b2a7-feec53d11989" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Select Salesforce as the environment type.*

#### Select the API version

From **Salesforce API Version**, select the API version required for the connection.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F8Ud201ekyNpmQ0B1IN2m%2Fimage.png?alt=media&amp;token=c27a7c69-c477-4da5-bfb4-20dfae640a63" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Select the Salesforce API version.*

#### Complete the Salesforce org details

Enter a meaningful name in **Org Title** and the integration user in **User Name**. Select **Production** or **Sandbox**, enter the Salesforce host in **My Domain URL**, and then select **Continue**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FriOkFd1R7GqevSv5OEBN%2Fimage.png?alt=media&amp;token=a11542e6-d77f-4908-b2de-d96712d7693d" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Enter the Salesforce org and environment details.*

{% hint style="info" %}
**My Domain URL:** Enter the My Domain host for the target Salesforce org. Use the value applicable to the org being registered.
{% endhint %}
{% endstep %}

{% step %}

### Configure the External Client App in Salesforce

AutoRABIT Vault displays the Salesforce configuration requirements for the External Client App. Complete these activities in the target Salesforce org before confirming the setup in AutoRABIT Vault.

#### Review the configuration checklist

Review the initial Salesforce Admin Setup instructions displayed in AutoRABIT Vault.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F8NixCV8MLbCFxouft5s6%2Fimage.png?alt=media&amp;token=742eb544-965d-4a60-9e27-3f978490d0df" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Review the External Client App setup requirements.*

#### Configure authentication and access policies

In Salesforce, create or update the External Client App using the OAuth flow, scopes, policies, Run As user, and IP relaxation settings specified in AutoRABIT Vault.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FejsrqVv7sERqM63BZq37%2Fimage.png?alt=media&amp;token=682cfb71-2e34-4389-b9dc-0358cef1c83f" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Review the OAuth scopes and policy requirements.*

#### Copy the callback URL and confirm the scopes

Select **Copy** beside the callback URL and add the copied value to the External Client App. Add every OAuth scope listed by AutoRABIT Vault.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F9GXXfeUGSaSpH9mKpD6c%2Fimage.png?alt=media&amp;token=2ceb691f-e47a-4b41-a3d5-3752a00bc12d" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Copy the callback URL and confirm the required OAuth scopes.*

{% hint style="warning" %}
**Important:** Copy the callback URL exactly as displayed. Do not add spaces or change the protocol, domain, or path.
{% endhint %}

#### Review troubleshooting guidance

If the Salesforce configuration cannot be completed or validated, expand **Common Issues & Troubleshooting** and review the applicable guidance.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2Fe3HNn4uLcamlcdwrqKr5%2Fimage.png?alt=media&amp;token=b1f5363a-605f-4f2b-810e-06aeee58c085" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Review common configuration issues and corrective guidance.*

#### Confirm the Salesforce setup

After completing the configuration in Salesforce, select **I’ve completed the setup**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FHrZrN4e71yiT4fOUiPal%2Fimage.png?alt=media&amp;token=e7fb5698-b438-4b2a-ae87-dfd675f785f9" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Confirm that the Salesforce configuration is complete.*
{% endstep %}

{% step %}

### Enter the Client Credentials

Retrieve the Consumer Key and Consumer Secret from the configured External Client App in Salesforce. The Consumer Key is entered as the Client ID, and the Consumer Secret is entered as the Client Secret.

#### Enter the credentials

Enter the Salesforce Consumer Key in **Client ID** and the Consumer Secret in **Client Secret**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FvKqaI5cDDeg3xUjnydnw%2Fimage.png?alt=media&amp;token=44d36d10-86a3-42fd-a98d-0773e7f29392" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Enter the Client ID and Client Secret.*

#### Continue to verification

Review the entered values and select **Continue**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FNQz4fsWa6xAqhTJ16dXT%2Fimage.png?alt=media&amp;token=c1592f00-d5c4-45d2-97d4-8502469f9cdf" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Continue to the credential review step.*
{% endstep %}

{% step %}

### Review and Verify the Configuration

#### Review the registration details

On **Review & Verify**, confirm the environment details, username, My Domain URL, API version, and Consumer Key.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FwAHRKmW9GnkyPXmg81hy%2Fimage.png?alt=media&amp;token=d44bfafe-e6af-49e7-a30e-46471de8312a" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Review the Salesforce environment and credential details.*

{% hint style="info" %}
**Before proceeding:** If any value is incorrect, select **Back** and update it before verification.
{% endhint %}

#### Verify and save

Select **Verify & Save**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FmtFDyk3WWqBSRdN0bi0F%2Fimage.png?alt=media&amp;token=bc4fdf74-65c5-4937-ad64-a90e384979d9" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Start credential verification and save the org.*

#### Allow verification to complete

AutoRABIT Vault validates the supplied configuration. Do not close the registration window while verification is in progress.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FG5evGSKiuaIinbyL2Uuq%2Fimage.png?alt=media&amp;token=c36dd027-bff4-46fe-8ed2-02c1182d08ed" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Credential verification in progress.*
{% endstep %}

{% step %}

### Confirm Registration and Test the Connection

#### Confirm successful registration

When verification succeeds, AutoRABIT Vault displays **Connection Successful** and confirms that the Salesforce org has been registered.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FitbIF4vve0MFT3GWxR58%2Fimage.png?alt=media&amp;token=98d77cde-487f-4069-889c-5a2d60ba5c17" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Confirm successful Salesforce org registration.*

#### Start the API connection test

Select **Test API Connection** to verify communication with the registered Salesforce org.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FpQQH9b8PGfrSkcE7RfPJ%2Fimage.png?alt=media&amp;token=1d2fec58-cd7e-469a-b897-3d3823cc7c66" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Start the API connection test.*

#### Allow the connection test to complete

AutoRABIT Vault tests the API connection. Remain on the page until the test completes.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FzAYHoA6715iQ0N7GtSN1%2Fimage.png?alt=media&amp;token=3fd027ad-ff1a-485e-a743-74535e360dbb" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *API connection test in progress.*

#### Confirm the test result and finish

A successful test displays **Successfully connected to the Salesforce org**. Select **Finish** to close the registration flow.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FYPKehfF8NvwMFDdR2IjQ%2Fimage.png?alt=media&amp;token=7a29fa66-371e-451b-8f49-6db065fb4b71" alt=""><figcaption></figcaption></figure>

&#x20;                                                 *Confirm the successful API connection.*
{% endstep %}
{% endstepper %}

## Expected Result

The Salesforce org is registered in AutoRABIT Vault through the Client Credentials Flow. The completed registration displays a successful connection status, and the API connection test confirms communication with the registered org.

## Troubleshooting

| **Issue**                     | **Check**                                                                                               | **Recommended action**                                                                                     |
| ----------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Callback URL is rejected      | The callback URL in Salesforce does not match the value displayed in AutoRABIT Vault.                   | Copy the callback URL again and remove any added spaces or characters.                                     |
| Credential verification fails | The Client ID, Client Secret, My Domain URL, or Run As user may not match the Salesforce configuration. | Compare the values in AutoRABIT Vault with the configured External Client App and correct any differences. |
| API connection test fails     | The app policies, OAuth scopes, or Salesforce user permissions may be incomplete.                       | Expand **Common Issues & Troubleshooting** in the registration flow and validate each listed requirement.  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledgebase.autorabit.com/product-guides/vault/configuring-vault/salesforce-org-setup/register-salesforce-org-client-credentials-flow.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.