Служба расширенных групп Cloud Identity

Расширенная служба Cloud Identity Groups (CIG) позволяет использовать API CIG в Apps Script.

Ссылка

Подробную информацию об этом сервисе см. в справочной документации по API CIG. Как и все расширенные сервисы в Apps Script, расширенный сервис CIG использует те же объекты, методы и параметры, что и общедоступный API. Подробнее см. в разделе «Как определяются сигнатуры методов» .

Пример кода

Следующие вспомогательные функции используют версию v1 API.

Создать группу

Чтобы создать Google Group, вызовите groups.create с экземпляром ресурса новой группы. Экземпляр группы должен включать groupKey , parent и label со значением cloudidentity.googleapis.com/groups.discussion_forum . Также необходимо задать параметр initialGroupConfig , который определяет первоначального владельца группы. Для этого параметра можно использовать следующие значения:

WITH_INITIAL_OWNER : Делает человека, отправившего запрос, владельцем группы.

EMPTY : создаёт группу без первоначальных владельцев. Вы можете использовать это значение, только если вы являетесь суперадминистратором Google Workspace или администратором групп. Подробнее о ролях Google Workspace см. в разделе «Предустановленные роли администраторов».

В следующем примере показано, как создать группу, владельцем которой станет пользователь:

const groups = CloudIdentityGroups.Groups;

function createGroup(groupId, parentId, displayName) {
  const groupKey = { id: groupId };
  const group = {
    parent: "customerId/" + parentId,
    displayName: displayName,
    groupKey: groupKey,
    // Set the label to specify creation of a Google Group.
    labels: { "cloudidentity.googleapis.com/groups.discussion_forum": "" },
  };
  const optionalArgs = { initialGroupConfig: "WITH_INITIAL_OWNER" };

  try {
    const response = groups.create(group, optionalArgs);
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

Поиск группы

Чтобы найти группу Google, вызовите groups.search со строкой запроса. Для поиска по всем группам укажите label cloudidentity.googleapis.com/groups.discussion_forum .

const groups = CloudIdentityGroups.Groups;

function searchGroup(customer_id) {
  const search_query = `parent=='customerId/${customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`;
  const search_group_request = groups.search({ query: search_query });
  console.log(JSON.stringify(search_group_request));
}

Добавить членство в группу

После того, как группа создана, вы можете создать для неё членство. Для этого метода требуется ресурс membership и строка name родительского ресурса. Первое значение можно получить, выполнив поиск группы с помощью метода lookup .

Следующий вспомогательный метод демонстрирует пример добавления членства в группу. expiryDetail — необязательное поле, которое можно добавить для установки срока действия членства. Значение preferredMemberKey — адрес электронной почты участника.

const groups = CloudIdentityGroups.Groups;

function createMembership(namespace, groupId, memberKey) {
  try {
    // Given a group ID and namespace, retrieve the ID for parent group
    const groupLookupResponse = groups.lookup({
      'groupKey.id': groupId,
      'groupKey.namespace': namespace
    });
    const groupName = groupLookupResponse.name;

    // Create a membership object with a memberKey and a single role of type MEMBER
    const membership = {
      preferredMemberKey: { id: memberKey },
      roles: [
        {
          name: "MEMBER",
          expiryDetail: {
            expireTime: "2025-10-02T15:01:23Z",
          },
        },
      ],
    };

    // Create a membership using the ID for the parent group and a membership object
    const response = groups.Memberships.create(membership, groupName);
    console.log(JSON.stringify(response));
  } catch (e) {
    console.error(e);
  }
}

Получить членство от участника

Используйте метод groups.memberships.searchDirectGroups для поиска непосредственных родителей участника.

Следующий вспомогательный метод показывает пример итерации по прямому членству заданного члена.

const groups = CloudIdentityGroups.Groups;

 function searchMemberMemberships(memberId, pageSize) {
  try {
    let memberships = [];
    let nextPageToken = '';
    const withinParent = 'groups/-';  // This parameter sets the scope as "all groups"

    do {
      // Get page of memberships
      const queryParams = {
        query: `member_key_id == \'${memberId}\'`,
        page_size: pageSize,
        page_token: nextPageToken,
      };
      const response = groups.Memberships.searchDirectGroups(withinParent, queryParams);
      memberships = memberships.concat(response.memberships);

      // Set up next page
      nextPageToken = response.nextPageToken;
    } while (nextPageToken);

    return memberships;
  } catch(e) {
    console.error(e);
  }
}

Получить членство в группе

Для вывода списка участников группы используйте метод groups.memberships.list .

groupId : числовой идентификатор группы, участников которой вы хотите получить. Чтобы найти идентификатор отдельной группы, используйте метод groups.lookup . Чтобы просмотреть все идентификаторы групп для клиента или пространства имён, используйте метод groups.list .

const groups = CloudIdentityGroups.Groups;

function listGroupMemberships(groupId, pageSize) {
  try {
    let membershipList = [];
    let nextPageToken = '';

    // Get group name
    const groupName = groups.lookup({'groupKey.id': groupId}).name;

    do {
      // Get page of memberships
      const queryParams = {
        pageSize: pageSize,
        pageToken: nextPageToken
      }
      const response = groups.Memberships.list(groupName, queryParams);
      membershipList = membershipList.concat(response.memberships);

      // Set up next page
      nextPageToken = response.nextPageToken;
    } while(nextPageToken);

    return membershipList;
  } catch (error) {
    console.error(error);
  }
}