Groups - List Group Members

Reference

Service:: Groups

API Version:: 240412

Lists all members for a group

POST https://titleId.playfabapi.com/Group/ListGroupMembers

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Group	True	EntityKey	ID of the group to list the members and roles for
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	ListGroupMembersResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityMemberRole
EntityWithLineage	Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.
ListGroupMembersRequest	Gets a list of members and the roles they belong to within the group. If the caller does not have permission to view the role, and the member is in no other role, the member is not displayed. Returns a list of entities that are members of the group.
ListGroupMembersResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityMemberRole

Name	Type	Description
Members	EntityWithLineage[]	The list of members in the role
RoleId	string	The ID of the role.
RoleName	string	The name of the role

EntityWithLineage

Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.

Name	Type	Description
Key	EntityKey	The entity key for the specified entity
Lineage	EntityKey	Dictionary of entity keys for related entities. Dictionary key is entity type.

ListGroupMembersRequest

Gets a list of members and the roles they belong to within the group. If the caller does not have permission to view the role, and the member is in no other role, the member is not displayed. Returns a list of entities that are members of the group.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group	EntityKey	ID of the group to list the members and roles for

ListGroupMembersResponse

Name	Type	Description
Members	EntityMemberRole[]	The requested list of roles and member entity IDs.