> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Groupes

> Gérez les groupes d'entités PlayFab ainsi que leurs rôles, membres, invitations, candidatures et blocages.

La famille de commandes `playfab group` est expérimentale. Son interface CLI peut changer
ou être supprimée en fonction des retours.

Gérez les groupes d'entités PlayFab ainsi que leurs rôles, membres, invitations, candidatures et
blocages, et répertoriez les groupes auxquels appartient une entité.

La plupart des commandes ciblent un groupe avec `--group-id` ; `group get` peut utiliser `--group-name`
à la place. Passez `--entity-id` et `--entity-type` ensemble, comme `--entity-type
title_player_account`. Pour un joueur, passez l'ID de son compte joueur de titre, et non l'ID de son compte
joueur principal ; [`playfab player account get`](https://docs.xbox.com/fr/tools/xbox-cli/commands/playfab/player) le renvoie sous la forme
`UserInfo.TitleInfo.TitlePlayerAccount.Id`.

`group delete` et `group role delete` demandent une confirmation dans un terminal, et ont besoin de `--confirm`
ailleurs. Les autres commandes qui modifient un groupe, y compris `group member remove`, s'exécutent
sans demander de confirmation. Consultez [Sécurité et opérations destructives](https://docs.xbox.com/fr/tools/xbox-cli/safety.md).

## Cycle de vie des groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group create` | `/Group/CreateGroup` | `--group-name` obligatoire ; propriétaire `--entity-id`, `--entity-type` facultatif. |
| `playfab group get` | `/Group/GetGroup` | `--group-id` ou `--group-name`. |
| `playfab group update` | `/Group/UpdateGroup` | `--group-id` obligatoire ; `--group-name`, `--admin-role-id`, `--member-role-id`, `--expected-profile-version` facultatives. |
| `playfab group delete` | `/Group/DeleteGroup` | `--group-id` obligatoire. |

## Membres des groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group member add` | `/Group/AddMembers` | `--group-id`, `--member-ids`, `--member-type` obligatoires ; `--role-id` facultative. |
| `playfab group member remove` | `/Group/RemoveMembers` | `--group-id`, `--member-ids`, `--member-type` obligatoires ; `--role-id` facultative. |
| `playfab group member change-role` | `/Group/ChangeMemberRole` | `--group-id`, `--member-ids`, `--member-type`, `--origin-role-id` et `--destination-role-id` obligatoires. |
| `playfab group member list` | `/Group/ListGroupMembers` | `--group-id` obligatoire. |
| `playfab group member is-member` | `/Group/IsMember` | `--group-id`, `--entity-id` et `--entity-type` obligatoires ; `--role-id` facultative. Effectue uniquement des lectures. |

## Rôles des groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group role create` | `/Group/CreateRole` | `--group-id`, `--role-id` et `--role-name` obligatoires. |
| `playfab group role update` | `/Group/UpdateRole` | `--group-id`, `--role-id` et `--role-name` obligatoires ; `--expected-profile-version` facultative. |
| `playfab group role delete` | `/Group/DeleteRole` | `--group-id` et `--role-id` obligatoires. |

## Invitations aux groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group invite send` | `/Group/InviteToGroup` | `--group-id`, `--entity-id` et `--entity-type` obligatoires ; `--role-id`, `--auto-accept` facultatives. |
| `playfab group invite accept` | `/Group/AcceptGroupInvitation` | `--group-id` obligatoire ; entité acceptante `--entity-id`, `--entity-type` facultative. |
| `playfab group invite remove` | `/Group/RemoveGroupInvitation` | `--group-id`, `--entity-id` et `--entity-type` obligatoires. |
| `playfab group invite list` | `/Group/ListGroupInvitations` | `--group-id` obligatoire. |

`--auto-accept` vaut `true` par défaut pour `invite send` : lorsque l'entité a déjà postulé
au groupe, PlayFab accepte la candidature au lieu d'envoyer une invitation.

## Candidatures aux groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group application apply` | `/Group/ApplyToGroup` | `--group-id` obligatoire ; candidat `--entity-id`, `--entity-type`, `--auto-accept` facultatives. |
| `playfab group application accept` | `/Group/AcceptGroupApplication` | `--group-id` obligatoire ; candidat `--entity-id`, `--entity-type` facultatif. |
| `playfab group application remove` | `/Group/RemoveGroupApplication` | `--group-id`, `--entity-id` et `--entity-type` obligatoires. |
| `playfab group application list` | `/Group/ListGroupApplications` | `--group-id` obligatoire. |

`--auto-accept` vaut `true` par défaut pour `application apply` : lorsque le groupe a déjà
invité l'entité, PlayFab accepte l'invitation au lieu de créer une candidature.

## Blocages des groupes

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group block add` | `/Group/BlockEntity` | `--group-id`, `--entity-id` et `--entity-type` obligatoires. |
| `playfab group block remove` | `/Group/UnblockEntity` | `--group-id`, `--entity-id` et `--entity-type` obligatoires. |
| `playfab group block list` | `/Group/ListGroupBlocks` | `--group-id` obligatoire. |

## Appartenances des entités

| Commande | Chemin de l'API PlayFab | Options |
| - | - | - |
| `playfab group membership list` | `/Group/ListMembership` | `--entity-id`, `--entity-type` facultatives ; omettez-les toutes les deux pour cibler l'entité appelante. |
| `playfab group membership opportunity list` | `/Group/ListMembershipOpportunities` | `--entity-id`, `--entity-type` facultatives ; omettez-les toutes les deux pour cibler l'entité appelante. |

## Sortie sous forme de tableau

Ces commandes acceptent `--output table` ; les autres non. Consultez
[Sortie sous forme de tableau](https://docs.xbox.com/fr/tools/xbox-cli/commands.md#table-output).

| Commande | Colonnes |
| - | - |
| `playfab group member list` | `MEMBER ID`, `MEMBER TYPE`, `ROLE ID` |
| `playfab group invite list` | `INVITED ENTITY`, `ROLE ID`, `EXPIRES` |
| `playfab group application list` | `ENTITY`, `EXPIRES` |
| `playfab group block list` | `BLOCKED ENTITY`, `ENTITY TYPE` |
| `playfab group membership list` | `GROUP ID`, `GROUP NAME` |
| `playfab group membership opportunity list` | `TYPE`, `GROUP ID`, `ROLE ID`, `EXPIRES` |

`member list` comporte une ligne pour chaque membre dans chaque rôle : un membre ayant deux rôles a donc deux
lignes, et un rôle sans membre a une ligne avec `-` pour le membre.
`membership opportunity list` affiche les invitations et les candidatures dans un même tableau : `TYPE` vaut
`invitation` ou `application`, et `ROLE ID` vaut `-` pour une candidature.

## Exemples

Lire un groupe, répertorier ses membres, vérifier si un joueur en fait partie et répertorier ses
invitations en attente :

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group get --group-id GROUP123
xbox --playfab-title-id ABC123 playfab group member list --group-id GROUP123 --data-only --output json-compact
xbox --playfab-title-id ABC123 playfab group member is-member --group-id GROUP123 --entity-id TITLEPLAYER123 --entity-type title_player_account
xbox --playfab-title-id ABC123 playfab group invite list --group-id GROUP123 --output table
```

Inviter un joueur dans le groupe :

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group invite send --group-id GROUP123 --entity-id TITLEPLAYER123 --entity-type title_player_account
```

Supprimer le groupe :

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group delete --group-id GROUP123 --confirm
```


## Related topics

- [Groupes de produits](https://docs.xbox.com/fr/publishing/game-publishing/concepts/product-groups.md)
- [Groupes d'entités](https://docs.xbox.com/fr/services/playfab/community/associations/groups/quickstart.md)
- [Classements de groupes](https://docs.xbox.com/fr/services/playfab/community/leaderboards/group-leaderboards.md)
- [Groupe de contrôles](https://docs.xbox.com/fr/reference/system/touchadaptationkit/layout/game-streaming-touch-control-cluster-outer.md)
- [Obtenir un groupe](https://docs.xbox.com/fr/services/playfab/api-references/rest/groups/groups/get-group.md)
