Gérer l'expiration des adhésions

Cette page explique comment mettre à jour et récupérer les paramètres d'expiration pour les membres d'un groupe, ainsi que les notifications d'expiration que les propriétaires de groupe reçoivent.

Remarque : Cette fonctionnalité n'est disponible que pour les comptes Google Workspace Enterprise Standard, Enterprise Plus, Enterprise for Education et Cloud Identity Premium.

L'expiration des appartenances permet aux propriétaires de groupe, aux gestionnaires de groupe, aux super-administrateurs Google Workspace ou aux administrateurs délégués Workspace disposant des droits d'administrateur de gérer les groupes et l'accès aux ressources en fonction des groupes. L'accès peut être limité en fonction de l'obsolescence de l'appartenance ou d'un besoin temporaire sans avoir à supprimer manuellement les membres. L'API Groups permet de faire expirer l'appartenance dans les cas d'utilisation suivants :

• Accès aux ressources limité dans le temps (par exemple, pour permettre à un membre de résoudre un problème en production).
• Appartenance temporaire à un groupe de communication (par exemple, pour inclure brièvement une personne dans un groupe d'équipe sur un projet à long terme).

Les dates d'expiration peuvent être appliquées à tous les types de membres de groupe (y compris les utilisateurs, les groupes et les comptes de service) à condition qu'ils disposent du rôle MEMBER. Lorsque vous définissez une date d'expiration pour un membre qui est un groupe, cette date devient la date d'expiration par défaut pour tous les membres enfants de ce groupe, sauf si le membre enfant possède une appartenance directe au groupe parent avec application d'une date d'expiration individuelle. La date d'expiration s'applique également à tous les nouveaux membres à venir du groupe enfant.

Avant de commencer

Configurez l'authentification et installez les bibliothèques clientes. Pour en savoir plus, consultez la page Configurer l'API Cloud Identity Groups.

Ajouter une appartenance avec expiration

Pour en savoir plus, consultez la page Gérer les appartenances Google Groupes pour les groupes Google ou la page Gérer les appartenances des groupes de mappage d'identité.

Mettre à jour la date d'expiration d'une appartenance

Pour mettre à jour la date d'expiration d'une appartenance, appelez groups.memberships.modifyMembershipRoles() avec l'ID du groupe parent, l'ID de l'appartenance, et une ressource UpdateMembershipRolesParams. Comme les membres peuvent avoir plusieurs MembershipRole dans un groupe, vous devez spécifier à quel rôle s'applique la date d'expiration. Actuellement, seul le rôle MEMBER peut se voir appliquer une date d'expiration.

Remarque : Pour obtenir l'ID de l'appartenance, appelez la méthode groups.memberships.lookup() avec l'ID du groupe parent et le memberKey du membre.

Exemple de corps de requête

{
  "updateRolesParams": [
    {
      "fieldMask": "expiry_detail.expire_time",
      "membershipRole": {
        "expiryDetail": {
          "expireTime": "2021-10-02T15:01:23Z"
        },
        "name": "MEMBER"
      }
    }
  ]
}

Récupérer une date d'expiration d'abonnement

Pour récupérer la date d'expiration d'une adhésion, appelez groups.memberships.get() avec l'ID du groupe parent et l'ID de l'adhésion.

Remarque : Pour obtenir l'ID de l'adhésion, appelez groups.memberships.lookup() avec l'ID du groupe parent et le memberKey du membre.

Notifications par e-mail

Les notifications par e-mail sont automatiquement envoyées à tous les propriétaires de groupe lorsque les adhésions sont sur le point d'expirer. Les notifications sont envoyées 72 heures avant l'expiration, ou immédiatement si l'appartenance est définie lors de sa configuration pour expirer d'ici moins de 72 heures. Les notifications sont envoyées dans la langue préférée de chaque propriétaire de groupe, telle qu'elle est définie par l'administrateur du domaine dans la console d'administration Google ou individuellement par le propriétaire du groupe.