Skip to content
Docs

Groups

API Reference
Zones

Groups

List groups
client.zones.groups.list(stringzoneID, GroupListParams { after, before, expand, 5 more } query?, RequestOptionsoptions?): GroupListResponse { items, pagination }
GET/zones/{zoneId}/groups
Create group
client.zones.groups.create(stringzoneID, GroupCreateParams { name, identifier } body, RequestOptionsoptions?): Group { id, created_at, external, 7 more }
POST/zones/{zoneId}/groups
Get group
client.zones.groups.retrieve(stringgroupID, GroupRetrieveParams { zoneId, expand } params, RequestOptionsoptions?): Group { id, created_at, external, 7 more }
GET/zones/{zoneId}/groups/{groupId}
Update group
client.zones.groups.update(stringgroupID, GroupUpdateParams { zoneId, identifier, name } params, RequestOptionsoptions?): Group { id, created_at, external, 7 more }
PATCH/zones/{zoneId}/groups/{groupId}
Delete group
client.zones.groups.delete(stringgroupID, GroupDeleteParams { zoneId } params, RequestOptionsoptions?): void
DELETE/zones/{zoneId}/groups/{groupId}
ModelsExpand Collapse
Group { id, created_at, external, 7 more }

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: string

Unique identifier of the group

created_at: string

Entity creation timestamp

formatdate-time
external: boolean

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: string

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

name: string

Human-readable group name

organization_id: string

Organization this group belongs to

updated_at: string

Entity update timestamp

formatdate-time
zone_id: string

Zone this group belongs to

member_count?: number

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

roles?: Array<string>

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

GroupCreate { name, identifier }

Schema for creating a group in Keycard. Groups synced from an external directory are created by that directory, not through this endpoint.

name: string

Human-readable group name

minLength1
maxLength255
formatsafe-text
identifier?: string

User-specified identifier, unique within the zone. Derived from the name when omitted (a suffix is appended if it collides).

minLength1
maxLength2048
formatsafe-text
GroupUpdate { identifier, name }

Schema for updating a group.

identifier?: string

User-specified identifier, unique within the zone.

minLength1
maxLength2048
formatsafe-text
name?: string

Human-readable group name

minLength1
maxLength255
formatsafe-text

GroupsMembers

List group members
client.zones.groups.members.list(stringgroupID, MemberListParams { zoneId, after, before, 4 more } params, RequestOptionsoptions?): MemberListResponse { items, pagination }
GET/zones/{zoneId}/groups/{groupId}/members
Add group member
client.zones.groups.members.add(stringgroupID, MemberAddParams { zoneId, user_id } params, RequestOptionsoptions?): GroupMember { created_at, user_id, user }
POST/zones/{zoneId}/groups/{groupId}/members
Remove group member
client.zones.groups.members.remove(stringuserID, MemberRemoveParams { zoneId, groupId } params, RequestOptionsoptions?): void
DELETE/zones/{zoneId}/groups/{groupId}/members/{userId}
ModelsExpand Collapse
GroupMember { created_at, user_id, user }

A user's membership in a group

created_at: string

Entity creation timestamp

formatdate-time
user_id: string

ID of the user

user?: User { id, created_at, email, 15 more }

An authenticated user entity

id: string

Unique identifier of the user

created_at: string

Entity creation timestamp

formatdate-time
email: string

Email address of the user

formatemail
email_verified: boolean

Whether the email address has been verified

identifier: string

Zone-scoped user identifier. Defaults to the user's Keycard ID. When the provider has user_identifier_claim configured, the value is set from that claim at user creation time.

organization_id: string

Organization that owns this user

status: "active" | "disabled"

Status of the user. Disabled users cannot authenticate.

Accepts one of the following:
"active"
"disabled"
updated_at: string

Entity update timestamp

formatdate-time
zone_id: string

Zone this user belongs to

authenticated_at?: string

Date when the user was last authenticated

credentials?: Array<IamUserCredentialFederation { created_at, provider_id, type, 4 more } | IamUserCredentialPassword { created_at, type, updated_at } >

Authentication credentials for this user, each carrying its identity provider for federation credentials. Populated only when expand[]=credentials is set on the listing endpoint.

Accepts one of the following:
IamUserCredentialFederation { created_at, provider_id, type, 4 more }

Federation credential: the user authenticates through an identity provider.

created_at: string

Entity creation timestamp

formatdate-time
provider_id: string | null

ID of the identity provider backing this credential. null when the source provider has been deleted.

type: "federation"
updated_at: string

Entity update timestamp

formatdate-time
issuer?: string

Issuer identifier of the identity provider.

provider?: Provider { id, created_at, identifier, 12 more }

A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.

id: string

Unique identifier of the provider

created_at: string

Entity creation timestamp

formatdate-time
identifier: string

User specified identifier, unique within the zone

minLength1
maxLength2048
name: string

Human-readable name

minLength1
maxLength255
organization_id: string

Organization that owns this provider

owner_type: "platform" | "customer"

