/auth/v1/groups/groups_summary: GET

Gets the list of groups and their domain details.

The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ ✓1 ✓ ✓ ✓1
1 The specified user ID must be the same as the requesting user ID. Otherwise the command fails with error 403, "Not authorized".

Data users can access this API to retrieve details only for the groups to which they belong.

Synopsis of the request URL

curl -k -H ‘Authorization: Bearer <token>’ https://<spectrum_discover_host>/auth/v1/groups/groups_summary

Supported request types and response formats

Supported request types:
  • GET
Supported response formats:
  • JSON

Examples

The following example shows how to get the domain names to which the group is associated.

Request: 
curl -k -H ‘Authorization: Bearer <token>’ https://<spectrum_discover_host>/auth/v1/groups/groups_summary

Response:

(200 OK): 
{
	"groups": [
		{
			"description": "",
			"domain_id": "default",
			"domain_name": "Default",
			"id": "86f7a42ea54d4659bb60fc6d5c620f2d",
			"name": "bugfix5"
		},
		{
			"domain_id": "a69001e854174dc1a4e0c98f712744bb",
			"domain_name": "lldap",
		        "id": "d3b1ae0d1b5efb0c064797bf8239165cce32aaf3c057151279198a780bc8cf0b",
			"name": "Sales"
		},
		{
			"domain_id": "a69001e854174dc1a4e0c98f712744bb",
			"domain_name": "lldap",
		        "id": "18326a0d724b4ffaa26a228fc88b6852198a1d10a3a51bc732632afe4d112dc9",
			"name": "HumanResources"
		}
	]
}