Pontos de extremidade de grupos de usuários
Pontos de extremidade de grupos de usuários e parâmetros
Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objetos .
Para obter mais informações sobre grupos personalizados, visite a página de ajuda Gerenciamento de usuários e grupos .
Criar um novo grupo de usuários
Para criar um novo registro userGroup, use o ponto de extremidade
POST {baseURL}/v3/usergroups
.
Parâmetros
Para criar um novo grupo de usuários, especifique o parâmetro "contract":
contract (corpo): obrigatório. Especifique os parâmetros para um grupo de usuários:
name (cadeia de caracteres): obrigatório. Insira o nome do grupo de usuários.
role (cadeia de caracteres): obrigatório. Insira uma função para este grupo de usuários. Selecione uma destas opções: "NoAccess" (sem acesso), "Viewer" (visualizador), "Member" (membro), "Artisan" (criador), "Curator" (administrador), e "Evaluated" (avaliado). A função padrão ("Evaluated" (avaliado)) é avaliada em tempo de execução. Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário .
Exemplo de solicitação: cURL
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
Adicionar um usuário a um grupo de usuários
Para adicionar um ou mais usuários a um grupo de usuários, use o ponto de extremidade
POST {baseURL}/v3/usergroups/{id}/users
.
Parâmetros
Para adicionar usuários a um grupo de usuários, especifique os seguintes parâmetros:
id (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários ao qual deseja adicionar usuários.
userIds (corpo): obrigatório. Insira os IDs do usuário que você deseja adicionar a esse grupo de usuários.
Exemplo de solicitação: cURL
A ser adicionado.
Recuperar todos os grupos de usuários personalizados
Para pesquisar usuários, use o ponto de extremidade
GET {baseURL}/v3/usergroups
. Use vários parâmetros como um filtro para pesquisar os usuários.
Nota
Apenas os grupos de usuários personalizados serão recuperados. Grupos do Active Directory não serão retornados.
Parâmetros
Nenhum parâmetro é necessário.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Pesquisar um grupo de usuários específico
Para recuperar informações sobre um grupo de usuários específico, use o ponto de extremidade
GET {baseURL}/v3/usergroups/{id}
.
Nota
Funciona apenas para grupos de usuários personalizados. Os grupos do Active Directory não podem ser recuperados desse ponto de extremidade.
Parâmetros
"id" (cadeia de caracteres): obrigatório. Insira um ID de grupo de usuários para recuperar informações sobre esse grupo de usuários.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Atualizar um grupo de usuários
Para atualizar o nome e a função de um grupo de usuários existente, use o ponto de extremidade
PUT {baseURL}/v3/usergroups/{id}
.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira um ID de grupo de usuários para que esse grupo de usuários seja atualizado.
contract (corpo): obrigatório. Para atualizar um grupo de usuários, o parâmetro "contract" é obrigatório. Especifique o seguinte:
name (cadeia de caracteres): obrigatório. Insira o nome do grupo de usuários.
role (cadeia de caracteres): obrigatório. Você pode selecionar entre estas opções: "NoAccess" (sem acesso), "Viewer" (visualizador), "Member" (membro), "Artisan" (criador), "Curator" (administrador), e "Evaluated" (avaliado). Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário .
Exemplo de solicitação: cURL
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
Remover um usuário de um grupo de usuários
Para remover um usuário específico de um grupo de usuários, use o ponto de extremidade
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Nota
Se o usuário não fizer parte do grupo, uma resposta "OK" será retornada.
Parâmetros
userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários do qual deseja remover o usuário.
userId (cadeia de caracteres): obrigatório. Insira o ID do usuário que deseja remover do grupo de usuários.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Excluir um grupo de usuários
Para excluir um grupo de usuários específico do sistema, use o ponto de extremidade
DELETE {baseURL}/v3/usergroups/{id}
.
Nota
A mensagem de erro "400 Bad Request" (400 Solicitação incorreta) será retornada se o grupo de usuários não estiver vazio e o parâmetro de consulta forceDelete for "false" (falso).
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários que deseja excluir.
forceDelete (booleano): opcional. Se definido como "true" (verdadeiro), o grupo de usuários será excluído mesmo que contenha usuários.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relações de objetos
Se estiver criando um grupo de usuários, você poderá usar objetos criados da seguinte maneira:
Objeto criado: " id " (por exemplo, "id": "619158e57e607d0011ac3009")
Você pode usá-lo como:
userGroupId se estiver adicionando um grupo de usuários a uma coleção .
userGroupId se estiver atualizando permissões de grupo de usuários de uma coleção .
userGroupId se estiver removendo um grupo de usuários de uma coleção .
userGroupId se quiser compartilhar uma credencial com um grupo de usuários .
userGroupId se quiser remover um grupo de usuários de uma credencial .
userGroupId se quiser adicionar um grupo de usuários a uma conexão de dados .
userGroupId se quiser remover um grupo de usuários de uma conexão de dados .
Exemplos de solicitações Postman
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar o Postman .