Удаление участника из пространства

В этом руководстве объясняется, как использовать метод delete() ресурса Membership API Google Chat для удаления участников из пространства, что также называется удалением членства. Менеджера пространства нельзя удалить, если он единственный менеджер пространства в пространстве. Прежде чем удалять это членство, назначьте другого пользователя менеджером пространства.

Если вы администратор Google Workspace, вы можете удалять пользователей, группы Google или приложения чата из любого места в вашей организации Google Workspace.

Ресурс Membership указывает, приглашен ли пользователь или приложение Google Chat в пространство, участвует в нем или отсутствует в нем.

Предварительные условия

Node.js

Удаление участника из пространства в качестве пользователя

Чтобы удалить пользователя, группу Google или приложение чата из пространства с аутентификацией пользователя , передайте в своем запросе следующее:

  • Укажите область авторизации chat.memberships . Авторизующий пользователь должен иметь разрешение на удаление пользователя или группы Google из пространства. Чтобы удалить приложение Chat, укажите область авторизации chat.memberships.app (приложения могут удалять только свое собственное членство, но не членство других приложений). Рекомендуется выбирать наиболее ограничительную область, которая по-прежнему позволяет вашему приложению функционировать.
  • Вызовите метод DeleteMembership() .
  • Передайте name членства, которое требуется удалить. Если членство принадлежит единственному менеджеру пространства в пространстве, назначьте другого пользователя менеджером пространства, прежде чем удалять это членство.

Вот как удалить членство с аутентификацией пользователя :

Node.js

чат/клиент-библиотеки/облако/delete-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.delete'];

// This sample shows how to delete a space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME'
  };

  // Make the request
  const response = await chatClient.deleteSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Чтобы запустить этот пример, замените следующее:

  • SPACE_NAME : идентификатор из name пространства. Вы можете получить идентификатор, вызвав метод ListSpaces() или по URL-адресу пространства.
  • MEMBER_NAME : идентификатор из name участника. Вы можете получить идентификатор, вызвав метод ListMemberships() .

В случае успеха тело ответа возвращает членство со значением 'state': 'NOT_A_MEMBER' , указывая, что члена больше нет в пространстве.

{
    "name": "spaces/SPACE_NAME/members/MEMBER_NAME",
    "state": "NOT_A_MEMBER"
}

Удаление участника из пространства в качестве приложения Chat

Для аутентификации приложения требуется однократное одобрение администратора .

Чтобы удалить пользователя, группу Google или приложение чата из пространства с аутентификацией приложения , передайте в своем запросе следующее:

  • Укажите область авторизации chat.app.memberships . Удаление членства менеджера пространства поддерживается только в пространствах, созданных приложениями Chat.
  • Вызовите метод delete ресурса membership .
  • Передайте name членства, которое требуется удалить. Если членство принадлежит единственному менеджеру пространства в пространстве, назначьте другого пользователя менеджером пространства, прежде чем удалять это членство.

Создайте ключ API

Чтобы вызвать метод API Developer Preview, необходимо использовать закрытую предварительную версию документа обнаружения API для разработчиков. Для аутентификации запроса необходимо передать ключ API.

Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:

  1. В консоли Google Cloud выберите > API и службы > Учетные данные .

    Перейти к учетным данным

  2. Нажмите Создать учетные данные > Ключ API .
  3. Отобразится ваш новый ключ API.
    • Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
    • Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .

Напишите скрипт, вызывающий Chat API.

Вот как удалить членство с аутентификацией приложения :

Питон

  1. В своем рабочем каталоге создайте файл с chat_membership_delete_app.py .

  2. Включите следующий код в chat_membership_delete_app.py :

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then deletes the specified membership.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().delete(

        # The membership to delete.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBER with a membership name.
        # Obtain the membership name from the memberships resource of
        # Chat API. To delete a Chat app's membership, replace MEMBER
        # with app; an alias for the app calling the API.
        name='spaces/SPACE/members/MEMBER'

    ).execute()

    # Print Chat API's response in your command line interface.
    # When deleting a membership, the response body is empty.
    print(result)

if __name__ == '__main__':
    main()

  3. В коде замените следующее:

    • API_KEY : ключ API, который вы создали для создания конечной точки службы для Chat API.

    • SPACE : имя пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

    • MEMBER : имя участника, которое можно получить с помощью метода spaces.members.list в Chat API. Чтобы удалить членство в приложении, замените MEMBER на app .

  4. В своем рабочем каталоге соберите и запустите пример:

    python3 chat_membership_delete_app.py

В случае успеха тело ответа возвращает членство со значением 'state': 'NOT_A_MEMBER' , указывая, что члена больше нет в пространстве.

{
    "name": "spaces/SPACE/members/MEMBER",
    "state": "NOT_A_MEMBER"
}

Ограничения и соображения

Удаление пользователей или групп Google из пространства в качестве администратора Google Workspace.

Если вы администратор Google Workspace, вы можете вызвать метод DeleteMembership() чтобы удалить пользователей, группы Google или приложения чата из любого места в вашей организации Google Workspace.

Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:

Дополнительную информацию и примеры см. в разделе «Управление пространствами Google Chat от имени администратора Google Workspace» .