invitation
Organization invitations: asking someone by email to join a team organization.
InvitationCreate
pydantic-model
¶
Bases: BaseModel
Invite an email address into a team organization.
The invitee receives a link that is valid for a limited time and can be accepted once, by an account whose verified email matches the address.
Fields:
-
email(EmailStr) -
role(MembershipRole)
Validators:
InvitationOut
pydantic-model
¶
Bases: BaseModel
An invitation as listed to the organization's admins. Never carries the token.
Config:
frozen:True
Fields:
-
id(UUID) -
org_id(UUID) -
email(str) -
role(MembershipRole) -
invited_by_name(str | None) -
status(InvitationStatus) -
created_at(datetime) -
expires_at(datetime)
created_at
pydantic-field
¶
When it was sent.
email
pydantic-field
¶
The invited address.
expires_at
pydantic-field
¶
When it stops being acceptable.
id
pydantic-field
¶
Unique identifier of the invitation.
invited_by_name = None
pydantic-field
¶
Display name of the member who sent it, if set.
org_id
pydantic-field
¶
The organization the invitation is for.
role
pydantic-field
¶
The role the invitee joins with.
status
pydantic-field
¶
Where the invitation stands.
InvitationPreview
pydantic-model
¶
Bases: BaseModel
What an invitation link is for, shown before accepting it.
Returned to whoever holds the link; it names the organization, the inviter and the invited address so the holder can sign in with the right account or register it.
Config:
frozen:True
Fields:
-
organization_name(str) -
inviter_name(str | None) -
email(str) -
role(MembershipRole) -
expires_at(datetime)
email
pydantic-field
¶
The invited address.
expires_at
pydantic-field
¶
When the link stops working.
inviter_name = None
pydantic-field
¶
Display name of the member who sent it, if set.
organization_name
pydantic-field
¶
The organization inviting.
role
pydantic-field
¶
The role the invitee joins with.