Listing groups

GET /v3/groups

List groups. To list groups in a specific domain, filter the response by domain ID.

Source: https://docs.openstack.org/api-ref/identity/v3/index.html?expanded=list-groups-detail#list-groups

Request

Parameters

Name	In	Type	Description
domain_id (Optional)	query	string	Filters the response by a domain ID.
name (Optional)	query	string	Filters the response by a group name.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:5000/v3/groups?domain_id=f2eeaaf15c254d4fa10255796122c8ec

Response

Parameters

Name	In	Type	Description
groups	body	array	A list of group objects.
domain_id	body	string	The ID of the domain of the group.
id	body	string	The group ID.
links	body	object	The link to the group resource.
links	body	object	The link to the collection of resources.
name	body	string	The name of the group.

Status codes

Success

Code	Reason
200 - OK	Request was successful.

Example

{
  "groups": [
    {
      "description": "Domain administrators",
      "domain_id": "f2eeaaf15c254d4fa10255796122c8ec",
      "id": "c0d675eac29945ad9dfd08aa1bb75751",
      "links": {
        "self": "https://<node_IP_addr>:5000/v3/groups/c0d675eac29945ad9dfd08aa1bb75751"
      },
      "name": "domain_admins"
    }
  ],
  "links": {
    "next": null,
    "self": "https://<node_IP_addr>:5000/v3/groups?domain_id=f2eeaaf15c254d4fa10255796122c8ec",
    "previous": null
  }
}