REST Resource: spaces.members

Ressource : Membership

Représente une relation d'appartenance dans Google Chat, par exemple si un utilisateur ou une application Chat est invité à un espace, en fait partie ou en est absent.

Représentation JSON
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Champs
name

string

Identifiant. Nom de ressource de l'abonnement, attribué par le serveur.

Format : spaces/{space}/members/{member}

state

enum (MembershipState)

Uniquement en sortie. État de l'abonnement.

role

enum (MembershipRole)

Facultatif. Rôle de l'utilisateur dans un espace Chat, qui détermine les actions qu'il est autorisé à effectuer dans l'espace.

Ce champ ne peut être utilisé comme entrée que dans members.patch.

createTime

string (Timestamp format)

Facultatif. Immuable. Heure de création de l'abonnement, par exemple lorsqu'un membre a rejoint un espace ou y a été invité. Ce champ est en lecture seule, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.

deleteTime

string (Timestamp format)

Facultatif. Immuable. Heure de suppression de l'appartenance, par exemple lorsqu'un membre a quitté un espace ou en a été exclu. Ce champ est en lecture seule, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.

affiliation

enum (Affiliation)

Uniquement en sortie. Relation d'un utilisateur avec l'organisation Workspace propriétaire de l'espace. Dans les espaces appartenant à des comptes personnels, l'affiliation de tous les membres est EXTERNAL.

Membre associé à cet abonnement. D'autres types de membres pourront être acceptés à l'avenir. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
member

object (User)

Facultatif. Utilisateur ou application Google Chat auxquels correspond l'abonnement. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie ne renseigne que les champs user name et type pour les utilisateurs internes et externes, sauf s'ils sont membres de l'espace ou s'ils ont une affinité préalable, comme une conversation par message privé (MP), avec l'utilisateur appelant.

groupMember

object (Group)

Facultatif. Groupe Google auquel l'adhésion correspond.

La lecture ou la modification des appartenances à des groupes Google nécessite une authentification de l'utilisateur.

Fin des champs qui s'excluent mutuellement.

MembershipState

Spécifie la relation du membre avec un espace. D'autres états de membre pourront être pris en charge à l'avenir.

Enums
MEMBERSHIP_STATE_UNSPECIFIED Valeur par défaut. Ne pas utiliser.
JOINED L'utilisateur est ajouté à l'espace et peut y participer.
INVITED L'utilisateur est invité à rejoindre l'espace, mais ne l'a pas encore fait.
NOT_A_MEMBER L'utilisateur n'appartient pas à l'espace et n'a pas d'invitation en attente pour le rejoindre.

MembershipRole

Représente les actions autorisées d'un utilisateur dans un espace Chat. D'autres valeurs d'énumération pourront être ajoutées à l'avenir.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Valeur par défaut. Pour users : la personne n'est pas membre de l'espace, mais peut être invitée. Pour Google Groups : ce rôle leur est toujours attribué (d'autres valeurs d'énumération pourront être utilisées à l'avenir).
ROLE_MEMBER

Membre de l'espace. Dans l'interface utilisateur de Chat, ce rôle est appelé "Membre".

L'utilisateur dispose d'autorisations de base, comme celle d'envoyer des messages dans l'espace. Les gestionnaires et les propriétaires peuvent accorder des autorisations supplémentaires aux membres d'un espace, y compris :

  • Ajoutez ou supprimez des membres.
  • modifier les détails de l'espace ;
  • Activez ou désactivez l'historique.
  • Mentionnez tous les membres de l'espace avec @all.
  • Gérez les applications et les webhooks Chat installés dans l'espace.

Dans les messages privés et les conversations de groupe sans nom, tout le monde dispose de ce rôle.

ROLE_MANAGER

Propriétaire d'un espace Dans l'interface utilisateur de chat, ce rôle est appelé "Propriétaire".

L'utilisateur dispose de l'ensemble des autorisations pour gérer l'espace, y compris :

  • Attribuer le rôle de membre, d'administrateur ou de propriétaire à d'autres membres de l'espace
  • supprimer l'espace.

Compatible uniquement avec SpaceType.SPACE (espaces nommés).

Pour en savoir plus, consultez En savoir plus sur votre rôle de propriétaire ou de gestionnaire d'un espace.

ROLE_ASSISTANT_MANAGER

un gestionnaire de l'espace ; Dans l'interface utilisateur de chat, ce rôle est appelé "Responsable".

L'utilisateur dispose de toutes les autorisations de base de ROLE_MEMBER et un propriétaire peut lui accorder un sous-ensemble d'autorisations d'administrateur. Par défaut, les gestionnaires disposent de toutes les autorisations d'un propriétaire, à l'exception des suivantes :

  • supprimer l'espace.
  • Désignez un autre membre de l'espace comme propriétaire.
  • Modifier le rôle d'un propriétaire

Par défaut, les autorisations des administrateurs incluent, sans s'y limiter :

  • Désignez un autre membre comme gestionnaire.
  • supprimer des messages dans l'espace ;
  • gérer les autorisations de l'espace ;
  • Recevoir des notifications pour les demandes d'adhésion à l'espace si le gestionnaire dispose de l'autorisation "Gérer les membres" dans les paramètres de l'espace.
  • Rendez un espace visible.

Compatible uniquement avec SpaceType.SPACE (espaces nommés).

Pour en savoir plus, consultez Gérer les paramètres d'un espace.

Groupe

Un groupe Google dans Google Chat.

Représentation JSON
{
  "name": string
}
Champs
name

string

Nom de ressource pour un groupe Google.

Représente un groupe dans l'API Cloud Identity Groups.

Format : groups/{group}

Affiliation

Représente l'affiliation d'un utilisateur à l'organisation Google Workspace propriétaire de l'espace. D'autres valeurs pourront être ajoutées à cet enum à l'avenir.

Enums
AFFILIATION_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
INTERNAL Un compte géré par la même organisation Google Workspace que celle qui possède l'espace.
EXTERNAL Un compte externe à l'organisation Google Workspace propriétaire de l'espace (par exemple, un compte personnel ou un compte géré par une autre organisation Workspace).
MANAGED_EXTERNAL Compte géré par l'organisation Workspace propriétaire de l'espace, mais provisionné pour un utilisateur externe à l'organisation (par exemple, un utilisateur invité). Pour en savoir plus sur les invités, consultez https://support.google.com/chat/answer/16997417.

Méthodes

create

Crée un abonnement pour l'application Chat appelante, un utilisateur ou un groupe Google.

delete

Supprime un abonnement.

get

Renvoie des informations sur un abonnement.

list

Répertorie les appartenances dans un espace.

patch

Met à jour une appartenance.