Skip to content

Users

Overview of users within the Keycard platform.

Users are people who access protected resources, either directly or by delegating access to applications and agents that act on their behalf.

Users authenticate to a zone through single sign-on (SSO) with their identity provider (IdP).

In enterprise scenarios, the corporate IdP can be used for employee SSO. Keycard supports Okta, Microsoft Entra ID, or any provider that implements OpenID Connect. To sign people in to a custom Zone with these providers, see Authenticate users with your identity provider.

In consumer scenarios, people can sign in with accounts they already have at an OpenID Connect provider your Zone connects to, such as Google or Auth0.

Every user has an identifier, a stable, zone-scoped value that uniquely identifies the user. By default, the identifier is the user’s Keycard ID.

Providers can auto-populate identifiers on first user login. See User Identifier Claim for details. Identifiers can also be set or updated in Keycard Console or via the management API. Each identifier must be unique.

The identifier defines the sub claim in tokens issued for the user.

A user can belong to any number of groups: named collections of users within the zone. Groups carry role assignments that every member inherits, and policies can grant access to a group instead of naming each user.

Users in a zone are created in one of three ways:

  • Just-in-time: created on first successful login through a configured identity provider.
  • Synced: pushed by an external directory over SCIM before they ever sign in, and disabled or deleted when the directory removes them. A synced user is owned by the directory: while directory sync is enabled for the zone, an Admin cannot change their status or delete them in Keycard. See SCIM Provisioning.
  • Manual: created by an Admin in Keycard Console or via the management API.

A just-in-time user is linked to the directory when it later provisions a user with the same email, so the two paths do not produce duplicates.