Skip to main content
Lists all groups and roles for an entity

Syntax

Parameters

entityHandle   PFEntityHandle PFEntityHandle to use for authentication. request   PFGroupsListMembershipRequest* Populated request object. async   XAsyncBlock*
Inout
XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on all platforms. Lists the groups and roles that an entity is a part of, checking to see if group and role metadata and memberships should be visible to the caller. If the entity is not in any roles that are visible to the caller, the group is not returned in the results, even if the caller otherwise has permission to see that the entity is a member of that group. See also GroupListGroupMembersAsync, GroupListMembershipOpportunitiesAsync. When the asynchronous task is complete, call PFGroupsListMembershipGetResultSize and PFGroupsListMembershipGetResult to get the result.

Requirements

Header: PFGroups.h

See also

PFGroups members
Last modified on August 1, 2026