REST Resource: spaces.members

Recurso: Membresía

Representa una relación de membresía en Google Chat, por ejemplo, si se invita a un usuario o a una app de Chat a un espacio, si forma parte de él o si está ausente.

Representación JSON 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Campos
name

string

Es el identificador. Es el nombre del recurso de la membresía, asignado por el servidor.

Formato: spaces/{space}/members/{member}
state

enum (MembershipState)

Solo salida. Estado de la membresía.
role

enum (MembershipRole)

Es opcional. Es el rol del usuario en un espacio de Chat, que determina las acciones permitidas en el espacio.

Este campo solo se puede usar como entrada en members.patch.
createTime

string (Timestamp format)

Es opcional. Inmutable. Es la hora de creación de la membresía, por ejemplo, cuando un miembro se unió a un espacio o se lo invitó a unirse. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios de modo de importación.
deleteTime

string (Timestamp format)

Es opcional. Inmutable. Es la hora de eliminación de la membresía, por ejemplo, cuando un miembro abandonó un espacio o se lo quitó. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios de modo de importación.
affiliation

enum (Affiliation)

Solo salida. Es la relación de un usuario con la organización de Workspace que es propietaria del espacio. En los espacios que son propiedad de cuentas personales, la afiliación de todos los miembros es EXTERNAL.
Campo de unión memberType. Miembro asociado con esta membresía. Es posible que se admitan otros tipos de miembros en el futuro. memberType puede ser solo uno de los parámetros siguientes:
member

object (User)

Es opcional. Es el usuario o la app de Google Chat a la que corresponde la membresía. Si tu app de Chat se autentica como usuario, el resultado propagará el usuario name y type.
groupMember

object (Group)

Es opcional. Es el Grupo de Google al que corresponde la membresía.

Para leer o mutar membresías de Grupos de Google, se requiere la autenticación del usuario.

MembershipState

Especifica la relación del miembro con un espacio. Es posible que se admitan otros estados de membresía en el futuro.

Enums
MEMBERSHIP_STATE_UNSPECIFIED Valor predeterminado. No lo uses.
JOINED El usuario se agrega al espacio y puede participar en él.
INVITED Se invita al usuario a unirse al espacio, pero aún no lo ha hecho.
NOT_A_MEMBER El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse.

MembershipRole

Representa las acciones permitidas de un usuario en un espacio de Chat. Es posible que se agreguen más valores de enum en el futuro.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Valor predeterminado. Para users: No son miembros del espacio, pero se los puede invitar. Para Google Groups: Siempre se les asigna este rol (es posible que se usen otros valores de enum en el futuro).
ROLE_MEMBER

Un miembro del espacio. En la IU de Chat, este rol se llama Miembro.

El usuario tiene permisos básicos, como enviar mensajes al espacio. Los administradores y propietarios pueden otorgar permisos adicionales a los miembros en un espacio, incluidos los siguientes:

  • Agregar o quitar miembros
  • Modificar los detalles del espacio
  • Activar o desactivar el historial
  • Mencionar a todos en el espacio con @all
  • Administrar las apps y los webhooks de Chat instalados en el espacio

En los mensajes directos y las conversaciones grupales sin nombre, todos tienen este rol.
ROLE_MANAGER

Un propietario del espacio. En la IU de Chat, este rol se llama Propietario.

El usuario tiene el conjunto completo de permisos del espacio para administrarlo, incluidos los siguientes:

  • Cambiar el rol de otros miembros del espacio a miembro, administrador o propietario
  • Borrar el espacio

Solo se admite en SpaceType.SPACE (espacios con nombre).

Para obtener más información, consulta Obtén información sobre tu rol como propietario o administrador de un espacio.
ROLE_ASSISTANT_MANAGER

Un administrador del espacio. En la IU de Chat, este rol se llama Administrador.

El usuario tiene todos los permisos básicos de ROLE_MEMBER y un propietario puede otorgarle un subconjunto de permisos administrativos. De forma predeterminada, los administradores tienen todos los permisos de un propietario, excepto la capacidad de hacer lo siguiente:

  • Borrar el espacio
  • Convertir a otro miembro del espacio en propietario
  • Cambiar el rol de un propietario

De forma predeterminada, los permisos de los administradores incluyen, entre otros, los siguientes:

  • Convertir a otro miembro en administrador
  • Borrar mensajes del espacio
  • Administrar permisos del espacio
  • Recibir notificaciones de solicitudes para unirse al espacio si el administrador tiene el permiso "administrar miembros" en la configuración del espacio
  • Hacer que un espacio sea detectable

Solo se admite en SpaceType.SPACE (espacios con nombre).

Para obtener más información, consulta Administra la configuración del espacio.

Grupo

Un Grupo de Google en Google Chat.

Representación JSON 
{
  "name": string
}
Campos
name

string

Nombre del recurso de un Grupo de Google.

Representa un grupo en la API de Groups de Cloud Identity.

Formato: groups/{group}

Affiliation

Representa la afiliación de un usuario a la organización de Google Workspace que es propietaria del espacio. Es posible que se agreguen más valores a este enum en el futuro.

Enums
AFFILIATION_UNSPECIFIED Valor predeterminado Este valor no se usa.
INTERNAL Una cuenta administrada por la misma organización de Google Workspace que es propietaria del espacio.
EXTERNAL Una cuenta externa a la organización de Google Workspace que es propietaria del espacio (p.ej., una cuenta personal o una cuenta administrada por una organización de Workspace diferente).
MANAGED_EXTERNAL Una cuenta administrada por la organización de Workspace que es propietaria del espacio, pero aprovisionada para un usuario externo a la organización (p.ej., un usuario invitado). Para obtener más información sobre los invitados, consulta https://support.google.com/chat/answer/16997417.

Métodos

create

 Crea una membresía para la app de Chat que realiza la llamada, un usuario o un Grupo de Google.

delete

 Borra una membresía.

get

 Muestra detalles sobre una membresía.

list

 Muestra una lista de las membresías en un espacio.

patch

 Actualiza una membresía.