GroupsMemberships
class GroupsMemberships extends Resource (View source)
The "memberships" collection of methods.
Typical usage is:
$cloudidentityService = new Google\Service\CloudIdentity(...);
$memberships = $cloudidentityService->groups_memberships;
Methods
Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group. (memberships.checkTransitiveMembership)
Creates a Membership
. (memberships.create)
Retrieves a Membership
. (memberships.get)
Get a membership graph of just a member or both a member and a group.
Lists the Membership
s within a Group
. (memberships.listGroupsMemberships)
Looks up the resource
name of a Membership
by its EntityKey
. (memberships.lookup)
Modifies the MembershipRole
s of a Membership
.
Searches direct groups of a member. (memberships.searchDirectGroups)
Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups. (memberships.searchTransitiveGroups)
Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships. (memberships.searchTransitiveMemberships)
Details
CheckTransitiveMembershipResponse
checkTransitiveMembership(string $parent, array $optParams = [])
Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group. (memberships.checkTransitiveMembership)
Operation
create(string $parent, Membership $postBody, array $optParams = [])
Creates a Membership
. (memberships.create)
Operation
delete(string $name, array $optParams = [])
Deletes a Membership
. (memberships.delete)
Membership
get(string $name, array $optParams = [])
Retrieves a Membership
. (memberships.get)
Operation
getMembershipGraph(string $parent, array $optParams = [])
Get a membership graph of just a member or both a member and a group.
Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member. (memberships.getMembershipGraph)
ListMembershipsResponse
listGroupsMemberships(string $parent, array $optParams = [])
Lists the Membership
s within a Group
. (memberships.listGroupsMemberships)
LookupMembershipNameResponse
lookup(string $parent, array $optParams = [])
Looks up the resource
name of a Membership
by its EntityKey
. (memberships.lookup)
ModifyMembershipRolesResponse
modifyMembershipRoles(string $name, ModifyMembershipRolesRequest $postBody, array $optParams = [])
Modifies the MembershipRole
s of a Membership
.
(memberships.modifyMembershipRoles)
SearchDirectGroupsResponse
searchDirectGroups(string $parent, array $optParams = [])
Searches direct groups of a member. (memberships.searchDirectGroups)
SearchTransitiveGroupsResponse
searchTransitiveGroups(string $parent, array $optParams = [])
Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups. (memberships.searchTransitiveGroups)
SearchTransitiveMembershipsResponse
searchTransitiveMemberships(string $parent, array $optParams = [])
Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships. (memberships.searchTransitiveMemberships)