Invitations Module
The invitations module (sso.invitations) manages organization team invitations.
Core Invitation Methods
sso.invitations.create()
Signature:
create(orgSlug: string, payload: CreateInvitationPayload): Promise<Invitation>
Description: Create and send an invitation to join an organization. Requires ‘owner’ or ‘admin’ role.
Parameters:
| Name | Type | Description |
|---|---|---|
| orgSlug | string | Organization slug |
| payload | CreateInvitationPayload | Invitation details |
| payload.email | string | Email address of the person to invite |
| payload.role | ‘owner’ | ‘admin’ | ‘member’ | Role to assign |
sso.invitations.listForOrg()
Signature:
listForOrg(orgSlug: string): Promise<Invitation[]>
Description: List all invitations for an organization.
sso.invitations.cancel()
Signature:
cancel(orgSlug: string, invitationId: string): Promise<void>
Description: Cancel a pending invitation. Requires ‘owner’ or ‘admin’ role.
sso.invitations.listForUser()
Signature:
listForUser(): Promise<InvitationWithOrg[]>
Description: List invitations received by the current authenticated user across all organizations.
sso.invitations.accept() | decline()
Signature:
accept(token: string): Promise<void>
decline(token: string): Promise<void>
Description: Join or reject an organization using the invitation token.
sso.invitations.acceptById() | declineById()
Signature:
acceptById(invitationId: string): Promise<void>
declineById(invitationId: string): Promise<void>
Description: Accept or decline one of the current authenticated user’s invitations by invitation ID instead of the emailed token.
Type Definitions
Refer to sso-sdk/src/types for complete interface definitions.