Retrieve Clients

Retrieve/Get all tenant clients.

GET/tenants/{tenantId}/clients

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Retrieve Clients action (under Auth Admin).
Fill in the fields below, then reference the result from later steps as {{retrieveClients.response.data}}.

Request

Path parameters

tenantIdstringrequired

Response

Returns 200 with an object. Read it in later steps with {{retrieveClients.response.data.<field>}}.

dataarray<object>

An array of clients.

clientIdstringrequired

Client ID

namestringrequired

Client Name

secretstringrequired

Client Secret. The secret will only display on create and if the secret was updated when updating the client.

scopesarray<string>required

Merchant scopes. These scopes allows different permissions in SLAS and B2C commerce. Shopper Custom Objects additionally provides a way to do granular scoping besides the standard `sfcc.shopper-custom-objects` like `sfcc.shopper-custom-objects.xyz` SLAS is capable of handling a maximum of 20 Custom Object scopes. For B2C Commerce scope details, see the [Authorization Scopes Catalog](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)."

redirectUristringrequired

An absolute URL, beginning with a protocol

callbackUristringrequired

An absolute URL, beginning with a protocol

channelsarray<string>required

Client Channels

isPrivateClientboolean

Private or Public Client

loginEpRestrictboolean

When enabling (true) this will restrict all calls to the `\login` endpoint for the Client Id. When calling the `\login` endpoint and `loginEpRestrict` is enabled a HTTP Status code of 403 will be returned.

isSixDigitOtpboolean

If this attribute is set to true in the request for the clientId, a 6-digit OTP is generated during PasswordlessLogin, PasswordReset, and WebAuthn Authorization. If set to false or unspecified, an 8-digit OTP is generated by default for the aforementioned calls.

strictClientAuthboolean

When enabled, requests from this client to `/oauth2/login` and `/oauth2/authorize` are rejected with a 401 if the `x-slas-client-auth` header is missing. The `strictClientAuth` attribute applies only to private clients. The 'x-slas-client-auth' header is a Base64-encoded string of client credentials. The string is composed of a client ID and client secret, separated by a colon (`:`). For example, `clientId:clientSecret`. Don't add the string `"Basic"`.

json

{
  "data": [
    {
      "clientId": "fd0d4ab9-bb85-4c04-bebd-589bd74bdd75",
      "name": "Client Name",
      "secret": "client-secret",
      "scopes": [
        "sfcc.products",
        "sfcc.catalogs",
        "sfcc.customers:ro"
      ],
      "redirectUri": "https://www.salesforce.com",
      "callbackUri": "https://www.salesforce.com",
      "channels": [
        "RefArch",
        "SiteGenensis"
      ],
      "isPrivateClient": true,
      "loginEpRestrict": false,
      "isSixDigitOtp": false,
      "strictClientAuth": false
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?