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. Once you've added a group to your system, you can specify what roles its members have and what index collections they can access.
For information on:
•Adding identity providers to your system, see Adding identity providers.
•Roles, see Roles.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Adding groups to system
You use the REST API, Administration 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.
|
Note: After you create a group, you need to associate it with one or more index collections. For information, see Editing groups. |
Administration App instructions
1.Click on System Configuration.
2.Click on the Security .
3.On the Groups tab, click on the Add Group button.
4.Select an identity provider and type a string on which to query the identity provider for groups.
5.Click on the Discover Groups button.
6.Click on the Select button for a group you want to add.
7.Select one or more roles to associate with the group.
8.Click on the Create Group button.
Related REST API method(s)
POST /security/groups
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Viewing groups
You use the REST API, CLI, or Administration App to view all the groups that have been created for your system.
Administration App instructions
1.Click on System Configuration.
2.Click on the Security .
3.Click on the Groups tab.
Related CLI command(s)
getGroup
listGroups
For information on running CLI commands, see CLI reference.
Related REST API method(s)
GET /security/groups/{uuid}
GET /security/groups
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Editing groups
You use the REST API, Administration App, and CLI to edit the groups that you've added your system.
You can change the roles, index collections, and query settings that a group is associated with. Respectively, these options allow you to configure what permissions group members have, which indexes they can search, and what search features are available to them when they search an index.
Administration App instructions
1.Click on System Configuration.
2.Click on the Security .
3.On the Groups tab, click on the group you want to edit.
4.On the Indexes tab:
oTo add a new index collection:
a.Click on the Add Index button.
b.Select an index collection and query setting to associate the group with.
c.Click on the plus sign icon ().
oTo change the query settings that the group is associated with, click on the edit icon (). Then select a different set of query settings from the Query Setting menu.
5.On the Roles tab, select one or more roles to enable for the group.
6.Click on the Update button.
Related REST API method(s)
PUT /security/groups/{uuid}
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Deleting groups
When you delete a group, all users in the group lose access to your system.
Administration App instructions
1.Click on System Configuration.
2.Click on the Security .
3.Click on the Groups tab.
4.Click on the delete icon () for the group you want to remove.
Related REST API method(s)
DELETE /security/groups/{uuid}
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.