Method: spaces.members.delete | Google Chat | Google for Developers (original) (raw)
Deletes a specified membership from a Google Chat space, allowing removal of human users or Chat apps.
Requires specific OAuth scopes depending on the type of membership being deleted and whether admin privileges are used.
Supports app and user authentication, with an option for administrator approval in Developer Preview for app authentication.
Uses a
DELETErequest with the membership's resource name specified in the path.Provides an optional
useAdminAccessquery parameter to utilize administrator privileges when deleting human memberships.
Deletes a membership. For an example, see Remove a user or a Google Chat app from a space.
Supports the following types of authentication:
- App authentication with administrator approval and the authorization scope:
https://www.googleapis.com/auth/chat.app.memberships
- User authentication with one of the following authorization scopes:
https://www.googleapis.com/auth/chat.membershipshttps://www.googleapis.com/auth/chat.memberships.app(to remove the calling app from the space)https://www.googleapis.com/auth/chat.import(import mode spaces only)- User authentication grants administrator privileges when an administrator account authenticates,
useAdminAccessistrue, and the following authorization scope is used:
*https://www.googleapis.com/auth/chat.admin.memberships
App authentication is not supported for the following use cases:
- Removing a Google Group from a space.
- Removing a Chat app from a space.
To delete memberships for space managers, the requester must be a space manager. If you're using app authentication the Chat app must be the space creator.
HTTP request
DELETE https://chat.googleapis.com/v1/{name=spaces/*/members/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
| name | 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 with user authentication or the chat.memberships.app scope with app authentication and the spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com 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. |
Query parameters
| Parameters | |
|---|---|
| useAdminAccess | boolean 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. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of [Membership](/workspace/chat/api/reference/rest/v1/spaces.members#Membership).
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.app.membershipshttps://www.googleapis.com/auth/chat.admin.membershipshttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.membershipshttps://www.googleapis.com/auth/chat.memberships.app
For more information, see the Authorization guide.