Resource: Membership
Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.
JSON representation |
---|
{ "name": string, "state": enum ( |
Fields | |
---|---|
name |
Resource name of the membership, assigned by the server. Format: |
state |
Output only. State of the membership. |
role |
Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in |
createTime |
Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. |
deleteTime |
Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. |
Union field memberType . Member associated with this membership. Other member types might be supported in the future. memberType can be only one of the following: |
|
member |
The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user, the output populates the user |
groupMember |
The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication. |
MembershipState
Specifies the member's relationship with a space. Other membership states might be supported in the future.
Enums | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Default value. Don't use. |
JOINED |
The user is added to the space, and can participate in the space. |
INVITED |
The user is invited to join the space, but hasn't joined it. |
NOT_A_MEMBER |
The user doesn't belong to the space and doesn't have a pending invitation to join the space. |
MembershipRole
Represents a user's permitted actions in a Chat space. More enum values might be added in the future.
Enums | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Default value. For users : they aren't a member of the space, but can be invited. For Google Groups : they're always assigned this role (other enum values might be used in the future). |
ROLE_MEMBER |
A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role. |
ROLE_MANAGER |
A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE . |
Group
A Google Group in Google Chat.
JSON representation |
---|
{ "name": string } |
Fields | |
---|---|
name |
Resource name for a Google Group. Represents a group in Cloud Identity Groups API. Format: groups/{group} |
Methods |
|
---|---|
|
Creates a membership for the calling Chat app, a user, or a Google Group. |
|
Deletes a membership. |
|
Returns details about a membership. |
|
Lists memberships in a space. |
|
Updates a membership. |