Campos do grupo
Todos os campos de um objeto de grupo de usuários, com os métodos que os aceitam e seus valores aceitos.
Os grupos de usuários organizam os usuários por papéis e permissões. Esta página lista todos os campos aceitos em um objeto de grupo de usuários. O * marca um campo obrigatório.
Campos do grupo de usuários
| Campo | Descrição | Disponível nos métodos | Valores aceitos |
|---|---|---|---|
usergroup_id | O ID do grupo de usuários. | GET | integer |
type* | O tipo do grupo de usuários. | GET, POST, PUT | A (administradores), C (clientes) |
status* | O status do grupo de usuários. | GET, POST, PUT | A (ativo), H (oculto), D (desativado) |
usergroup | O nome do grupo de usuários. | GET, POST, PUT | string |
privileges | Os privilégios dos membros deste grupo. Vale apenas para grupos de administradores. | GET | array |
Exemplo de requisição de grupo de usuários
bash
curl -X POST "$BASE_URL/api/usergroups" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "C",
"status": "A",
"usergroup": "Premium Customers"
}'Exemplo de requisição de grupo de administradores com privilégios
bash
curl -X POST "$BASE_URL/api/usergroups" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "A",
"status": "A",
"usergroup": "Store Managers",
"privileges": {
"manage_catalog": "Y",
"manage_users": "Y",
"manage_orders": "Y",
"manage_settings": "N"
}
}'Onde os campos são usados
Estes campos valem para as cinco chamadas sobre grupos: GET /api/usergroups (listar), GET /api/usergroups/{id} (consultar), POST /api/usergroups (criar), PUT /api/usergroups/{id} (atualizar) e DELETE /api/usergroups/{id} (excluir). As requisições e respostas estão nas páginas Endpoints de grupos e Exemplos.