> ## 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.

# Grupos

> Gerencie os grupos de entidades do PlayFab e suas funções, membros, convites, solicitações de participação e bloqueios.

A família de comandos `playfab group` é Experimental. Sua interface de CLI pode mudar
ou ser removida com base em comentários.

Gerencie os grupos de entidades do PlayFab e suas funções, membros, convites, solicitações de participação e
bloqueios, e liste os grupos aos quais uma entidade pertence.

A maioria dos comandos tem como destino um grupo com `--group-id`; `group get` pode usar `--group-name`
em vez disso. Passe `--entity-id` e `--entity-type` juntos, como `--entity-type
title_player_account`. Para um jogador, passe a ID da conta de jogador do título dele, e não a ID da conta de jogador
mestre; [`playfab player account get`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab/player) a retorna como
`UserInfo.TitleInfo.TitlePlayerAccount.Id`.

`group delete` e `group role delete` perguntam primeiro em um terminal e precisam de `--confirm`
nos demais casos. Os outros comandos que alteram um grupo, incluindo `group member remove`, são executados
sem perguntar. Consulte [Segurança e operações destrutivas](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md).

## Ciclo de vida do grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group create` | `/Group/CreateGroup` | `--group-name` obrigatória; `--entity-id`, `--entity-type` do proprietário opcionais. |
| `playfab group get` | `/Group/GetGroup` | `--group-id` ou `--group-name`. |
| `playfab group update` | `/Group/UpdateGroup` | `--group-id` obrigatória; `--group-name`, `--admin-role-id`, `--member-role-id`, `--expected-profile-version` opcionais. |
| `playfab group delete` | `/Group/DeleteGroup` | `--group-id` obrigatória. |

## Membros do grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group member add` | `/Group/AddMembers` | `--group-id`, `--member-ids`, `--member-type` obrigatórias; `--role-id` opcional. |
| `playfab group member remove` | `/Group/RemoveMembers` | `--group-id`, `--member-ids`, `--member-type` obrigatórias; `--role-id` opcional. |
| `playfab group member change-role` | `/Group/ChangeMemberRole` | `--group-id`, `--member-ids`, `--member-type`, `--origin-role-id` e `--destination-role-id` obrigatórias. |
| `playfab group member list` | `/Group/ListGroupMembers` | `--group-id` obrigatória. |
| `playfab group member is-member` | `/Group/IsMember` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias; `--role-id` opcional. Apenas lê. |

## Funções do grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group role create` | `/Group/CreateRole` | `--group-id`, `--role-id` e `--role-name` obrigatórias. |
| `playfab group role update` | `/Group/UpdateRole` | `--group-id`, `--role-id` e `--role-name` obrigatórias; `--expected-profile-version` opcional. |
| `playfab group role delete` | `/Group/DeleteRole` | `--group-id` e `--role-id` obrigatórias. |

## Convites do grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group invite send` | `/Group/InviteToGroup` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias; `--role-id`, `--auto-accept` opcionais. |
| `playfab group invite accept` | `/Group/AcceptGroupInvitation` | `--group-id` obrigatória; `--entity-id`, `--entity-type` de quem aceita opcionais. |
| `playfab group invite remove` | `/Group/RemoveGroupInvitation` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias. |
| `playfab group invite list` | `/Group/ListGroupInvitations` | `--group-id` obrigatória. |

O padrão de `--auto-accept` é `true` para `invite send`: quando a entidade já solicitou participação
no grupo, o PlayFab aceita a solicitação em vez de enviar um convite.

## Solicitações de participação no grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group application apply` | `/Group/ApplyToGroup` | `--group-id` obrigatória; `--entity-id`, `--entity-type` do solicitante e `--auto-accept` opcionais. |
| `playfab group application accept` | `/Group/AcceptGroupApplication` | `--group-id` obrigatória; `--entity-id`, `--entity-type` do solicitante opcionais. |
| `playfab group application remove` | `/Group/RemoveGroupApplication` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias. |
| `playfab group application list` | `/Group/ListGroupApplications` | `--group-id` obrigatória. |

O padrão de `--auto-accept` é `true` para `application apply`: quando o grupo já
convidou a entidade, o PlayFab aceita o convite em vez de criar uma solicitação de participação.

## Bloqueios do grupo

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group block add` | `/Group/BlockEntity` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias. |
| `playfab group block remove` | `/Group/UnblockEntity` | `--group-id`, `--entity-id` e `--entity-type` obrigatórias. |
| `playfab group block list` | `/Group/ListGroupBlocks` | `--group-id` obrigatória. |

## Associações de entidades

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab group membership list` | `/Group/ListMembership` | `--entity-id`, `--entity-type` opcionais; omita ambas para ter como destino a entidade chamadora. |
| `playfab group membership opportunity list` | `/Group/ListMembershipOpportunities` | `--entity-id`, `--entity-type` opcionais; omita ambas para ter como destino a entidade chamadora. |

## Saída em tabela

Estes comandos aceitam `--output table`; os demais não. Consulte
[Saída em tabela](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands.md#table-output).

| Comando | Colunas |
| - | - |
| `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` tem uma linha para cada membro em cada função; portanto, um membro em duas funções tem duas
linhas, e uma função sem membros tem uma linha com `-` no lugar do membro.
`membership opportunity list` mostra convites e solicitações de participação em uma única tabela: `TYPE` é
`invitation` ou `application`, e `ROLE ID` é `-` para uma solicitação de participação.

## Exemplos

Ler um grupo, listar seus membros, verificar se um jogador pertence a ele e listar seus
convites pendentes:

```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
```

Convidar um jogador para o grupo:

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

Excluir o grupo:

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


## Related topics

- [Obter grupo](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/groups/groups/get-group.md)
- [Excluir grupo](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/groups/groups/delete-group.md)
- [Criar grupo](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/groups/groups/create-group.md)
- [Atualizar grupo](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/groups/groups/update-group.md)
- [Grupos de produtos](https://docs.xbox.com/pt-BR/publishing/game-publishing/concepts/product-groups.md)
