membership
Pydantic models related to organization memberships.
A membership links a user to an organization with a role.
MemberOut
pydantic-model
¶
Bases: BaseModel
A member of an organization, as listed to its other members.
Config:
frozen:True
Fields:
-
id(UUID) -
user_id(UUID) -
email(str) -
name(str | None) -
role(MembershipRole) -
created_at(datetime)
created_at
pydantic-field
¶
When the member joined.
email
pydantic-field
¶
The member's email address.
id
pydantic-field
¶
The membership id; the id to address for role changes and removal.
name = None
pydantic-field
¶
The member's display name, if set.
role
pydantic-field
¶
The member's role in the organization.
user_id
pydantic-field
¶
The member's user id.
MemberRoleUpdate
pydantic-model
¶
Membership
pydantic-model
¶
Bases: BaseModel
Canonical Membership model — a user's role within an organization.
Config:
from_attributes:Truefrozen:True
Fields:
-
id(UUID) -
org_id(UUID) -
user_id(UUID) -
role(MembershipRole) -
created_at(datetime)