List groups

Retrieves a list of groups the asking principal a member of. Principals with groups:list capability can optionally ask for all groups in a project.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
all
boolean
Default: false

Whether to get all groups, only available with the groups:list acl.

Responses
200

A list of groups.

get/groups
Request samples
my_groups = client.iam.groups.list()

all_groups = client.iam.groups.list(all=True)
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}