Groups
Groups
List groups
Create group
Update group
Delete group
ModelsExpand 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.
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.
Unique identifier of the group
Entity creation timestamp
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.
User-specified identifier, unique within the zone. Automatically assigned for groups from an external directory.
Human-readable group name
Organization this group belongs to
Entity update timestamp
Zone this group belongs to
Number of users in the group. Included only when requested via expand[]=member_count (group get or list).
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).
class GroupCreate: …Schema for creating a group in Keycard. Groups synced from an external directory are created by that directory, not through this endpoint.
Schema for creating a group in Keycard. Groups synced from an external directory are created by that directory, not through this endpoint.
Human-readable group name
User-specified identifier, unique within the zone. Derived from the name when omitted (a suffix is appended if it collides).
class GroupUpdate: …Schema for updating a group.
Schema for updating a group.
User-specified identifier, unique within the zone.
Human-readable group name
GroupsMembers
List group members
Add group member
Remove group member
ModelsExpand Collapse
class GroupMember: …A user's membership in a group
A user's membership in a group
Entity creation timestamp
ID of the user
user: Optional[User]An authenticated user entity
An authenticated user entity
Unique identifier of the user
Entity creation timestamp
Email address of the user
Whether the email address has been verified
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 that owns this user
status: Literal["active", "disabled"]Status of the user. Disabled users cannot authenticate.
Status of the user. Disabled users cannot authenticate.
Entity update timestamp
Zone this user belongs to
Date when the user was last authenticated
credentials: Optional[List[Credential]]Authentication credentials for this user, each carrying its identity provider for federation credentials. Populated only when expand[]=credentials is set on the listing endpoint.
Authentication credentials for this user, each carrying its identity provider for federation credentials. Populated only when expand[]=credentials is set on the listing endpoint.
class CredentialIamUserCredentialFederation: …Federation credential: the user authenticates through an identity provider.
Federation credential: the user authenticates through an identity provider.
Entity creation timestamp
ID of the identity provider backing this credential. null when the source provider has been deleted.
Entity update timestamp
Issuer identifier of the identity provider.
provider: Optional[Provider]A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
Unique identifier of the provider
Entity creation timestamp
User specified identifier, unique within the zone
Human-readable name
Organization that owns this provider
owner_type: Literal["platform", "customer"]Who owns this provider. Platform-owned providers cannot be modified via API.
Who owns this provider. Platform-owned providers cannot be modified via API.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this provider belongs to
OAuth 2.0 client identifier
Indicates whether a client secret is configured
Human-readable description
metadata: Optional[Metadata]Provider metadata
Provider metadata
Icon URL
protocols: Optional[Protocols]Protocol-specific configuration
Protocol-specific configuration
oauth2: Optional[ProtocolsOauth2]OAuth 2.0 protocol configuration
OAuth 2.0 protocol configuration
OIDC issuer URL used for discovery and token validation.
Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
Whether to include the resource parameter in authorization requests.
The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
openid: Optional[ProtocolsOpenid]OpenID Connect protocol configuration
OpenID Connect protocol configuration
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.
Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
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.
type: Optional[Literal["external", "keycard-vault", "keycard-sts"]]
Subject identifier from the identity provider.
class CredentialIamUserCredentialPassword: …Password credential: the user authenticates with email and password. The email lives on the user.
Password credential: the user authenticates with email and password. The email lives on the user.
Entity creation timestamp
Entity update timestamp
Delegated-grant count for this user. Populated only when expand[]=grant_count is set on the listing endpoint.
groups: Optional[List[Group]]Groups this user belongs to within the zone. Populated only when expand[]=groups is set on the listing endpoint.
Groups this user belongs to within the zone. Populated only when expand[]=groups is set on the listing endpoint.
Unique identifier of the group
Zone-unique slug that policy rules match on.
Human-readable group name
Issuer identifier of the identity provider
Reference to the identity provider. This field is undefined when the source identity provider is deleted but the user is not deleted.
role_assignments: Optional[List[RoleAssignment]]Role grants for this user within the zone. Populated only when expand[]=role-assignments is set on the listing endpoint.
Role grants for this user within the zone. Populated only when expand[]=role-assignments is set on the listing endpoint.
ID of the assigned role
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.
role_owner_type: Literal["platform", "customer"]Owner type of the granted role. Disambiguates roles that share an identifier across owner types.
Owner type of the granted role. Disambiguates roles that share an identifier across owner types.
scope: Optional[RoleAssignmentScope]The resource this grant is scoped to, or null when the grant is unscoped (applies to the owning zone itself).
The resource this grant is scoped to, or null when the grant is unscoped (applies to the owning zone itself).
The ID of the scoped resource.
The kind of resource this grant is scoped to (e.g. zone).
source: Literal["user", "group"]The principal that holds this grant: user when assigned directly to the user, or group when inherited through group membership.
The principal that holds this grant: user when assigned directly to the user, or group when inherited through group membership.
ID of the group this grant is inherited from. Present only when source is group.
Session count for this user. Populated only when expand[]=session_count is set on the listing endpoint.
Subject identifier from the identity provider
class GroupMemberCreate: …Schema for adding a user to a group
Schema for adding a user to a group
ID of the user to add to the group