KEkeycardai
Groups

Update group

Changed on

Updates a group's name and/or identifier (partial update). A group's source is immutable. The name of a group synced from an external directory cannot be changed while external sync is enabled for the zone; its identifier can.

patch/zones/{zoneId}/groups/{groupId}

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}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

groupIdstring required

Group ID

Request body

namestring safe-text

Human-readable group name

identifierstring safe-text

User-specified identifier, unique within the zone.

Response

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.

idstring required

Unique identifier of the group

zone_idstring required

Zone this group belongs to

organization_idstring required

Organization this group belongs to

identifierstring required

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

namestring required

Human-readable group name

externalboolean required

Whether the group is synced from an external directory over SCIM. When true the group is directory-owned and its membership is read-only while the zone has external_sync_enabled set.

external_issuerstring nullable required

Issuer of the external directory the group was synced from. null for groups managed in Keycard. Read-only: set by external sync, never by the caller.

member_countinteger

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

rolesstring[]

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).

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes