invite

package

Go to main page

Versions in this module

v0

v0.30.0

Oct 29, 2026

v0.29.0

Oct 29, 2026

v0.28.0

Oct 29, 2026

v0.27.0

Oct 29, 2026

v0.26.0

Oct 28, 2026

v0.25.0

Oct 28, 2026

v0.24.0

Oct 27, 2026

v0.23.0

Oct 27, 2026

v0.22.0

Oct 26, 2026

v0.21.0

Oct 26, 2026

Changes in this version

+ var ErrExpired = errors.New("invite has expired")

+ var ErrInviterNotAuthorized = errors.New("invite: the inviter may no longer invite to this organization")

+ var ErrNotPending = errors.New("invite is no longer pending")

type ServiceOption

+ func WithAuthorizer(a authz.Authorizer) ServiceOption

v0.20.0

Oct 24, 2026

v0.19.0

Oct 22, 2026

v0.18.0

Oct 20, 2026

v0.17.0

Oct 19, 2026

v0.16.0

Oct 14, 2026

v0.15.0

Oct 13, 2026

v0.14.0

Oct 11, 2026

Changes in this version

+ var ErrAppRoleRequired = errors.New("invite: choose an application role for at least one entitled application")

+ var ErrResourceInvite = errors.New("invite: invalid resource target")

type APIConfig

+ Authorizer authz.Authorizer

+ Caller func(ctx context.Context) (uuid.UUID, error)

+ PrincipalEmail PrincipalEmailFunc

type CreateInviteInput

+ AppRoles map[string]string

+ ResourceID string

+ ResourceRole string

+ ResourceType string

type DefaultService

+ func (s *DefaultService) PrincipalEmail(ctx context.Context, principalID uuid.UUID) (string, error)

type Invite

+ AppRoles map[string]string

+ ResourceID string

+ ResourceRole string

+ ResourceType string

type InviteResponse

+ AppRoles map[string]string

+ ResourceID string

+ ResourceRole string

+ ResourceType string

+ type PrincipalEmailFunc func(ctx context.Context, principalID uuid.UUID) (string, error)

+ type ServiceOption func(*DefaultService)

+ func WithAppRoles(svc *approle.Service) ServiceOption

+ func WithAuthzSyncer(syncer authz.RelationshipSyncer) ServiceOption

+ func WithLogger(logger *slog.Logger) ServiceOption

+ func WithResourceGrants(svc *resourcegrant.Service) ServiceOption

+ func WithSyncMode(mode authz.SyncMode) ServiceOption

v0.13.0

Oct 7, 2026

v0.12.0

Oct 6, 2026

v0.11.0

Oct 3, 2026

v0.10.0

Sep 6, 2026

Changes in this version

+ const DefaultInviteExpiry

+ type API struct

+ func NewAPI(service Service, orgSvc organization.Service, config APIConfig) *API

+ func (a *API) Router() chi.Router

+ func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type APIConfig struct

+ BasePath string

+ Logger *slog.Logger

+ func DefaultAPIConfig() APIConfig

+ type AcceptInviteInput struct

+ PrincipalID uuid.UUID

+ Token string

+ type AcceptInviteRequest struct

+ Body struct{ ... }

+ Token string

+ type AcceptInviteResponse struct

+ Body *InviteResponse

+ type CreateInviteInput struct

+ Email string

+ ExpiresIn time.Duration

+ InviterPrincipalID uuid.UUID

+ Message *string

+ OrganizationID uuid.UUID

+ Role string

+ type CreateInviteRequest struct

+ Body struct{ ... }

+ Slug string

+ type CreateInviteResponse struct

+ Body *InviteResultResponse

+ type DeclineInviteRequest struct

+ Token string

+ type DeclineInviteResponse struct

+ Body *InviteResponse

+ type DefaultService struct

+ func (s *DefaultService) Accept(ctx context.Context, input AcceptInviteInput) (*Invite, error)

+ func (s *DefaultService) Create(ctx context.Context, input CreateInviteInput) (*InviteResult, error)

