Usługa zaawansowana Cloud Identity Groups (CIG) zapewnia funkcjonalność interfejsu Groups Service API i może być używana zamiast niego.
Zapoznaj się z udostępnionymi metodami pomocniczymi, aby dowiedzieć się, jak uzyskać równoważne możliwości za pomocą zaawansowanej usługi CIG.
Konfiguracja
Aby korzystać z zaawansowanej usługi CIG, najpierw włącz ją w projekcie skryptu.
Aby skrócić niektóre sygnatury metod w tym przewodniku, zdefiniowaliśmy tę zmienną:
const groups = CloudIdentityGroups.Groups;
Metody GroupsApp
Poniższe metody pomocnicze odpowiadają metodom usługi Groups Service GroupsApp.
W tym przewodniku termin grupa odnosi się do zasobu grupy, a nie do obiektu klasy grupy. Zasoby grupy to obiekty JavaScript, które nie mają metod, ale można ich używać w usłudze zaawansowanej CIG do pobierania informacji podobnych do tych w obiektach klasy grupy.
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
Poniższa metoda pomocnicza zwraca listę zasobów dotyczących członkostwa.
Otwórz pole group elementu, aby znaleźć jego identyfikator nazwy. Jest to przydatne w przypadku wielu metod zaawansowanej usługi CIG. Podobnie możesz uzyskać dostęp do groupKey.id elementu, aby znaleźć jego adres e-mail.
/**
* 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;
}
Metody grupowe
Poniższe metody pomocnicze odpowiadają metodom usługi 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
Poniższa metoda korzysta z funkcji Memberships.list, która pobiera wszystkie członkostwa w danej grupie. Może to obejmować członkostwo użytkowników i grup.
Aby lepiej przybliżyć działanie metody getGroups usługi Groups, możemy filtrować członkostwa według ich Type.
Dostęp do tego pola uzyskujemy, podając parametr zapytania FULL View w przypadku Memberships.list lub wykonując osobne żądanie Memberships.lookup w przypadku każdego członkostwa.
/**
* 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 i getRoles
Usługa Groups Service mogła zwrócić tylko rolę o najwyższym priorytecie w polu getRole(), ale pole roles w zasobie członkostwa zawiera oddzielny element dla każdej roli, do której kwalifikuje się członek (np. 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
Podobnie jak w przypadku funkcji getGroups możemy pobrać członkostwo w grupie za pomocą funkcji Memberships.list i odfiltrować wyniki, aby zachować tylko docelowy element 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 i hasUser
Zarówno usługa Groups Service hasGroup, jak i hasUser
potwierdzają, czy podmiot jest członkiem danej grupy. Zarówno grupa, jak i użytkownik mogą być reprezentowani przez adres e-mail, dlatego poniższa metoda może służyć do potwierdzania, czy dany element należy do określonej grupy.
/**
* 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;
}