Who owns this provider. Platform-owned providers cannot be modified via API.

Accepts one of the following:
"platform"
"customer"
slug: string

URL-safe identifier, unique within the zone

minLength1
maxLength63
updated_at: string

Entity update timestamp

formatdate-time
zone_id: string

Zone this provider belongs to

client_id?: string | null

OAuth 2.0 client identifier

client_secret_set?: boolean

Indicates whether a client secret is configured

description?: string | null

Human-readable description

maxLength2048
metadata?: Metadata | null

Provider metadata

icon_url?: string

Icon URL

formaturi
maxLength2048
protocols?: Protocols | null

Protocol-specific configuration

oauth2?: Oauth2 | null

OAuth 2.0 protocol configuration

issuer: string

OIDC issuer URL used for discovery and token validation.

formaturi
authorization_endpoint?: string | null
formaturi
authorization_parameters?: Record<string, string> | null

Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).

authorization_resource_enabled?: boolean | null

Whether to include the resource parameter in authorization requests.

authorization_resource_parameter?: string | null

The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.

code_challenge_methods_supported?: Array<string> | null
jwks_uri?: string | null
formaturi
registration_endpoint?: string | null
formaturi
scope_parameter?: string | null

The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".

scope_separator?: string | null

The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".

scopes_supported?: Array<string> | null
token_endpoint?: string | null
formaturi
token_response_access_token_pointer?: string | null

Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".

openid?: Openid | null

OpenID Connect protocol configuration

external_id_claim?: string | null

Name of the OIDC claim carrying the stable external id used to correlate logins with externally provisioned (SCIM) users. Defaults to "sub". Set to "oid" for Entra, whose pairwise "sub" differs from the SCIM externalId.

scopes?: Array<string> | null

Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).

single_logout_enabled?: boolean | null

When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.

user_identifier_claim?: string | null

Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.

userinfo_endpoint?: string | null
formaturi
type?: "external" | "keycard-vault" | "keycard-sts"
Accepts one of the following:
"external"
"keycard-vault"
"keycard-sts"
subject?: string

Subject identifier from the identity provider.

IamUserCredentialPassword { created_at, type, updated_at }

Password credential: the user authenticates with email and password. The email lives on the user.

created_at: string

Entity creation timestamp

formatdate-time
type: "password"
updated_at: string

Entity update timestamp

formatdate-time
grant_count?: number

Delegated-grant count for this user. Populated only when expand[]=grant_count is set on the listing endpoint.

minimum0
groups?: Array<Group>

Groups this user belongs to within the zone. Populated only when expand[]=groups is set on the listing endpoint.

id: string

Unique identifier of the group

identifier: string

Zone-unique slug that policy rules match on.

name: string

Human-readable group name

issuer?: string

Issuer identifier of the identity provider

provider_id?: string

Reference to the identity provider. This field is undefined when the source identity provider is deleted but the user is not deleted.

role_assignments?: Array<RoleAssignment>

Role grants for this user within the zone. Populated only when expand[]=role-assignments is set on the listing endpoint.

role_id: string

ID of the assigned role

role_identifier: string

Role identifier: a lowercase slug (letters and digits separated by single hyphens or underscores), unique per owner type within a zone. Role identifiers surface in policy evaluation, so the slug restriction keeps them unambiguous in policy text.

minLength1
maxLength255
role_owner_type: "platform" | "customer"

Owner type of the granted role. Disambiguates roles that share an identifier across owner types.

Accepts one of the following:
"platform"
"customer"
scope: Scope | null

The resource this grant is scoped to, or null when the grant is unscoped (applies to the owning zone itself).

id: string

The ID of the scoped resource.

type: string

The kind of resource this grant is scoped to (e.g. zone).

source: "user" | "group"

The principal that holds this grant: user when assigned directly to the user, or group when inherited through group membership.

Accepts one of the following:
"user"
"group"
group_id?: string

ID of the group this grant is inherited from. Present only when source is group.

session_count?: number

Session count for this user. Populated only when expand[]=session_count is set on the listing endpoint.

minimum0
subject?: string

Subject identifier from the identity provider

GroupMemberCreate { user_id }

Schema for adding a user to a group

user_id: string

ID of the user to add to the group

GroupsRoles

List group role assignments
client.zones.groups.roles.list(stringgroupID, RoleListParams { zoneId, after, before, 3 more } params, RequestOptionsoptions?): RoleListResponse { items, pagination }
GET/zones/{zoneId}/groups/{groupId}/roles
Assign role to group
client.zones.groups.roles.add(stringgroupID, RoleAddParams { zoneId, owner_type, role_id, 3 more } params, RequestOptionsoptions?): RoleAssignment { id, created_at, principal_id, 8 more }
POST/zones/{zoneId}/groups/{groupId}/roles
Revoke role from group
client.zones.groups.roles.remove(stringroleID, RoleRemoveParams { zoneId, groupId, scope_id, scope_type } params, RequestOptionsoptions?): void
DELETE/zones/{zoneId}/groups/{groupId}/roles/{roleId}