그룹 서비스에서 Cloud ID 그룹 고급 서비스로 마이그레이션

Cloud Identity Groups (CIG) 고급 서비스는 Groups Service API와 동일한 기능을 제공하며 이를 대신 사용할 수 있습니다.

CIG 고급 서비스를 통해 이와 동등한 기능을 실행하는 방법을 알아보려면 제공된 도우미 메서드를 참고하세요.

설정

CIG 고급 서비스를 사용하려면 먼저 스크립트 프로젝트 내에서 사용 설정합니다.

이 가이드의 일부 메서드 서명을 줄이기 위해 다음 변수를 정의했습니다.

const groups = CloudIdentityGroups.Groups;

GroupsApp 메서드

다음 도우미 메서드는 그룹 서비스 GroupsApp의 메서드에 해당합니다.

이 가이드에서 그룹이라는 용어는 그룹 클래스 객체가 아닌 그룹 리소스를 의미합니다. 그룹 리소스는 메서드가 없는 JavaScript 객체이지만 CIG 고급 서비스에서 그룹 클래스 객체의 정보와 유사한 정보를 검색하는 데 사용할 수 있습니다.

getGroupByEmail

/**
 * Given a group's email, returns that group's resource
 *
 * @param {String} email: The email address to lookup a group by
 * @return {Group} group: The group resource associated with the email
 */
function groupsAppGetGroupByEmail(email) {
  // Retrieve the name ID of the group
  const groupName = groups.lookup({
    'groupKey.id': email,
    'groupKey.namespace': ''  // Optional for google groups, dynamic groups, and security groups
                              // Necessary for identity-mapped groups (see https://developers.google.com/cloud-search/docs/guides/identity-mapping)
  }).name;

  // Retrieve the group resource
  return groups.get(groupName);
}

getGroups

다음 도우미 메서드는 멤버십 리소스 목록을 반환합니다. 요소의 group 필드에 액세스하여 이름 ID를 찾습니다. 이는 CIG 고급 서비스의 여러 메서드에 유용합니다. 마찬가지로 요소의 groupKey.id에 액세스하여 이메일을 찾습니다.

/**
 * Retrieves all the membership relation resources to groups which you are a
 * direct member (or a pending member).
 *
 * @return {Array<MembershipRelation>} groups : List of direct memberships where
 * you are the member.
 */
function groupsAppGetGroups() {
  const myEmail = Session.getActiveUser().getEmail();
  let pageToken = '';
  let membershipList = [];

  do {
    const queryParams = {
      query:`member_key_id=='${myEmail}'`,
      pageToken:pageToken
    };
    const searchResult = groups.Memberships.searchDirectGroups('groups/-', queryParams);
    membershipList = membershipList.concat(searchResult.memberships);
    pageToken = searchResult.nextPageToken;
  } while (pageToken);

  return membershipList;
}

그룹 메서드

다음 도우미 메서드는 그룹 서비스 Groups Class의 메서드에 해당합니다.

getEmail

/**
 * Gets a group's email address
 *
 * @param {Object} group: A group resource
 * @return {String} email: The email associated with the group resource.
 */
function getEmail(group) {
  return group.groupKey.id;
}

getGroups

다음 메서드는 지정된 그룹의 모든 멤버십을 가져오는 Memberships.list를 사용합니다. 여기에는 사용자뿐만 아니라 그룹의 멤버십도 포함될 수 있습니다.

그룹 서비스 getGroups 메서드를 더 잘 근사화하려면 Type로 멤버십을 필터링할 수 있습니다. FULL View를 Memberships.list에 쿼리 매개변수로 제공하거나 각 멤버십에 대해 개별 Memberships.lookup를 실행하여 이 필드에 액세스합니다.

/**
 * Fetch a list of memberships with provided group as its parent
 *
 * @param {Group} group: A group resource
 * @return {Array<Membership>} membershipList: The memberships where the parent
 * is the provided group and member is a also a group.
 */
