KEkeycardai
Groups

List group role assignments by scope

Changed on

Returns the group's role assignments keyed by the scopes named in the request: one group per scope_id[] value (empty when the group holds nothing on it) plus, with unscoped=true, the group of assignments applying to the zone itself. Not paginated — the response has exactly as many groups as the request named, so a known set of up to 100 targets always resolves in one request. Use GET …/roles to enumerate everything the group holds.

get/zones/{zoneId}/groups/{groupId}/role-assignments

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/groups/{groupId}/role-assignments
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

groupIdstring required

Group ID

Query parameters

scope_typestring

The kind of resource the requested scope_id[] values name; echoed as each group's scope_type. Defaults to zone, the only scope type a grant can carry today.

scope_id[]string[]

Scope IDs (of scope_type) to answer for. Repeatable, max 100; each yields exactly one group, empty when the principal holds nothing on it. Unknown IDs yield an empty group.

unscopedboolean

true adds the unscoped group (grants applying to the zone itself, e.g. an org role) as the first item.

Response

Role assignments keyed by requested scope. Not paginated: the number of groups equals the number of scopes named in the request.

Changes