ATataccama
Groups

List groups

List the groups in the group hierarchy.

get/iam/v1/groups

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of groups to return per page.

parentUrnstring

A URN identifying a Group resource in the IAM API, or the literal "null", which matches groups that have no parent. The literal is needed because omitting the value means "do not filter by parent" rather than "parent is null".

Format: urn:ata:{tenant}:iam:group:{uuid}

Example values:

  • null
  • urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000
Example:urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000

Filter groups by their parent group, listing only its direct subgroups. Pass the literal null to list only the root group, which has no parent. When omitted, groups are not filtered by parent.

namestring
Example:Data Governance

Filters results by exact match on the group name.

sortstring[]

Comma-separated field names for sorting results, where fields prefixed with - sort descending. Only name is supported.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name — sort by name descending
[
  "-name"
]

Response

Paginated list of groups.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:iam:group:8e1f3a5c-9b2d-4c7e-a6f0-1d2e3c4b5a69",
      "parentUrn": "urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000",
      "name": "Data Governance",
      "description": "Group responsible for data governance across the organization."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.