Setting Up a Guest User

By enabling guest user functionality, organizations can streamline user management and enhance security by controlling access to specific features and data. This setup ensures that guest users have the necessary permissions while maintaining the integrity of the system.

Enable the Guest User functionality using the Organization Management User Interface or the Update organizational information API with the following minimum required sample payload:
```
{  
  "GuestUserEnabled": true
}
```
Create a guest user using the User Creation User Interface or the Create a guest user API with the following payload.
```
{
  "FirstName": "{FirstName}",
  "LastName": "{LastName}",
  "Email": "{}",
  "Alias": "guest",
}
```
Note:
The guest user role and permission group are automatically added for the guest user. Administrators can update the GuestUserPermissionGroup to allow or amend permission for any custom object.
Update the environment.ts > userId parameter with the guest user ID created in the first step and the loginEndpoint parameter with the authentication endpoint for the Guest User functionality.

Create a configuration using the Add a configuration API with the following minimum required sample payload to whitelist the APIs that are not part of the out-of-the-box template and that you want to utilize with the guest user functionality:

Note:

You must pass the exact configuration category and configuration name that are available in the following payload.
The syntax pattern must be the same that is available in the following payload. For example, \"Route\":\"{endpoint}\",\"Method\":\"{API method that you want to allow}\"

{
    "Category": "guestuser",
    "Name": "allowedroutes",
    "Value": "[{\"Route\":\"/api/cart/v1/carts/graphql\",\"Method\":\"POST\"},{\"Route\":\"/api/catalog/v1/products\",\"Method\":\"GET\"},{\"Route\":\"/api/revenue-admin/v1/storefronts/active\",\"Method\":\"GET\"},{\"Route\":\"/api/catalog/v1/price-lists/active\",\"Method\":\"GET\"},{\"Route\":\"/api/catalog/v1/search\",\"Method\":\"GET\"},{\"Route\":\"/api/catalog/v1/categories\",\"Method\":\"GET\"},{\"Route\":\"/api/revenue-admin/v1/accounts/active\",\"Method\":\"GET\"},{\"Route\":\"/api/revenue-admin/v1/flows/{flowname}/settings/{settingname}\",\"Method\":\"GET\"},{\"Route\":\"/api/catalog/v1/search\",\"Method\":\"POST\"},{\"Route\":\"/api/revenue-admin/v1/flows/{flowName}/views\",\"Method\":\"GET\"},{\"Route\":\"/api/revenue-admin/v1/flows/{flowname}/displays\",\"Method\":\"GET\"},{\"Route\":\"/api/order/v1/orders/{Id}\",\"Method\":\"GET\"}, {\"Route\":\"/api/catalog/v1/products/compare\",\"Method\":\"POST\"},{\"Route\":\"/api/catalog/v1/products/{productId}\",\"Method\":\"GET\"},{\"Route\":\"/api/quote/v1/quotes/{Id}\",\"Method\":\"GET\"},{\"Route\":\"/api/catalog/v1/products/details\",\"Method\":\"POST\"},{\"Route\":\"/api/revenue-admin/v1/incentives\",\"Method\":\"GET\"},{\"Route\":\"/api/revenue-admin/v1/constraint-rules\",\"Method\":\"GET\"},{\"Route\":\"/api/order/v1/order/{ParentId}/orderlineitems\",\"Method\":\"GET\"},{\"Route\":\"/api/cart/v1/carts/{cartId}/order\",\"Method\":\"POST\"},{\"Route\":\"/api/revenue-admin/v1/storefronts\",\"Method\":\"GET\"},{\"Route\":\"/api/cart/v1/carts/{cartId}/items\",\"Method\":\"POST\"},{\"Route\":\"/api/revenue-admin/v1/price-lists/{Id}\",\"Method\":\"GET\"},{\"Route\":\"/api/quote/v1/quotes/{Id}/accept\",\"Method\":\"POST\"},{\"Route\":\"/api/order/v1/orders\",\"Method\":\"GET\"},{\"Route\":\"/api/quote/v1/quotes/{Id}\",\"Method\":\"PATCH\"}]"
  }

Configuring Guest Session Objects:
After whitelisting the required API routes, configure the objects that the guest user can access during a guest session. This includes both out-of-the-box (OOTB) and any custom objects you want to expose.
1. Fetch the existing configuration using the Get a configuration API.
```
{
  "Category": "platform",
  "Name": "guestsessionconfig",
  "Value": "{\"Objects\":[\"productconfiguration\",\"lineitem\",\"order\",\"contact\",\"proposal\",\"orderlineitem\",\"summarygroup\",\"adjustmentlineitem\",\"orderadjustmentlineitem\",\"orderlineitemattribute\",\"claimaccess\"]}"
}
```
2. Update the configuration using the Update a configuration API by adding any additional OOTB or custom objects that the guest user should be able to access.
Provide the required object-level permissions for all objects listed in the guestsessionconfig. Refer Assigning Object Permissions topic from Advantage Platform.

The guest user can now use the application according to the permissions granted to the guest user.

You can refer to the following troubleshooting help for the guest user functionality:

Statement: Guest user redirects to the login screen.

Cause 1: The guest user is not created.
Cause 2: The guest user is created, but the guest user functionality is not enabled.
Cause 3: The guest user is created, and the guest user functionality is also enabled, but the environment.ts is not updated for the guest user parameters.

Resolution:

Refer to the above steps (1 to 3) to set up the guest user.

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Setting Up a Guest User

Footer Section

Explore