+ func (s *DefaultService) Decline(ctx context.Context, token string) (*Invite, error)

+ func (s *DefaultService) ExpireOld(ctx context.Context) (int, error)

+ func (s *DefaultService) GetByID(ctx context.Context, id uuid.UUID) (*Invite, error)

+ func (s *DefaultService) GetByToken(ctx context.Context, token string) (*Invite, error)

+ func (s *DefaultService) HasPendingInvite(ctx context.Context, organizationID uuid.UUID, email string) (bool, error)

+ func (s *DefaultService) List(ctx context.Context, input ListInvitesInput) ([]*Invite, error)

+ func (s *DefaultService) ListPendingForEmail(ctx context.Context, email string) ([]*Invite, error)

+ func (s *DefaultService) Resend(ctx context.Context, id uuid.UUID) (*InviteResult, error)

+ func (s *DefaultService) Revoke(ctx context.Context, id uuid.UUID) error

+ type GetInviteByTokenRequest struct

+ Token string

+ type GetInviteByTokenResponse struct

+ Body *InviteResponse

+ type Invite struct

+ AcceptedAt *time.Time

+ AcceptedByPrincipalID *uuid.UUID

+ CreatedAt time.Time

+ Email string

+ ExpiresAt time.Time

+ ID uuid.UUID

+ InviterPrincipalID uuid.UUID

+ LastSentAt time.Time

+ Message *string

+ OrganizationID uuid.UUID

+ ResendCount int

+ Role string

+ Status Status

+ Token string

+ UpdatedAt time.Time

+ func (i *Invite) CanAccept() bool

+ func (i *Invite) IsExpired() bool

+ func (i *Invite) IsPending() bool

+ type InviteResponse struct

+ AcceptedAt *time.Time

+ AcceptedByPrincipalID *string

+ CreatedAt time.Time

+ Email string

+ ExpiresAt time.Time

+ ID string

+ InviterPrincipalID string

+ LastSentAt time.Time

+ Message *string

+ OrganizationID string

+ ResendCount int

+ Role string

+ Status string

+ UpdatedAt time.Time

+ type InviteResult struct

+ Invite *Invite

+ InviteURL string

+ type InviteResultResponse struct

+ Invite *InviteResponse

+ InviteURL string

+ type ListInvitesInput struct

+ Email *string

+ Limit int

+ Offset int

+ OrganizationID *uuid.UUID

+ Status *Status

+ type ListInvitesRequest struct

+ Limit int

+ Offset int

+ Slug string

+ Status *string

+ type ListInvitesResponse struct

+ Body struct{ ... }

+ type ListPendingInvitesForEmailRequest struct

+ Email string

+ type ListPendingInvitesForEmailResponse struct

+ Body struct{ ... }

+ type ResendInviteRequest struct

+ InviteID string

+ Slug string

+ type ResendInviteResponse struct

+ Body *InviteResultResponse

+ type RevokeInviteRequest struct

+ InviteID string

+ Slug string

+ type Service interface

+ Accept func(ctx context.Context, input AcceptInviteInput) (*Invite, error)

+ Create func(ctx context.Context, input CreateInviteInput) (*InviteResult, error)

+ Decline func(ctx context.Context, token string) (*Invite, error)

+ ExpireOld func(ctx context.Context) (int, error)

+ GetByID func(ctx context.Context, id uuid.UUID) (*Invite, error)

+ GetByToken func(ctx context.Context, token string) (*Invite, error)

+ HasPendingInvite func(ctx context.Context, organizationID uuid.UUID, email string) (bool, error)

+ List func(ctx context.Context, input ListInvitesInput) ([]*Invite, error)

+ ListPendingForEmail func(ctx context.Context, email string) ([]*Invite, error)

+ Resend func(ctx context.Context, id uuid.UUID) (*InviteResult, error)

+ Revoke func(ctx context.Context, id uuid.UUID) error

+ func NewService(client *ent.Client, baseURL string) Service

+ type Status string

+ const StatusAccepted

+ const StatusDeclined

+ const StatusExpired

+ const StatusPending

+ const StatusRevoked

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL