Groups

Get group

zones.groups.retrieve(, ) -> Group

GET/zones/{zoneId}/groups/{groupId}

Returns a group by ID. Pass expand[]=member_count for its member count and expand[]=roles for the identifiers of its assigned roles.

ParametersExpand Collapse

zone_id: str

group_id: str

expand: Optional[Union[Literal["member_count", "roles"], List[Literal["member_count", "roles"]]]]

Accepts one of the following:

Literal["member_count", "roles"]

Accepts one of the following:

"member_count"

"roles"

List[Literal["member_count", "roles"]]

Accepts one of the following:

"member_count"

"roles"

ReturnsExpand Collapse

class Group: …

A zone-scoped group of users, assignable to roles and usable in policies. Roles assigned to a group are inherited by its members. external is false for groups managed in Keycard and true for groups synced from an external directory.

id: str

Unique identifier of the group

created_at: datetime

Entity creation timestamp

formatdate-time

external: bool

Whether the group is synced from an external directory. When true the group is directory-owned and its membership is read-only; when false it is managed in Keycard. Read-only: set by external sync, never by the caller.

identifier: str

User-specified identifier, unique within the zone. Automatically assigned for groups from an external directory.

name: str

Human-readable group name

organization_id: str

Organization this group belongs to

updated_at: datetime

Entity update timestamp

formatdate-time

zone_id: str

Zone this group belongs to

member_count: Optional[int]

Number of users in the group. Included only when requested via expand[]=member_count (group get or list).

roles: Optional[List[str]]

Identifiers of the roles assigned to the group; members inherit them. Deduped across scopes. Included only when requested via expand[]=roles (group get or list).

Get group

import os
from keycardai_api import KeycardAPI

client = KeycardAPI(
    api_key=os.environ.get("KEYCARD_API_API_KEY"),  # This is the default and can be omitted
)
group = client.zones.groups.retrieve(
    group_id="groupId",
    zone_id="zoneId",
)
print(group.id)

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "external": true,
  "identifier": "identifier",
  "name": "name",
  "organization_id": "organization_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id",
  "member_count": 0,
  "roles": [
    "string"
  ]
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "external": true,
  "identifier": "identifier",
  "name": "name",
  "organization_id": "organization_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id",
  "member_count": 0,
  "roles": [
    "string"
  ]
}