schema

type AccessChange ¶ added in v0.14.0

type AccessChange struct {
	ent.Schema
}

AccessChange holds the schema definition for a record that a principal's access was reduced or ended (ADR-010). Relying parties refuse tokens issued before a recorded change, so the record outlives the change only for as long as such a token could exist; rows older than that are pruned (accesschange.Prune).

The principal and organization are plain identifiers, not edges: a row is written in the transaction that deletes or deactivates the thing it describes, and must survive it.

func (AccessChange) Annotations() []schema.Annotation

func (AccessChange) Fields() []ent.Field

func (AccessChange) Indexes() []ent.Index

func (AccessChange) Mixin() []ent.Mixin

type Agent ¶

type Agent struct {
	ent.Schema
}

Agent holds the schema definition for AI agent-specific principal data. This is a one-to-one extension of Principal where type="agent".

func (Agent) Annotations() []schema.Annotation

func (Agent) Edges() []ent.Edge

func (Agent) Fields() []ent.Field

func (Agent) Indexes() []ent.Index

func (Agent) Mixin() []ent.Mixin

type AppRole ¶ added in v0.14.0

type AppRole struct {
	ent.Schema
}

AppRole holds the schema definition for a principal's role in one application of an organization. The role is one of the roles the application declares in its authz.AppVocabulary; the service validates it, so the column is free text and new application roles need no migration.

func (AppRole) Annotations() []schema.Annotation

func (AppRole) Edges() []ent.Edge

func (AppRole) Fields() []ent.Field

func (AppRole) Indexes() []ent.Index

func (AppRole) Mixin() []ent.Mixin

type Application ¶

type Application struct {
	ent.Schema
}

Application holds the schema definition for OAuth application-specific principal data. This is a one-to-one extension of Principal where type="application".

func (Application) Annotations() []schema.Annotation

func (Application) Edges() []ent.Edge

func (Application) Fields() []ent.Field

func (Application) Indexes() []ent.Index

func (Application) Mixin() []ent.Mixin

type BaseMixin ¶

type BaseMixin struct {
	mixin.Schema
}

BaseMixin combines UUID and Timestamp mixins for convenience.

func (BaseMixin) Fields() []ent.Field

type ClientAssertionJTI ¶ added in v0.14.0

type ClientAssertionJTI struct {
	ent.Schema
}

