Appearance
Interface: TeamClient
Settings › Team (users:manage): the organization's people, through the identity provider.
Properties
cancelInvitation
ts
cancelInvitation: (userId) => Promise<void>;Parameters
userId
string
Returns
Promise<void>
changeRole
ts
changeRole: (userId, body) => Promise<{
email: string | null;
id: string;
invitedAt: Date | null;
lastActiveAt: Date | null;
name: string;
openCases: number;
role: "admin" | "analyst" | "integration" | null;
status: "active" | "invited" | "deactivated";
}>;Parameters
userId
string
body
role
"admin" | "analyst"
Returns
Promise<{ email: string | null; id: string; invitedAt: Date | null; lastActiveAt: Date | null; name: string; openCases: number; role: "admin" | "analyst" | "integration" | null; status: "active" | "invited" | "deactivated"; }>
deactivate
ts
deactivate: (userId) => Promise<{
email: string | null;
id: string;
invitedAt: Date | null;
lastActiveAt: Date | null;
name: string;
openCases: number;
role: "admin" | "analyst" | "integration" | null;
status: "active" | "invited" | "deactivated";
}>;Parameters
userId
string
Returns
Promise<{ email: string | null; id: string; invitedAt: Date | null; lastActiveAt: Date | null; name: string; openCases: number; role: "admin" | "analyst" | "integration" | null; status: "active" | "invited" | "deactivated"; }>
invite
ts
invite: (body) => Promise<{
email: string | null;
id: string;
invitedAt: Date | null;
lastActiveAt: Date | null;
name: string;
openCases: number;
role: "admin" | "analyst" | "integration" | null;
status: "active" | "invited" | "deactivated";
}>;Parameters
body
email
string
name
string
role
"admin" | "analyst"
Returns
Promise<{ email: string | null; id: string; invitedAt: Date | null; lastActiveAt: Date | null; name: string; openCases: number; role: "admin" | "analyst" | "integration" | null; status: "active" | "invited" | "deactivated"; }>
list
ts
list: () => Promise<object[]>;Returns
Promise<object[]>
reactivate
ts
reactivate: (userId) => Promise<{
email: string | null;
id: string;
invitedAt: Date | null;
lastActiveAt: Date | null;
name: string;
openCases: number;
role: "admin" | "analyst" | "integration" | null;
status: "active" | "invited" | "deactivated";
}>;Parameters
userId
string
Returns
Promise<{ email: string | null; id: string; invitedAt: Date | null; lastActiveAt: Date | null; name: string; openCases: number; role: "admin" | "analyst" | "integration" | null; status: "active" | "invited" | "deactivated"; }>
resendInvitation
ts
resendInvitation: (userId) => Promise<void>;Parameters
userId
string
Returns
Promise<void>