Skip to main content
Module

x/appwrite/mod.ts>Teams

[READ-ONLY] Official Appwrite Deno SDK 🦕
appwrite/sdk-for-deno
Go to Latest
class Teams
extends Service
Re-export
import { Teams } from "https://deno.land/x/appwrite@3.0.0/mod.ts";

Methods

create(
teamId: string,
name: string,
roles?: string[],
): Promise<Models.Team>

Create Team

Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.

createMembership(
teamId: string,
email: string,
roles: string[],
url: string,
name?: string,
): Promise<Models.Membership>

Create Team Membership

Invite a new member to join your team. If initiated from the client SDK, an email with a link to join the team will be sent to the member's email address and an account will be created for them should they not be signed up already. If initiated from server-side SDKs, the new member will automatically be added to the team.

Use the 'url' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the Update Team Membership Status endpoint to allow the user to accept the invitation to the team.

Please note that to avoid a Redirect Attack the only valid redirect URL's are the once from domains you have set when adding your platforms in the console interface.

delete(teamId: string): Promise<Response>

Delete Team

Delete a team using its ID. Only team members with the owner role can delete the team.

deleteMembership(teamId: string, membershipId: string): Promise<Response>

Delete Team Membership

This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.

get(teamId: string): Promise<Models.Team>

Get Team

Get a team by its ID. All team members have read access for this resource.

getMembership(teamId: string, membershipId: string): Promise<Models.MembershipList>

Get Team Membership

Get a team member by the membership unique id. All team members have read access for this resource.

getMemberships(
teamId: string,
search?: string,
limit?: number,
offset?: number,
cursor?: string,
cursorDirection?: string,
orderType?: string,
): Promise<Models.MembershipList>

Get Team Memberships

Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.

list(
search?: string,
limit?: number,
offset?: number,
cursor?: string,
cursorDirection?: string,
orderType?: string,
): Promise<Models.TeamList>

List Teams

Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.

In admin mode, this endpoint returns a list of all the teams in the current project. Learn more about different API modes.

update(teamId: string, name: string): Promise<Models.Team>

Update Team

Update a team using its ID. Only members with the owner role can update the team.

updateMembershipRoles(
teamId: string,
membershipId: string,
roles: string[],
): Promise<Models.Membership>

Update Membership Roles

Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about roles and permissions.

updateMembershipStatus(
teamId: string,
membershipId: string,
userId: string,
secret: string,
): Promise<Models.Membership>

Update Team Membership Status

Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.

If the request is successful, a session for the user is automatically created.