Class: Google::Apps::Chat::V1::DeleteMembershipRequest

Inherits:

Object

Object
Google::Apps::Chat::V1::DeleteMembershipRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/chat/v1/membership.rb

Overview

Request to delete a membership in a space.

Instance Attribute Summary collapse

#name ⇒ ::String
Required.
#use_admin_access ⇒ ::Boolean
Optional.

Instance Attribute Details

#name ⇒ `::String`

Returns Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[email protected] where [email protected] is the email of the Google Chat user.

When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app.

Returns:

(::String) —
Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[email protected] where [email protected] is the email of the Google Chat user.

When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app.

# File 'proto_docs/google/chat/v1/membership.rb', line 381

class DeleteMembershipRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_admin_access ⇒ `::Boolean`

Returns Optional. When true, the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

Requires the chat.admin.memberships OAuth 2.0 scope.

Deleting app memberships in a space isn't supported using admin access.