function getGroups(group) {
  let membershipList = [];
  let pageToken = '';

  do {
    // Fetch a page of memberships
    const queryParams = {
      view: 'FULL',
      pageToken: pageToken
    }
    const response = groups.Memberships.list(group.name, queryParams);

    // Filter non-group memberships
    const onlyGroupMemberships = response.memberships.filter(
      membership => membership.type == 'GROUP'
    );
    membershipList = membershipList.concat(onlyGroupMemberships);

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

  return membershipList;
}

getRole 및 getRoles

그룹 서비스는 getRole()에서 가장 높은 우선순위의 역할만 반환했을 수 있지만 멤버십 리소스의 roles 필드에는 회원이 자격을 갖춘 각 역할 (예: MEMBER, OWNER, ADMIN)에 관한 별도의 요소가 포함됩니다.

/**
 * Retrieve the membership roles of a member to a group.
 *
 * @param {Group} containingGroup: The group whom the member belongs to
 * @param {String} email: The email address associated with a member that
 * belongs to the containingGroup
 * @return {Array<Role>} roles: List of roles the member holds with respect to
 * the containingGroup.
 */
function getRoleWithEmail(containingGroup, email) {
  // First fetch the membership
  const membershipName = groups.Memberships.lookup(containingGroup.name, { 'memberKey.id': email }).name;
  const membership = groups.Memberships.get(membershipName);

  // Then retrieve the role
  return membership.roles;
}

/**
 * Retrieve the membership roles of a member to a group.
 *
 * @param {Group} containingGroup: The group resource whom the member belongs to
 * @param {User} user: The user associated with a member that belongs to the
 * containingGroup
 * @return {Array<Role>} roles: List of roles the member holds with respect to
 * the containingGroup
 */
function getRoleWithUser(containingGroup, user) {
  return getRoleWithEmail(containingGroup, user.getEmail());
}

/**
 * Retrieve the membership roles of a group of members to a group
 *
 * @param {Group} containingGroup: The group resource to which roles are
 * relevant
 * @param {Array<User>} users: List of users to fetch roles from
 * @return {Array<Array<Role>>} roles: A list where every element is a list of
 * roles of member to the containingGroup
 */
function getRoles(containingGroup, users) {
  let roles = [];
  for (const user of users) {
    roles.push(getRoleWithUser(containingGroup, user));
  }
  return roles;
}

getUsers

getGroups의 접근 방식과 마찬가지로 Memberships.list를 사용하여 그룹의 멤버십을 가져오고 결과를 필터링하여 타겟 Type만 유지할 수 있습니다.

/**
 * Given a group, retrieve its direct members and banned members of the group
 * that have a known corresponding Google Account.
 *
 * @param {Group} group: The group Resource whom the users being queried belong
 * to
 * @return {Array<String>} users: A list of emails associated with members of
 * the given group
 */
function getUsers(group) {
  let userList = [];
  let pageToken = '';

  do {
    // Fetch a page of memberships from the group
    const queryParams = {
      view: 'FULL',
      pageToken: pageToken
    }
    const listResponse = groups.Memberships.list(group.name, queryParams);

    // Filter non-users and keep member emails
    const users = listResponse.memberships
      .filter(membership => membership.type == 'USER')
      .map(membership => membership.preferredMemberKey.id);
    userList = userList.concat(users);

    // Prepare next page
    pageToken = listResponse.nextPageToken;
  } while (pageToken);

  return userList;
}

hasGroup 및 hasUser

그룹 서비스 hasGroup와 hasUser는 모두 항목이 특정 그룹의 구성원인지 확인합니다. 그룹과 사용자가 모두 이메일 주소로 표현될 수 있으므로 다음 메서드를 사용하여 둘 중 하나가 특정 그룹에 속하는지 확인할 수 있습니다.

/**
 * Tests if the given email has an associated direct member to the given group.
 *
 * @param {Group} group: Group resource to which the entity is being checked as
 * a member
 * @param {String} email: Email that can represent a Group or User entity
 * @return {Boolean} isMember: Whether the entity is a direct member to the
 * group or not
 */
function checkDirectGroupMembership(group, email) {
  try {
    groups.Memberships.lookup(group.name, {'memberKey.id': email});

  } catch(e) {
    // Log failure if exception is not related to membership existence
    if (!e.message.includes('Membership does not exist.')) {
      console.error(e);
    }
    return false;
  }
  return true;
}