Use Case: Create a User Access Template

Owned by Miles Graves
Feb 09, 2024
3 min read

You can create Access templates to group settings automatically to determine users' roles and capabilities in the Portal. By creating an access template, you can apply the template and its customized array of resource settings to any user that is added to your account in the future. This tutorial will walk you through the steps for creating a new access template and customizing its settings.

Partial view of the Access Templates page.

Objective

Create a new access template and customize its settings.

Audience

  • Facilitators

  • Referrers

  • Merchants

Environment

  • Portal (Sandbox)

  • Portal (Production)

Prerequisites

Prerequisites:

You must have a fully boarded account to perform any of the actions described in this use case guide.

Warnings

Warnings will provide insight or advice to avoid risk, visibility, and overall product performance issues during this use case.

Warning: When creating a new Access Template, all Role Resources and subresources are also selected by default. You will need to modify them and disable them individually to prevent access.

Tips

Tips will provide suggestions to streamline or better prepare you to apply this use case tutorial.

Additional Resources

See the following references to help you get started:

Create a User Access Template

1. Navigate to the Access Templates Page

  • Step 1: Click the PLUS icon next to Users in the left-hand navigation panel to open a drop-down menu.

  • Step 2: Click ACCESS TEMPLATES in the Users drop-down menu to open the Access Templates page.

2. Create a New Access Template

  • Step 1: Click the ADD ACCESS TEMPLATE button in the upper right-hand corner of the page to open the Add Access Template lightbox on the page.

  • Step 2: Select the relevant primary role, then click Next.

  • Step 3: Enter a name and description and click Next.

3. Enable Your Custom Template Resources

  • Step 1: Under Review & Customize Access, review each Resource category on the left-hand side to enable, disable, or modify any primary Role Resources or applicable Role Subresources.

  • Step 2: Click the arrow next to a listed resource to reveal the Detailed Permissions section.

    • Detailed Permissions offers the following Role Resource operations: Create, Full view, Summary view, Update, and Delete to modify the capabilities the Access Template will provide its users for this Role Resource.

  • Step 3 (Optional): To view or modify a complete list of all applied Role Resources by user operation capabilities (as shown in Detailed Permissions), click the Advanced Options button in the upper right-hand corner of the page.

4. Enable Custom API Roles (Optional)

  • Step 1: Click the Advanced Options button in the upper right-hand corner of the page to reveal the Advance Options lightbox, then toggle on the Custom API Roles switch in the upper right.

  • Step 2: Click the Select API Roles from the drop-down menu that appears at the top of the lightbox to view a toggle list of all available Custom API roles.

  • Step 3 (Optional): To remove any API roles that you have added to the Template Resource section, uncheck the box next to the name of the API role.

5. Save Your New Template

When you have completed enabling or disabling the resources, click SAVE in the upper right-hand corner of the page.

Result: Your new access template will appear in the table on the Access Templates page.

Next Steps

Once the new access template is successfully created, review the following use case guides for additional information on related topics:

  • Add New Users: Add users and quickly customize their roles with your saved access template. See the Add New Users use case.

  • Create a Team: Create a team and apply your access template to the team settings with the Create a Team use case.

Conclusion

The new access template is now active and you can assign it to users associated with your account.

References

Click the links or items below to access any of the following pages: