Create an SSO External Client App with Connect API

Use this Connect API to create a replacement SSO External Client App (ECA) in a sandbox org during a Salesforce Voice sandbox refresh.

This API is available only in sandbox orgs, in API version 68.0 and later. Use this procedure only if your contact center uses an ECA for single sign-on.

Before you begin, get the contact center API name, Amazon Connect instance alias, and AWS account ID from the CallCenter metadata you saved before the refresh.

URI

https://{MyDomain}.my.salesforce.com/services/data/v68.0/connect/voice/scv-external-client-app

HTTP Method

POST

Request Fields

Field	Type	Description	Required
`contactCenterApiName`	string	API name of the contact center. Obtain it from the CallCenter metadata. Maximum 20 characters, must begin with a letter, alphanumeric only, and can’t begin with the reserved prefixes `aws` or `ssm`.	Yes
`connectInstanceAlias`	string	Alias of the Amazon Connect instance. Must match the Amazon Connect instance alias. Obtain it from the CallCenter metadata.	Yes
`awsAccountId`	string	Twelve-digit AWS account ID. Must contain exactly 12 digits. Obtain it from the CallCenter metadata.	Yes

Example

Request:

1POST /services/data/v68.0/connect/voice/scv-external-client-app
2{
3  "contactCenterApiName": "MyCC",
4  "connectInstanceAlias": "my-connect-instance",
5  "awsAccountId": "123456789012"
6}

Response:

1{
2  "appId": "0oa1234567890abcdef",
3  "identityUrl": "https://login.salesforce.com/idp/login?app=0oa1234567890abcdef"
4}

The API creates only the SSO External Client App. It doesn’t create the REST API OAuth External Client App, and appId doesn’t map to reqRestApiConnectedAppId. Create the REST API OAuth External Client App separately, as described in Refresh a Sandbox.

Note

Copy the returned values into the CallCenter metadata you saved before the refresh:

Replace the value of reqConnectedAppId with the returned appId.
Replace the value of reqIdentityUrl with the returned identityUrl.

Errors

HTTP status	Error code	Suggested action
400	`INVALID_INPUT`	Verify that all three fields are present and meet their format requirements.
412	`INVALID_OPERATION`	Enable Identity Provider in the sandbox and retry.
503	`API_CURRENTLY_DISABLED`	Retry later or contact Salesforce Support if the issue persists.
500	`INTERNAL_SERVER_ERROR`	Retry the request. If the issue persists, contact Salesforce Support.