Reference
What you will see on Groups page
You can access to Groups main page by:
- Sign in to Monokee console
- Open the Menu on the left side and click on "Groups"
On the main groups page, you have access to a list of all the groups within your domain. For each groups, you can view their name, description and how many users and applications belong to that specific group.
Add a new group
Creating a new group is easy. Just follow these steps:
- Click on the Groups option in the left-hand side menu (if you're not already on the group page).
- Click on the Add button.
- Type a Name and a Description for the new group and click on Add.
These steps create an empty group. In Group details page you will can add users and applications, as well as group attributes and scopes.
Filter groups
You can filter the list of groups by using the dedicated filter section. The two parameters you can use to filter are:
- Search by: this is a select box that allows you to select the attribute you want to filter by using a specific value.
- Value: this is the value you want to filter by.
Group details page
When you click on a group table row, you'll be able to access its details. It provides a view of the group information, activities, and assets.
- the group summary section provides a summary of the group properties, including unique identifier and description.
- the group activities section provides information about the group activities. Any activity related to the group will be reported here, along with a comment, the IP address of the user (or service) that caused the operation, and the date.
- the group assets section contains information about all resources associated to it. It includes information such as the applications and users belonging to the group, the associated attributes and the scopes that the group has for OAuth/OpenID applications.
Group summary
In addition to the basic information provided, the section allows you to perform more complex operations.
These operations include: change group name and/or description and delete the group.
Please, pay attention! If you delete a group, you also removes all user and application associations, attribute and scope values that belongs to the group.
Group activities
This provides a complete overview of use of the group within the domain. Analysing this data allows us to obtain valuable information, such as whether an application, attribute or scope association is propagated to all users in the group.
Group Assets
In this section, we present the various resources that are linked to the group. These resources are integral to the group operations and can include users, applications, attributes and scopes.
How to associate users
As we mentioned earlier, the main purpose of a group is to manage common properties for the users included in the group. So it's important that you can add and remove them easily.
To add a new user, select the Users tab and click on the ASSOCIATE button. You'll see a popup where you have to select at least one user to proceed with the insertion, and you'll see the user added under the Users tab inside the group users list.
How to remove users
To remove a user from the group, click on the trashcan icon on the users table row. Then confirm the operation by clicking on the DELETE button inside the popup.
How to associate applications
Select the "Applications" tab to see which applications are associated to the group.
To add a new application, click on the ASSOCIATE button, and a popup like the one for the users tab will appear. Now you must select at least one application to proceed with the addition. If the association was made correctly, the users inside the group should see the application in their Application Broker page.
How to remove applications
To remove an application, click on the trashcan icon on the applications table row. Then confirm the operation by clicking on the DELETE button inside the popup.
How to associate attributes
In each group, it's possible to assign attributes and relative value to users in the group. This feature is useful when you want to add a default attribute value to all users inside the group.
Please note that this attribute doesn't override the user's one. If the user already has that attribute set to another value, the user values have greater weight.
To add a new attribute, click on the ASSOCIATE button, then select the attribute and type its possible values.
How to remove or edit attributes
To remove an attribute, click on the trashcan icon on the attributes table row. Then confirm the operation by clicking on the DELETE button inside the popup.
Also, you can edit it without deleting and reinserting the attribute itself. To edit an attribute, you have to click the pencil icon button in the attribute table row.
How to associate scopes
The group scopes represent the permissions users have in a particular application of type OAuth/OpenID. These permissions allow you to configure the scopes that the users have.
Click on the ASSOCIATE button on "Scopes" tab, then select the applications and the scopes you want to associate.
How to remove or edit scopes
To remove a scope from the group, click on the trashcan icon on the scopes table row. Then confirm the operation by clicking on the DELETE button inside the popup.
To edit an scope, you have to click the pencil icon button in the scopes table row.