POST | Adicionar membros a um grupo de usuários

Descrição

Adicione um ou mais usuários a um grupo de usuários. Um usuário que já é membro ativo é ignorado, e um vínculo que existe mas está inativo é reativado, então a mesma requisição pode ser repetida com segurança.

Pré-requisitos

Uma aplicação com a autorização Users concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.
Os usuários referenciados em user_ids devem existir previamente na plataforma.
O grupo não deve estar gerenciado por uma sincronização LDAP ativa.

Requisição

POST /api/v2/iam/user-groups/{id}/users

Parâmetros de path

Parâmetro	Tipo	Obrigatório	Descrição
`id`	integer	Sim	Código de identificação único do grupo de usuários.

Cabeçalhos

Cabeçalho	Obrigatório	Descrição
`Content-Type`	Sim	Deve ser `application/json`.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`user_ids`	array[integer]	Sim	Códigos de identificação dos usuários a adicionar. O array deve conter pelo menos um valor. Strings numéricas, como `"10"`, também são aceitas.

Exemplo de requisição

POST {{url}}/api/v2/iam/user-groups/7/users

Corpo

{
  "user_ids": [10, 11]
}

Resposta

HTTP/1.1 204 No Content
X-Request-Id: 7f3c1a90-2c4e-4b1a-9f5e-0a2b7c9d1e34

A alteração de vínculo é aplicada quando a resposta chega. Uma requisição bem-sucedida não retorna corpo.

Info

Dependendo da configuração de controle de acesso da plataforma, as alterações resultantes no acesso efetivo dos usuários afetados podem ser aplicadas em segundo plano logo após a resposta.

Erros

Código HTTP	Mensagem	Possível causa	Solução
`401`	`api.auth.unauthorized`	O token de acesso está ausente, inválido ou expirou.	Solicite um novo token de acesso.
`404`	`api.resource.not_found`	O grupo de usuários não existe, ou está fora do escopo da autorização.	Verifique o código de identificação e o escopo da autorização.
`409`	`api.resource.inactive`	O grupo de usuários está inativo.	Ative o grupo e tente novamente. Para mais informações, acesse POST \| Ativar grupo de usuários.
`422`	`api.validation.required_field`	O corpo não carrega `user_ids`.	Adicione o campo e reenvie a requisição.
`422`	`api.validation.invalid_reference`	Um dos códigos em `user_ids` não corresponde a um usuário existente.	Verifique os códigos e reenvie a requisição.
`422`	`api.validation.invalid_type`	Um valor em `user_ids` não é um integer nem uma string numérica.	Envie apenas integers ou strings numéricas.
`422`	`user_group.users.locked_by_ldap_sync`	O vínculo de membros do grupo é gerenciado por uma sincronização LDAP ativa.	Altere o vínculo na origem do diretório, ou remova o grupo do escopo da sincronização.
`429`	`api.rate_limit_exceeded`	O limite de requisições foi excedido.	Aguarde o número de segundos retornado no cabeçalho `Retry-After` e tente novamente.

Para as mensagens de erro de autenticação e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.