Groups
To allow user access to your system, you need to add groups to your system. These groups are defined on your organization's identity providers. After you've added a group to your system, you can specify what roles its members have and what index collections they can access.
Adding groups
You use the REST API, Admin App, or CLI to add groups from your identity providers to your system. This lets you associate index collections and roles with those groups, thereby granting group members access to your system.
Procedure
Click the Configuration window.
Click Security.
On the Groups tab, click Create.
Select an identity provider and type a string on which to query the identity provider for groups.
Click Discover Groups.
Click Continue.
Select one or more roles to associate with the group.
Click Create.
Related CLI commands
createGroup
Related REST API methods
POST /security/groups
You can get help on specific REST API methods for the Admin App at REST API - Admin.
Viewing groups
You use the REST API, CLI, or Admin App to view all the groups that have been created for your system.
Procedure
Select the Configuration window.
Click Security.
Select the Groups tab.
Related CLI commands
getGroup
listGroups
Related REST API methods
GET /security/groups/{uuid}
GET /security/groups
You can get help on specific REST API methods for the Admin App at REST API - Admin.
Assigning roles to groups
You use the REST API, Admin App, and CLI to assign roles to the groups that you've added your system.
Procedure
Select the Configuration window.
Click Security.
On the Groups tab, select the group you want to edit.
On the Roles tab, select one or more roles to enable for the group.
Click Update.
Related CLI commands
editGroup
Related REST API methods
GET /security/roles/{uuid}
GET /security/roles
You can get help on specific REST API methods for the Admin App at REST API - Admin.
Deleting groups
When you delete a group, all users in the group lose access to your system.
Procedure
Select the Configuration window.
Click Security.
Select the Groups tab.
Click the delete icon (
) for the group you want to remove.
Related CLI commands
deleteGroup
Related REST API methods
DELETE /security/groups/{uuid}
You can get help on specific REST API methods for the Admin App at REST API - Admin.