ClientAssertionJTI records the JWT IDs of client assertions that have been used, so a signed assertion cannot be replayed before it expires (RFC 7523 section 3, as required by Fosite's client manager).

func (ClientAssertionJTI) Annotations() []schema.Annotation

func (ClientAssertionJTI) Fields() []ent.Field

func (ClientAssertionJTI) Indexes() []ent.Index

func (ClientAssertionJTI) Mixin() []ent.Mixin

type ConsentGrant ¶ added in v0.12.0

type ConsentGrant struct {
	ent.Schema
}

ConsentGrant records one scope a principal granted to an OAuth client on the SystemAuth consent page. One row per (principal, client, scope) keeps concurrent grants race-free without read-modify-write.

func (ConsentGrant) Annotations() []schema.Annotation

func (ConsentGrant) Fields() []ent.Field

func (ConsentGrant) Indexes() []ent.Index

type Credential ¶

type Credential struct {
	ent.Schema
}

Credential holds the schema definition for unified credentials. Credentials can be passwords, API keys, keypairs, WebAuthn credentials, or TOTP secrets.

func (Credential) Annotations() []schema.Annotation

func (Credential) Edges() []ent.Edge

func (Credential) Fields() []ent.Field

func (Credential) Indexes() []ent.Index

type ExternalIdentity ¶ added in v0.12.0

type ExternalIdentity struct {
	ent.Schema
}

ExternalIdentity links a Principal to an upstream login identity (e.g. a GitHub or Google account). The (provider, subject) pair is the stable key used to find the principal on every social login; email is recorded for information and verified-email linking only.

func (ExternalIdentity) Annotations() []schema.Annotation

func (ExternalIdentity) Edges() []ent.Edge

func (ExternalIdentity) Fields() []ent.Field

func (ExternalIdentity) Indexes() []ent.Index

func (ExternalIdentity) Mixin() []ent.Mixin

type Human ¶

type Human struct {
	ent.Schema
}

Human holds the schema definition for human-specific principal data. This is a one-to-one extension of Principal where type="human".

func (Human) Annotations() []schema.Annotation

func (Human) Edges() []ent.Edge

func (Human) Fields() []ent.Field

func (Human) Indexes() []ent.Index

func (Human) Mixin() []ent.Mixin

type Invite ¶

type Invite struct {
	ent.Schema
}

Invite holds the schema definition for organization invitations. Invites allow existing members to invite new users to join an organization.

func (Invite) Annotations() []schema.Annotation

func (Invite) Edges() []ent.Edge

func (Invite) Fields() []ent.Field

func (Invite) Indexes() []ent.Index

func (Invite) Mixin() []ent.Mixin

type License ¶

type License struct {
	ent.Schema
}

License holds the schema definition for a marketplace license entitlement.

func (License) Annotations() []schema.Annotation

func (License) Edges() []ent.Edge

func (License) Fields() []ent.Field

func (License) Indexes() []ent.Index

func (License) Mixin() []ent.Mixin

type Listing ¶

type Listing struct {
	ent.Schema
}

Listing holds the schema definition for a marketplace product listing.

func (Listing) Annotations() []schema.Annotation

func (Listing) Edges() []ent.Edge

func (Listing) Fields() []ent.Field

func (Listing) Indexes() []ent.Index

func (Listing) Mixin() []ent.Mixin

type LoginSession ¶ added in v0.12.0

type LoginSession struct {
	ent.Schema
}

LoginSession holds SystemAuth browser login sessions (the __Host-sf_login cookie). Only a SHA-256 hash of the opaque session token is stored.

func (LoginSession) Annotations() []schema.Annotation

func (LoginSession) Fields() []ent.Field

func (LoginSession) Indexes() []ent.Index

type LoginState ¶ added in v0.12.0

type LoginState struct {
	ent.Schema
}

LoginState holds in-flight upstream OAuth logins started by SystemAuth social login. Rows are single-use and short-lived; only a SHA-256 hash of the OAuth state value is stored.

func (LoginState) Annotations() []schema.Annotation

func (LoginState) Fields() []ent.Field

func (LoginState) Indexes() []ent.Index

type ManagerClaim ¶ added in v0.14.0

type ManagerClaim struct {
	ent.Schema
}

ManagerClaim is a single-use code a manager issues so that a human with an email can become guardian of a managed principal (ADR-005). Claims are kept apart from credentials so a claim code can never sign anyone in.

func (ManagerClaim) Annotations() []schema.Annotation

func (ManagerClaim) Edges() []ent.Edge

func (ManagerClaim) Fields() []ent.Field

func (ManagerClaim) Indexes() []ent.Index

type ManagerInvite ¶ added in v0.14.0

type ManagerInvite struct {
	ent.Schema
}

ManagerInvite is a single-use invitation with which a human with a verified email offers to manage a self-managed human, who enters management only by accepting it while signed in (ADR-009). It is kept apart from organization invites, which grant membership, not authority over a person.

func (ManagerInvite) Annotations() []schema.Annotation

func (ManagerInvite) Fields() []ent.Field

func (ManagerInvite) Indexes() []ent.Index

type ManagerRelationship ¶ added in v0.14.0

type ManagerRelationship struct {
	ent.Schema
}

ManagerRelationship records that one human principal manages another (ADR-005). A managed principal, a human without an email, always has at least one active manager, and a manager is a human with an email.

func (ManagerRelationship) Annotations() []schema.Annotation

func (ManagerRelationship) Edges() []ent.Edge

func (ManagerRelationship) Fields() []ent.Field

func (ManagerRelationship) Indexes() []ent.Index

func (ManagerRelationship) Mixin() []ent.Mixin

type OAuthApp ¶

type OAuthApp struct {
	ent.Schema
}

OAuthApp holds the schema definition for OAuth 2.0 applications/clients.

func (OAuthApp) Annotations() []schema.Annotation

func (OAuthApp) Edges() []ent.Edge

func (OAuthApp) Fields() []ent.Field

func (OAuthApp) Indexes() []ent.Index

type OAuthAppSecret ¶

type OAuthAppSecret struct {
	ent.Schema
}

OAuthAppSecret holds client secrets for OAuth apps. Multiple secrets can exist for rotation purposes.

func (OAuthAppSecret) Annotations() []schema.Annotation

func (OAuthAppSecret) Edges() []ent.Edge

func (OAuthAppSecret) Fields() []ent.Field

func (OAuthAppSecret) Indexes() []ent.Index

type OAuthAuthCode ¶

type OAuthAuthCode struct {
	ent.Schema
}

OAuthAuthCode holds OAuth 2.0 authorization codes.

func (OAuthAuthCode) Annotations() []schema.Annotation

func (OAuthAuthCode) Edges() []ent.Edge

func (OAuthAuthCode) Fields() []ent.Field

func (OAuthAuthCode) Indexes() []ent.Index

type OAuthConsent ¶

type OAuthConsent struct {
	ent.Schema
}

OAuthConsent tracks user consent for OAuth apps. First-party apps skip consent; third-party apps require explicit approval.

func (OAuthConsent) Annotations() []schema.Annotation

func (OAuthConsent) Edges() []ent.Edge

func (OAuthConsent) Fields() []ent.Field

func (OAuthConsent) Indexes() []ent.Index

type OAuthToken ¶

type OAuthToken struct {
	ent.Schema
}

OAuthToken holds OAuth 2.0 access and refresh tokens.

func (OAuthToken) Annotations() []schema.Annotation

func (OAuthToken) Edges() []ent.Edge

func (OAuthToken) Fields() []ent.Field

func (OAuthToken) Indexes() []ent.Index

type Organization ¶

type Organization struct {
	ent.Schema
}

Organization holds the schema definition for the Organization entity.

func (Organization) Annotations() []schema.Annotation

func (Organization) Edges() []ent.Edge

func (Organization) Fields() []ent.Field

func (Organization) Indexes() []ent.Index

func (Organization) Mixin() []ent.Mixin

type Principal ¶

type Principal struct {
	ent.Schema
}

Principal holds the schema definition for the Principal entity. Principal is the unified identity root representing any type of actor: human, application, agent, or service.

func (Principal) Annotations() []schema.Annotation

func (Principal) Edges() []ent.Edge

func (Principal) Fields() []ent.Field

func (Principal) Indexes() []ent.Index

func (Principal) Mixin() []ent.Mixin

type PrincipalMembership ¶

type PrincipalMembership struct {
	ent.Schema
}

PrincipalMembership holds the schema definition for principal-organization memberships. This extends the existing Membership concept to support all principal types.

func (PrincipalMembership) Annotations() []schema.Annotation

func (PrincipalMembership) Edges() []ent.Edge

func (PrincipalMembership) Fields() []ent.Field

func (PrincipalMembership) Indexes() []ent.Index

func (PrincipalMembership) Mixin() []ent.Mixin

type PrincipalToken ¶

type PrincipalToken struct {
	ent.Schema
}

PrincipalToken holds OAuth 2.0 access and refresh tokens for principals. This replaces OAuthToken with principal-centric token management.

func (PrincipalToken) Annotations() []schema.Annotation

func (PrincipalToken) Edges() []ent.Edge

func (PrincipalToken) Fields() []ent.Field

func (PrincipalToken) Indexes() []ent.Index

type ResourceGrant ¶ added in v0.14.0

type ResourceGrant struct {
	ent.Schema
}

ResourceGrant holds the schema definition for a principal's role on one resource of an organization (ADR-008). A grant gives access to that resource without organization-wide access: a principal who is not a member of the organization holds a "collaborator" membership while it has any grant there.

The resource type is the application's definition name, "{app}_{type}", and the resource identifier is the application's own string, so the substrate stores grants for resources it knows nothing else about. The role is one of the resource roles viewer, contributor and maintainer (authz.ResourceRoles); the service validates it, so the column is free text and a new resource role needs no migration.

func (ResourceGrant) Annotations() []schema.Annotation

func (ResourceGrant) Edges() []ent.Edge

func (ResourceGrant) Fields() []ent.Field

func (ResourceGrant) Indexes() []ent.Index

func (ResourceGrant) Mixin() []ent.Mixin

type SeatAssignment ¶

type SeatAssignment struct {
	ent.Schema
}

SeatAssignment holds the schema definition for a license seat assignment.

func (SeatAssignment) Annotations() []schema.Annotation

func (SeatAssignment) Edges() []ent.Edge

func (SeatAssignment) Fields() []ent.Field

func (SeatAssignment) Indexes() []ent.Index

func (SeatAssignment) Mixin() []ent.Mixin

type ServicePrincipal ¶

type ServicePrincipal struct {
	ent.Schema
}

ServicePrincipal holds the schema definition for backend service-specific principal data. This is a one-to-one extension of Principal where type="service".

func (ServicePrincipal) Annotations() []schema.Annotation

func (ServicePrincipal) Edges() []ent.Edge

func (ServicePrincipal) Fields() []ent.Field

func (ServicePrincipal) Indexes() []ent.Index

func (ServicePrincipal) Mixin() []ent.Mixin

type SlugReservation ¶ added in v0.14.0

type SlugReservation struct {
	ent.Schema
}

SlugReservation holds the schema definition for a slug an organization gave up. For the cooling-off period the slug resolves to the organization that released it, and only the principal who released it (or an organization that principal owns) may take it again (ADR-006).

func (SlugReservation) Annotations() []schema.Annotation

func (SlugReservation) Edges() []ent.Edge

func (SlugReservation) Fields() []ent.Field

func (SlugReservation) Indexes() []ent.Index

func (SlugReservation) Mixin() []ent.Mixin

type Subscription ¶

type Subscription struct {
	ent.Schema
}

Subscription holds the schema definition for a platform subscription.

func (Subscription) Annotations() []schema.Annotation

func (Subscription) Edges() []ent.Edge

func (Subscription) Fields() []ent.Field

func (Subscription) Indexes() []ent.Index

func (Subscription) Mixin() []ent.Mixin

type TimeOrderedUUIDMixin ¶ added in v0.14.0

type TimeOrderedUUIDMixin struct {
	mixin.Schema
}

TimeOrderedUUIDMixin provides a UUIDv7 primary key field. Unlike UUIDMixin's random v4 IDs, v7 IDs sort in creation order, so ordering by (timestamp, id) is deterministic when timestamps tie, as they do on platforms with a coarse clock such as Windows. Use it on append-only records that are read back in the order they were written.

func (TimeOrderedUUIDMixin) Fields() []ent.Field

type TimestampMixin ¶

type TimestampMixin struct {
	mixin.Schema
}

TimestampMixin provides created_at and updated_at timestamp fields.

func (TimestampMixin) Fields() []ent.Field

type UUIDMixin ¶

type UUIDMixin struct {
	mixin.Schema
}

UUIDMixin provides a UUID primary key field.

func (UUIDMixin) Fields() []ent.Field