younifyd
Menu

Register Client

Create or update a client.

PUT/tenants/{tenantId}/clients/{clientId}

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Register Client action (under Auth Admin).
  3. Fill in the fields below, then reference the result from later steps as {{registerClient.response.data}}.

Request

Path parameters

clientIdstringrequired
tenantIdstringrequired

Request body

Enter the body as JSON in the step's Body field.

namestringrequired

Client Name

clientIdstringrequired

SLAS client id. Must match the query parameter.

secretstringrequired

SLAS client secret. On create if left blank then a secret will be generated.

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."

redirectUriarray<string>required

Array of SLAS redirect URLs. Include protocol and domain name in each URL. Wildcards supported.

callbackUriarray<string>

Array of SLAS callback URLs that will be used for passworless login and password reset when mode=callback. Include protocol and domain name in each URL. Wildcards are NOT supported.

channelsarray<string>required

Client Channels

isPrivateClientbooleanrequired

Private or Public Client. If left blank the client will default to private.

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
{
  "name": "High Adventure Wear",
  "clientId": "fd0d4ab9-bb85-4c04-bebd-589bd74bdd75",
  "secret": "client_secret",
  "scopes": [
    "sfcc.products",
    "sfcc.catalogs",
    "sfcc.customers:ro"
  ],
  "redirectUri": [
    "http://localhost:3000/callback",
    "https://*.example.com/callback"
  ],
  "channels": [
    "RefArch",
    "SiteGenensis"
  ],
  "isPrivateClient": true,
  "callbackUri": [
    "http://localhost:3000/password-reset-callback",
    "http://localhost:3000/passwordless-login-callback"
  ],
  "loginEpRestrict": false,
  "isSixDigitOtp": false,
  "strictClientAuth": false
}

Response

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

clientIdstring

Client ID

namestring

Client Name

secretstring

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

scopesarray<string>

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)."

redirectUristring

An absolute URL, beginning with a protocol

callbackUristring

An absolute URL, beginning with a protocol

channelsarray<string>

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
{
  "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.