---
title: "POST /list-group"
method: POST
path: "/list-group"
tags: ["Groups"]
---

# POST /list-group

`POST /list-group`

## Request

- Base URL: `https://api.akeyless.io`
- URL: `https://api.akeyless.io/list-group`
- Auth: none declared

## Request body

- ListGroups
  - `filter` string: Filter by auth method name or part of it
  - `json` boolean: Set output format to JSON
  - `pagination-token` string: Next page reference
  - `token` string: Authentication token (see `/auth` and `/configure`)
  - `uid-token` string: The universal identity token, Required only for universal_identity authentication

## Response `200`

listGroupsResponse wraps response body.

- ListGroupsOutput
  - `groups` Group[]
    - `account_id` string
    - `creation_date` string, date-time
    - `description` string
    - `granted_roles` GrantedRole[]: GrantedRoles are the roles a member of this group gets at login, through the group's akeyless_groups claim. Read-only, and filled only for the SCIM bearer that owns the group: a group name on its own says nothing about the access it carries, which is what a reviewer certifying the entitlement has to judge.
      - `conditional` boolean: Conditional is set when the role association also needs something besides this group: another claim, or membership in another group (" AND ").
      - `name` string
    - `granted_roles_known` boolean: GrantedRolesKnown is set when GrantedRoles was computed, so an empty list means "grants no role" rather than "not computed" (another caller, or an older UAM).
    - `group_alias` string
    - `group_id` string
    - `group_name` string
    - `is_subclaims_with_operator` boolean
    - `modification_date` string, date-time
    - `scim_external_id` string
    - `scim_managed` boolean
    - `scim_provisioned_access_id` string
    - `user_assignments` AccessPermissionAssignment[]
      - `access_id` string
      - `access_type` string
      - `sub_claims` object
    - `version` string: Version identifies the member assignments this group was read with. Pass it back as UpdateGroupInput.ExpectedVersion to make the update conditional.
  - `next_page` string

## Other responses

- `default`: errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.dev/akeyless/apis/identity-access.md) - [All operations](https://skmtc.dev/akeyless/apis/identity-access/llms.txt) - [OpenAPI document](https://skmtc.dev/akeyless/apis/identity-access/revisions/6fbc3858ec88?raw)