Documentation Documentation

Create User Groups

Introduction

Instead of setting permissions per user, you can create a group, and assign it to one or more users.

You can use User Groups to help with Role Based Access Control (RBAC) for your users. For example, if you only want certain users to access the Tyk Logs, you can create a Logs User Group, then give those users the Logs Read permission and add them to your Logs User Group. See User Roles for assigning permissions to users.

This also works for Single Sign On (SSO) as well, you can specify the group ID when setting up SSO.

This feature is available to all our Cloud and Multi-Cloud users. For On-Premises installations, this feature is available for customers with an “Unlimited” license.

In order to manage user groups, ensure that you have either “admin” or “user groups” permission for your user, which can be enabled by your admin.

NOTE: A user can only belong to one group.

Create a User Group with the Dashboard

Step 1: Select “User Groups” from the “System Management” section

User group menu location

Step 2: Click “ADD NEW USER GROUP”

Add user group location

Step 3: Add User Group Name

Enter the name for your User Group, and an optional Description.

Add name

Step 4: Click “Save” to create the Group

Click Save

Step 5: Add Users to your Group

  1. From the Users menu, select Edit from the Actions drop-down list for a user to add to the group.
  2. Select your group from the User group drop-down list.

select user group

Click Update to save the User details

update user

Managing User Groups with the Dashboard API

You can also manage User Groups via our Dashboard API. The following functions are available:

  • List all User Groups
  • Get a User Group via the User Group ID
  • Add a User Group
  • Update a User Group
  • Delete a User Group

See Dashboard API User Groups for more details.