OrganizationPlugin class
Organization plugin for Super Better Auth
This plugin provides comprehensive organization management features including:
- Organization CRUD operations
- Member management and invitations
- Role-based access control
- Team management (optional)
- Active organization/team handling
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptInvitation(
{required String invitationId}) → Future< bool> - Accept invitation
-
addMember(
{String? userId, required String role, String? organizationId, String? teamId}) → Future< Member?> - Add member directly (server-side only)
-
addTeamMember(
{required String teamId, required String userId}) → Future< bool> - Add team member
-
cancelInvitation(
{required String invitationId}) → Future< bool> - Cancel invitation
-
checkSlug(
{required String slug}) → Future< bool> - Check if organization slug is available
-
createOrganization(
{required String name, required String slug, String? logo, Map< String, dynamic> ? metadata, bool? keepCurrentActiveOrganization}) → Future<Organization?> - Create a new organization
-
createTeam(
{required String name, String? organizationId}) → Future< Team?> - Create a new team
-
deleteOrganization(
{required String organizationId}) → Future< bool> - Delete an organization
-
getActiveMember(
) → Future< Member?> - Get active member
-
getFullOrganization(
{String? organizationId, String? organizationSlug, int? membersLimit}) → Future< (Organization?, List< Member> )> - Get full organization details with members
-
getInvitation(
{required String id}) → Future< Invitation?> - Get invitation details
-
inviteMember(
{required String email, required String role, String? organizationId, bool? resend, String? teamId}) → Future< Invitation?> - Invite a member to the organization
-
leaveOrganization(
{required String organizationId}) → Future< bool> - Leave organization
-
listInvitations(
{String? organizationId}) → Future< List< Invitation> > - List organization invitations
-
listMembers(
{String? organizationId, int? limit, int? offset, String? sortBy, String? sortDirection, String? filterField, String? filterOperator, String? filterValue}) → Future< List< Member> > - List organization members
-
listOrganizations(
) → Future< List< Organization> > - List all organizations for the current user
-
listTeamMembers(
{String? teamId}) → Future< List< Member> > - List team members
-
listTeams(
{String? organizationId}) → Future< List< Team> > - List organization teams
-
listUserInvitations(
) → Future< List< Invitation> > - List user invitations
-
listUserTeams(
) → Future< List< Team> > - List user teams
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rejectInvitation(
{required String invitationId}) → Future< bool> - Reject invitation
-
removeMember(
{required String memberIdOrEmail, String? organizationId}) → Future< bool> - Remove a member from the organization
-
removeTeam(
{required String teamId, String? organizationId}) → Future< bool> - Remove team
-
removeTeamMember(
{required String teamId, required String userId}) → Future< bool> - Remove team member
-
setActiveOrganization(
{String? organizationId, String? organizationSlug}) → Future< bool> - Set active organization
-
setActiveTeam(
{String? teamId}) → Future< bool> - Set active team
-
toString(
) → String -
A string representation of this object.
inherited
-
updateMemberRole(
{required String role, required String memberId, String? organizationId}) → Future< Member?> - Update member role
-
updateOrganization(
{String? name, String? slug, String? logo, Map< String, dynamic> ? metadata, String? organizationId}) → Future<Organization?> - Update an existing organization
-
updateTeam(
{required String teamId, String? name, String? organizationId}) → Future< Team?> - Update team
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → OrganizationPlugin
-
Get the singleton instance of OrganizationPlugin
no setter