Trusted Agent Authorization

Trusted Agent on Behalf (TAOB) authorization allows an agent to perform actions on behalf of a registered or guest shopper.

By default, shopper tracking preferences are disabled for all TAOB flows, which means that dnt is set to true. This differs from other SLAS token requests, in which dnt is set to false.

Note

Configure Trusted Agent Authorization

Configure Business Manager permissions:

In Business Manager, configure the following functional permissions for one or more agents in your organization: Login_On_Behalf and Create_Order_On_Behalf.
For detailed instructions, see the Business Manager Functional Permissions article in the B2C Commerce documentation.

Configure SLAS:

Create a dedicated public client ID to use in the OAuth auth_code PKCE flow. For details, see Public SLAS Client Use Cases.
Add the sfcc.ta_ext_on_behalf_of scope to your SLAS client.
Set a redirect URI.

Perform the steps for registered and guest shoppers in the following sections, as applicable.
To initialize an Agentforce session, obtain a SLAS shopper access token that includes the sfcc.shopper-agents.rw scope, and then call the Shopper Agents API with the sessionInitKey received at session start.

This flow requires agents to authenticate with Account Manager, including agents that sign in through a third-party identity provider that’s federated with Account Manager.

Note

Specify TAOB Parameters for Guest Shoppers

Make sure you use the public client ID created when configuring SLAS.

Note

Set login_id to guest.
Set idp_origin to slas. This is standard for SLAS Guest requests. If any other idp_origin value is used, SLAS returns a bad request.
If the trusted agent needs access to the existing basket of a guest shopper (viewing or updating), you must pass the same USID that was included in the shopper token.
You must pass the state parameter in the TAOB guest Token request to get the TAOB access_token to transfer the state from the authorization call to the token call. The state parameter value is returned with the authorization code in the response url from the TAOB guest authorization call, for example: .../taob/callback?code=HETXpvg5LKBNIHjDTWkRrf2MLVU&state=taob.gst.7bc7fb7f-e646-44fd-bc73-dfd5c3c9019b

SLAS trusted agent authentication for guest users

Example: TAOB Authorization Request for a Guest Shopper

1curl 'https://$CODE.api.commercecloud.salesforce.com/shopper/auth/v1/organization/$ORG/oauth2/trusted-agent/authorize'
2\--get
3\--data "client_id=$CLIENT"
4\--data "channel_id=$SITE"
5\--data "redirect_uri=$REDIRECT"
6\--data 'response_type=code'
7\--data 'idp_origin=slas'
8\--data-urlencode "login_id=guest"
9\--data "code_challenge=$CHALLENGE'

Example: TAOB Token Request for a Guest Shopper

In the authorization header, use the value from the code query parameter that was returned when the agent authenticated with Account Manager:

1curl 'https://$CODE.api.commercecloud.salesforce.com/shopper/auth/v1/organization/$ORG/oauth2/trusted-agent/token' \
2--header 'Authorization: Bearer jpsM6DNwzFtrUIZJDwyRihkRX1g' \
3--data "client_id=$CLIENT" \
4--data "channel_id=$SITE" \
5--data 'grant_type=client_credentials' \
6--data 'idp_origin=slas' \
7--data-urlencode 'login_id=guest' \
8--data-urlencode 'agent_id=example@yourdomain.com' \
9--data-urlencode 'channel_id=SiteGenesis' \
10--data 'code_verifier=`$VERIFIER' \
11--data 'state=taobgst.3ebdcbb6-ef87-4f41-8173-67728636e513'

Specify TAOB Parameters for Registered Shoppers

Make sure you use the public client ID created when configuring SLAS.

Note

Set login_id to the shopper’s credentials.
Set idp_origin to ecom.

Consider the following scenario where trusted agent authorization is used to help a registered shopper:

Lauren is a call center agent who helps shoppers with their orders.
Tim is a shopper who contacts the call center. He wants to update the quantity of shirts in his order but is having difficulty doing it himself.
Using the SLAS TAOB flow, Lauren gains access to Tim’s account, which gives her access to the items added to the cart.
Lauren successfully updates the quantity of shirts in Tim’s order.
Tim is pleased with the Lauren’s help and completes his order.

This diagram shows the typical API requests and responses used in the trusted agent authorization flow for a registered shopper:

SLAS trusted agent authentication and authorization process

Example: TAOB Authorization Request for a Registered Shopper

The following commands demonstrate how to authorize a trusted agent using a public client.

When running the sample code provided, don’t forget to replace the placeholder values with actual values.

Important

Start by requesting an authorization code for a trusted agent using getTrustedAgentAuthorizationToken:

1curl "https://$CODE.api.commercecloud.salesforce.com/shopper/auth/v1/organization/$ORG/oauth2/trusted-agent/authorize" \
2--get \
3--data "client_id=$CLIENT" \
4--data "channel_id=$SITE" \
5--data "redirect_uri=$REDIRECT" \
6--data 'response_type=code' \
7--data 'idp_origin=ecom' \
8--data-urlencode "login_id=jack.shopper" \
9--data-urlencode 'agent_id=example@yourdomain.com' \
10--data-urlencode 'channel_id=SiteGenesis' \
11--data "code_challenge=$CHALLENGE"

The request redirects you to Account Manager for authentication. After a successful login, you are redirected to the address provided in the redirect_uri parameter of the previous request. When redirecting, the authorization code is included in the code query parameter.

Now request a trusted agent token using getTrustedAgentAccessToken. In the authorization header, use the value from the code query parameter that was returned when the agent authenticated with Account Manager:

1curl "https://$CODE.api.commercecloud.salesforce.com/shopper/auth/v1/organization/$ORG/oauth2/trusted-agent/token" \
2--header 'Authorization: Bearer jpsM6DNwzFtrUIZJDwyRihkRX1g' \
3--data "client_id=$CLIENT" \
4--data "channel_id=$SITE" \
5--data 'grant_type=client_credentials' \
6--data 'idp_origin=ecom' \
7--data-urlencode 'login_id=jack.shopper' \
8--data "code_verifier=$VERIFIER"

Trusted agent tokens expire after 15 minutes and are not refreshable. To get a new token, restart the authorization flow.

Note

Troubleshoot

If you receive the following response code, verify the SLAS configuration and Business Manager permissions:
1{ 2"status_code": "403 FORBIDDEN", 3"message": "AM SSO Unauthorized!" 4}
The following response code indicates that the agent_id and the login_id are the same, which is not allowed:
1{ 2 "status_code": "403 FORBIDDEN", 3 "message": "Agent Id - AM SSO Unauthorized!" 4}