Groups सेवा से Cloud Identity Groups की बेहतर सेवा पर माइग्रेट करना

Cloud Identity Groups (CIG) की ऐडवांस सेवा, Groups Service API के बराबर सुविधाएं देती है. इसका इस्तेमाल, Groups Service API की जगह किया जा सकता है.

CIG Advanced Service के ज़रिए, मिलती-जुलती सुविधाएं पाने का तरीका जानने के लिए, दिए गए हेल्पर तरीके देखें.

सेटअप

CIG की ऐडवांस सेवा का इस्तेमाल करने के लिए, सबसे पहले इसे अपने स्क्रिप्ट प्रोजेक्ट में चालू करें.

इस गाइड में, कुछ तरीके के सिग्नेचर को छोटा करने के लिए, हमने यहां दिया गया वैरिएबल तय किया है:

const groups = CloudIdentityGroups.Groups;

GroupsApp के तरीके

यहां दी गई हेल्पर विधियां, Groups Service GroupsApp की विधियों से मिलती-जुलती हैं.

इस गाइड में, ग्रुप शब्द का मतलब ग्रुप रिसॉर्स से है. इसका मतलब ग्रुप क्लास ऑब्जेक्ट से नहीं है. ग्रुप रिसॉर्स ऐसे JavaScript ऑब्जेक्ट होते हैं जिनमें कोई तरीका नहीं होता. हालांकि, इनका इस्तेमाल CIG Advanced Service में किया जा सकता है. इससे ग्रुप क्लास ऑब्जेक्ट में मौजूद जानकारी जैसी जानकारी वापस पाई जा सकती है.

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 फ़ील्ड को ऐक्सेस करें. यह 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 Service 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 का इस्तेमाल किया जाता है. इससे दिए गए ग्रुप की हर सदस्यता मिल जाएगी. इसमें उपयोगकर्ताओं के साथ-साथ ग्रुप की सदस्यताएं भी शामिल हो सकती हैं.

Groups Service 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

Groups Service, getRole() में सिर्फ़ सबसे ज़्यादा प्राथमिकता वाली भूमिका दिखा सकती है. हालांकि, सदस्यता संसाधन में मौजूद roles फ़ील्ड में, सदस्य की हर भूमिका के लिए एक अलग एलिमेंट होता है. उदाहरण के लिए: सदस्य, मालिक, एडमिन.

/**
 * 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

Groups Service 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;
}