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 objeto .
Para obter mais informações sobre grupos personalizados, acesse a página de ajuda Gerenciamento de usuários e grupos .
Criar um novo grupo de notificação
Para carregar um novo fluxo de trabalho, use o ponto de extremidade
POST {baseURL}/v3/workflows
.
Parâmetros
Para criar um novo grupo de usuários, especifique o parâmetro contrato:
updateWorkflowContract (corpo): obrigatório. Especifique os parâmetros para um grupo de usuários:
name (cadeia de caracteres): obrigatório. Insira o Nome do grupo.
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: BearerTokenGoesHere' --data-urlencode 'name'
Remover um usuário de um grupo de usuários
Para adicionar um ou mais usuários a um grupo de usuários, use o
{baseURL}endpoint POST /v3/usergroups/{id}/users
.
Parâmetros
Para adicionar usuários a um grupo de usuários, especifique os seguintes parâmetros:
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza o ID do grupo de utilizadores ao qual pretende adicionar utilizadores.
Userids (corpo): Necessário. Introduza as IDs de utilizador que pretende adicionar a este grupo de utilizadores.
Recuperar um grupo de usuários personalizado
Para pesquisar usuários, use o
{baseURL}endpoint Get /v3/usergroups
. Use vários parâmetros como um filtro para pesquisar os usuários.
Nota
Apenas os Grupos de utilizadores personalizados serão recuperados. Não serão devolvidos grupos do Ative Directory.
Parâmetros
Nenhum parâmetro é necessário.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer token-bearer-aqui'
Procure um grupo de utilizadores específico
Para obter informações sobre um fluxo de trabalho específico, use o ponto de extremidade
GET {baseURL}/v3/workflows/{id}
.
Nota
Só funciona para grupos de utilizadores personalizados. Os grupos do Ative Directory não podem ser recuperados a partir deste endpoint.
Parâmetros
workerTag (cadeia de caracteres): obrigatório. Introduza uma ID de grupo de utilizadores para obter informações sobre este grupo de utilizadores.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Iniciar um grupo de usuários -
Para atualizar o nome e a função de um grupo de usuários existente, use o
{baseURL}endpoint PUT /v3/usergroups/{id}
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de grupo de utilizadores para atualizar este grupo de utilizadores.
Contrato (corpo): Obrigatório. Para atualizar um grupo de utilizadores, é necessário o parâmetro do contrato. Especifique o seguinte:
name (cadeia de caracteres): obrigatório. Insira o Nome do grupo.
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: BearerTokenGoesHere' --data-urlencode 'name'
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
{baseURL}endpoint DELETE /v3/usergroups{userGroupId}/ /users/{userId}
.
Nota
Se o usuário não fizer parte do grupo, uma resposta OK será retornada.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza o ID do grupo de utilizadores do qual pretende remover o utilizador.
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza o ID de utilizador que pretende remover do grupo de utilizadores.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Iniciar um grupo de usuários -
Para excluir um grupo de usuários específico do sistema, use o
{baseURL}endpoint DELETE /v3/usergroups/{id}
.
Nota
A mensagem de erro '400 Bad Request' é retornada se o grupo de usuários não estiver vazio e o parâmetro de consulta forceDelete for false.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza a ID do grupo de utilizadores que pretende eliminar.
hasPrivateDataExemption (booleano): opcional. Se definido como true, o grupo de usuários será excluído mesmo que esse grupo de usuários contenha usuários.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Relações de objetos
Se você estiver carregando um fluxo de trabalho, você pode usar objetos criados da seguinte maneira:
Objeto criado: " workflowId " (for example, "id": "7917969784f84bd09442f66996ecb8f3")
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 .
Exemplos de solicitações Postman
POST /v3/usergroups
![Example of a POST request in Postman.](../../../../image/uuid-c28e8930-9b15-def0-574a-978a54dbc914.png)
Eliminar /v3/usergroups/{userGroupId}/users/{userId}
![Example of a DELETE request in Postman.](../../../../image/uuid-0377222b-ab9d-dc68-4351-8c89eaa30095.png)
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .