Equipe (TeamApi)
Le module TeamApi permet de gerer les membres, roles, invitations et permissions de votre equipe.
Acces : client.team
Methodes
myPermissions
Recupere les permissions de l’utilisateur courant.
Exemple
const response = await client.team.myPermissions({
appId: "app_id",
apiKey: "user_api_key"
});
console.log("Est proprietaire:", response.data.isOwner);
console.log("Permissions:", response.data.permissions);transferOwnership
Transfere la propriete de l’application a un membre existant.
Exemple
const response = await client.team.transferOwnership({
appId: "app_id",
apiKey: "user_api_key",
newOwnerId: "member_user_id",
password: "current_password",
roleIdForPreviousOwner: "role_id"
});Sous-modules
Membres (client.team.member)
list
Liste les membres de l’equipe et le proprietaire.
Exemple
const response = await client.team.member.list({
appId: "app_id",
apiKey: "user_api_key"
});
console.log("Proprietaire:", response.data.owner);
console.log("Membres:", response.data.members);remove
Retire un membre de l’equipe. Reserve au proprietaire.
Exemple
await client.team.member.remove({
appId: "app_id",
apiKey: "user_api_key",
memberId: "member_id"
});suspend
Suspend ou reactive un membre.
Exemple
await client.team.member.suspend({
appId: "app_id",
apiKey: "user_api_key",
memberId: "member_id",
suspend: true
});updateRole
Change le role d’un membre.
Exemple
await client.team.member.updateRole({
appId: "app_id",
apiKey: "user_api_key",
memberId: "member_id",
roleId: "new_role_id"
});Invitations (client.team.invitation)
list
Liste les invitations en attente.
Exemple
const response = await client.team.invitation.list({
appId: "app_id",
apiKey: "user_api_key"
});create
Cree une invitation pour un nouvel utilisateur.
Exemple
const response = await client.team.invitation.create({
appId: "app_id",
apiKey: "user_api_key",
email: "invitee@example.com",
roleId: "role_id"
});revoke
Revoque une invitation en attente.
Exemple
await client.team.invitation.revoke({
appId: "app_id",
apiKey: "user_api_key",
invitationId: "invitation_id"
});getByToken
Recupere les details d’une invitation par son token.
Exemple
const response = await client.team.invitation.getByToken({
apiKey: "user_api_key",
token: "invitation_token"
});accept
Accepte une invitation.
Exemple
const response = await client.team.invitation.accept({
apiKey: "user_api_key",
token: "invitation_token"
});decline
Decline une invitation.
Exemple
await client.team.invitation.decline({
apiKey: "user_api_key",
token: "invitation_token"
});Roles (client.team.role)
list
Liste les roles de l’application.
Exemple
const response = await client.team.role.list({
appId: "app_id",
apiKey: "user_api_key"
});create
Cree un nouveau role.
Exemple
const response = await client.team.role.create({
appId: "app_id",
apiKey: "user_api_key",
name: "Editeur",
description: "Peut modifier le contenu",
permissions: {
"customers": { "view": true, "create": true, "update": true, "delete": false },
"store.products": { "view": true, "create": true, "update": true, "delete": false }
}
});update
Met a jour un role existant.
Exemple
await client.team.role.update({
appId: "app_id",
apiKey: "user_api_key",
roleId: "role_id",
name: "Editeur Senior",
permissions: { "customers": { "view": true, "create": true, "update": true, "delete": true } }
});delete
Supprime un role. Echoue si des membres sont assignes.
Exemple
await client.team.role.delete({
appId: "app_id",
apiKey: "user_api_key",
roleId: "role_id"
});Last updated on