Groups - List Membership

Lists all groups and roles for an entity

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

Request Body

Name Type Description
Entity

The entity to perform this action on.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

EntityToken

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

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

GroupRole

Describes a group role

GroupWithRoles

Describes a group and the roles that it contains

ListMembershipRequest

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.

ListMembershipResponse

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

GroupRole

Describes a group role

Name Type Description
RoleId
  • string

ID for the role

RoleName
  • string

The name of the role

GroupWithRoles

Describes a group and the roles that it contains

Name Type Description
Group

ID for the group

GroupName
  • string

The name of the group

ProfileVersion
  • number

The current version of the profile, can be used for concurrency control during updates.

Roles

The list of roles within the group

ListMembershipRequest

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.

Name Type Description
Entity

The entity to perform this action on.

ListMembershipResponse

Name Type Description
Groups

The list of groups