Skip to content

basalt / teams/src / TeamRoutesOptions

Interface: TeamRoutesOptions ​

Defined in: teams/src/routes.ts:39

Properties ​

memberContacts? ​

> optional memberContacts?: boolean

Defined in: teams/src/routes.ts:60

Include each member's contact details (user: { id, email, emailVerified }) in GET /team/members, resolved through the users directory configured on teamsPlugin. Default false: a team's email addresses are only exposed over HTTP when you say so, and the plain membership listing stays byte-for-byte what it was.

The ids looked up come from the tenant's own memberships — never from the request — and a membership whose account is gone is omitted. Without a users directory the route fails with TEAM_USER_SOURCE_MISSING (500).


requireVerifiedEmail? ​

> optional requireVerifiedEmail?: boolean

Defined in: teams/src/routes.ts:48

Require ctx().user.emailVerified === true to accept an invitation. Default true: acceptance is bound to the invited address, and that binding is only meaningful if the caller proved they own it — otherwise anyone who registers the invitee's address could redeem a leaked link. Set false only for apps that verify ownership of the address some other way (the invited-address binding itself still applies).

Released under the MIT License.