Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto .
Para obter mais informações sobre grupos de usuários do Server, acesse a página de ajuda Gerenciamento de usuários e grupos .
Para carregar um novo grupo de usuários, use o ponto de extremidade
POST {baseURL}/v3/usergroups
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Para criar um novo grupo de usuários do Server, especifique o parâmetro "contract":
contract (corpo): obrigatório. Especifique os parâmetros para um grupo de usuários do Server:
name (cadeia de caracteres): obrigatório. Insira um nome de grupo de usuários do Server.
role (cadeia de caracteres): obrigatório. Insira uma função para este grupo de usuários do Server. 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 .
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'
Para adicionar um ou mais usuários existentes a um grupo de usuários existente, use o ponto de extremidade
POST {baseURL}/v3/usergroups/{userGroupId}/users
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Para adicionar usuários a um grupo de usuários do Server, especifique os seguintes parâmetros:
userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários ao qual deseja adicionar usuários.
userIds (corpo): obrigatório. Insira a lista de IDs de usuário que deseja adicionar a este grupo de usuários, separados por vírgulas.
Para adicionar um grupo do Active Directory a um grupo de usuários existente, use o ponto de extremidade
POST /v3/usergroups/{userGroupId}/activedirectorygroups
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.
userGroupId (cadeia de caracteres): obrigatório. Insira o ID de um grupo de usuários existente ao qual deseja adicionar um grupo do Active Directory.
sid (cadeia de caracteres): obrigatório. Insira o identificador de segurança (SID) do grupo do Active Directory. Esta é uma payload do corpo JSON. Você deve enviar o valor entre aspas, por exemplo "S-My-SID".
Para recuperar todos os registros de grupos de usuários acessíveis, use o ponto de extremidade
GET {baseURL}/v3/usergroups
. Use vários parâmetros como um filtro para pesquisar os usuários.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Apenas os grupos de usuários personalizados serão recuperados. Grupos do Active Directory não serão retornados.
Nenhum parâmetro é necessário.
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para recuperar detalhes sobre um grupo de usuários existente, use o ponto de extremidade
GET {baseURL}/v3/usergroups/{userGroupId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Funciona apenas para grupos de usuários do Server. Os grupos do Active Directory não podem ser recuperados desse ponto de extremidade.
userGroupId (cadeia de caracteres): obrigatório. Insira um ID de grupo de usuários existente para recuperar informações sobre esse grupo de usuários.
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para atualizar o nome e a função de um grupo de usuários existente, use o ponto de extremidade
PUT {baseURL}/v3/usergroups/{userGroupId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
userGroupId (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 .
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'
Para remover um usuário específico de um grupo de usuários existente, use o ponto de extremidade
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Se o usuário não fizer parte do grupo de usuários, uma resposta "OK" será retornada.
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.
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para remover um grupo do Active Directory de um grupo de usuários existente, use o ponto de extremidade
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.
userGroupId (cadeia de caracteres): obrigatório. Insira o identificador do grupo de usuários do qual deseja remover o grupo do Active Directory.
adGroupSid (cadeia de caracteres): obrigatório. Insira o identificador de segurança (SID) do grupo do Active Directory que deseja remover do grupo de usuários.
Para excluir um grupo de usuários existente do sistema, use o ponto de extremidade
DELETE {baseURL}/v3/usergroups/{userGroupId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
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).
userGroupId (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.
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
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 você estiver adicionando um grupo de usuários a uma coleção .
userGroupId se você estiver atualizando permissões do grupo de usuários de uma coleção .
userGroupId se você estiver removendo um grupo de usuários de uma coleção .
userGroupId se você desejar compartilhar uma credencial com um grupo de usuários .
userGroupId se você desejar remover um grupo de usuários de uma credencial .
userGroupId se você desejar adicionar um grupo de usuários a uma conexão de dados .
userGroupId se você desejar remover um grupo de usuários de uma conexão de dados .
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .