Pontos de extremidade de usuários
Pontos de extremidade de usuários e parâmetros
Para saber mais sobre as relações de objetos, vá para a seção Relações de objetos.
Para obter mais informações sobre usuários, visite a página de ajuda Gerenciamento de usuários e grupos.
Criar um novo usuário
Para criar um novo registro de usuário, use o ponto de extremidade POST {baseURL}/v3/users.
Nota
Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.
Parâmetros
userContract (corpo): para criar um novo usuário, o parâmetro "userContract" é obrigatório. Especifique os seguintes parâmetros:
firstName (cadeia de caracteres): obrigatório. Insira o primeiro nome de um usuário.
lastName (cadeia de caracteres): obrigatório. Insira o sobrenome de um usuário.
email (cadeia de caracteres): obrigatório. Insira o endereço de e-mail de um usuário.
role (cadeia de caracteres): opcional. Você pode selecionar entre estas opções: "NoAccess" (sem acesso), "Viewer" (visualizador), "Member" (membro), "Artisan" (criador), "Curator" (administrador), e "Evaluated" (avaliado). A função padrão é "Evaluated" no momento da 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. Quando nenhuma função é selecionada, o padrão é a função "Evaluated" (avaliado).
defaultWorkerTag (cadeia de caracteres): opcional. Especifique a tag do trabalhador definida nos trabalhos para ajudar a atribuir tarefas a determinados nós de trabalho. Quando não especificado, o padrão é "". Para obter mais informações, visite a página de ajuda Trabalhador.
canScheduleJobs (booleano): opcional. Especifique se o usuário pode agendar trabalhos. Quando não especificado, o padrão é "false" (falso). Para obter mais informações, visite a página de ajuda Trabalhos.
canPrioritizeJobs (booleano): opcional. Especifique se um usuário pode priorizar trabalhos. Quando não especificado, o padrão é "false" (falso). Para obter mais informações, visite a página de ajuda Trabalhos.
canAssignJobs (booleano): opcional. Especifique se um usuário pode atribuir trabalhos. Quando não especificado, o padrão é "false" (falso). Para obter mais informações, visite a página de ajuda Trabalhos.
canCreateCollections (booleano): opcional. Especifique se um usuário pode criar novas coleções. Quando não especificado, o padrão é "false" (falso). Para obter mais informações, visite a página de ajuda Coleções.
isApiEnabled (booleano): opcional. Especifique se a API está habilitada para um usuário. Quando não especificado, o padrão é "false" (falso).
defaultCredentialId (cadeia de caracteres): opcional. Este parâmetro refere-se ao ID exclusivo de um fluxo de trabalho, atribuído ao usuário como padrão. Quando não especificado, o padrão é "".
isActive (booleano): opcional. Selecione se um usuário está ativo ou desativado. Quando não especificado, o padrão é "true" (verdadeiro).
timeZone (cadeia de caracteres): opcional. Insira o fuso horário, por exemplo, Europa/Kiev. Quando não especificado, o padrão é "". Para obter mais informações sobre fusos horários, vá para Pontos de extremidade de agendamentos.
Exemplo de solicitação: cURL
curl --location --request POST 'http://localhost/webapi/v3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'firstName=John' \ --data-urlencode 'lastName=Doe' \ --data-urlencode 'email=John.Doe@emailexample.com'
Desabilitar um usuário
Para desativar um usuário no sistema, use o ponto de extremidade POST {baseURL}/v3/users/{id}/deactivate.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do usuário para desativar este usuário.
Exemplo de solicitação: cURL
curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/deactivate' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Repor uma palavra-passe para um utilizador
Para redefinir e enviar um e-mail de redefinição de senha para um usuário específico, use o ponto de extremidade POST {baseURL}/v3/users/{id}/passwordReset .
Nota
Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do usuário para redefinir sua senha.
Exemplo de solicitação: cURL
curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/passwordReset' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Pesquisar usuários
Para pesquisar usuários, use o ponto de extremidade GET {baseURL}/v3/users. Use vários parâmetros como um filtro para pesquisar os usuários.
Parâmetros
view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode escolher entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.
active (booleano): opcional. Selecione se um usuário está ativo ou desativado.
email (cadeia de caracteres): opcional. Insira o endereço de e-mail do usuário.
role (cadeia de caracteres): opcional. Selecione a função do usuário para restringir a pesquisa. 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.
firstName (cadeia de caracteres): opcional. Insira o primeiro nome do usuário.
lastName (cadeia de caracteres): opcional. Insira o sobrenome do usuário.
createdAfter (data/hora): opcional. Insira a data e a hora após as quais o usuário foi criado. Insira a data e a hora no formato ISO8601.
createdBefore (data/hora): opcional. Insira a data e a hora antes das quais o usuário foi criado. Insira a data e a hora no formato ISO8601.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Procurar por um usuário
Para procurar por um usuário específico, use o ponto de extremidade GET {baseURL}/v3/users/{id}.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira um ID de usuário para recuperar informações sobre esse usuário.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Recuperar todos os ativos que um usuário possui
Para obter uma lista completa de ativos que um usuário possui, use o ponto de extremidade GET {baseURL}/v3/users/{id}/assets.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do usuário para recuperar a lista de ativos para esse usuário.
assetType (cadeia de caracteres): opcional. Selecione os tipos de ativos que deseja retornar. O padrão é definido como "All" (todos).
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32/assets?assetType=Workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Atualizar um usuário existente
Para atualizar um usuário existente, use o ponto de extremidade PUT {baseURL}/v3/users/{id}.
Nota
O ID do updateContract será substituído pelo valor de ID no URL.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do usuário para que esse usuário seja atualizado.
updateContract (corpo): obrigatório. Para atualizar um usuário, o parâmetro "updateContract" é obrigatório. Especifique o seguinte:
id (cadeia de caracteres): opcional. Insira o ID do usuário para que seja atualizado.
firstName (cadeia de caracteres): obrigatório. Insira o primeiro nome de um usuário.
lastName (cadeia de caracteres): obrigatório. Insira o sobrenome de um usuário.
email (cadeia de caracteres): obrigatório. Insira o endereço de e-mail de um usuário.
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.
defaultWorkerTag (cadeia de caracteres): obrigatório. Especifique a tag do trabalhador definida nos trabalhos para ajudar a atribuir tarefas a determinados nós de trabalho. Para obter mais informações sobre trabalhadores, visite a página de ajuda Trabalhador.
canScheduleJobs (booleano): obrigatório. Especifique se um usuário pode agendar trabalhos. Para obter mais informações, visite a página de ajuda Trabalhos.
canPrioritizeJobs (booleano): obrigatório. Especifique se um usuário pode priorizar trabalhos. Para obter mais informações, visite a página de ajuda Trabalhos.
canAssignJobs (booleano): obrigatório. Especifique se um usuário pode atribuir trabalhos. Para obter mais informações, visite a página de ajuda Trabalhos.
canCreateCollections (booleano): opcional. Especifique se um usuário pode criar coleções. Quando não especificado, o valor permanece o mesmo de antes. Para obter mais informações, visite a página de ajuda Coleções.
isApiEnabled (booleano): obrigatório. Especifique se a API está habilitada para um usuário.
defaultCredentialId (cadeia de caracteres): obrigatório. Este parâmetro refere-se ao ID exclusivo de um fluxo de trabalho, atribuído ao usuário como padrão.
isAccountLocked (booleano): obrigatório. Selecione se deseja bloquear esta conta de usuário.
isActive (booleano): obrigatório. Selecione se um usuário está ativo ou desativado.
isValidated (booleano): obrigatório. Especifique se o endereço de e-mail de um usuário está validado.
timeZone (cadeia de caracteres): obrigatório. Insira o fuso horário, por exemplo, Europa/Kiev etc. Para obter mais informações sobre fusos horários, vá para Pontos de extremidade de agendamentos.
language (cadeia de caracteres): obrigatório. Os valores de idioma com suporte são "de-de", "en-us", "es-es", "fr-fr", "it-it", "ja-jp", "pt-br" e "zh-cn".
Exemplo de solicitação: cURL
curl --location --request PUT 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'firstName=Doe' \ --data-urlencode 'lastName=Jane' \ --data-urlencode 'email=jdoe@alteryx.com' \ --data-urlencode 'role=Artisan' \ --data-urlencode 'defaultWorkerTag=worker' \ --data-urlencode 'canScheduleJobs=true' \ --data-urlencode 'canPrioritizeJobs=true' \ --data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true' \ --data-urlencode 'isActive=true' \ --data-urlencode 'isValidated=true' \ --data-urlencode 'timeZone=Europe/Prague' \ --data-urlencode 'language=en-us' \ --data-urlencode 'id=61d564361d6d5da7ad461a32'
Excluir usuário
Para excluir um usuário específico do sistema, use o ponto de extremidade DELETE {baseURL}/v3/users/{id}.
Nota
Se o usuário que você deseja excluir tiver algum ativo (fluxos de trabalho, agendas, coleções, insights) ou grupos de usuários atribuídos, esse usuário não poderá ser excluído.
Parâmetros
id (cadeia de caracteres): obrigatório. Insira o ID do usuário que você deseja excluir.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relações de objetos
Se estiver criando um usuário, você poderá usar objetos criados da seguinte maneira:
Objeto criado: "id" (por exemplo, "id": "619158e57e607d0011ac3009")
Você pode usá-lo como:
userId se você estiver adicionando usuários a um grupo de usuários.
userId se você estiver removendo o usuário de um grupo de usuários.
id se você estiver procurando um usuário específico.
ownerId se você estiver carregando um fluxo de trabalho.
userId se você estiver adicionando um usuário de uma coleção.
userId se você estiver removendo um usuário de uma coleção.
userId se você estiver atualizando permissões de usuário para uma coleção.
ownerId se você estiver procurando um agendamento.
userId se você desejar compartilhar uma credencial com um usuário.
userId se você desejar remover um usuário de uma credencial.
userId se você desejar adicionar um usuário a uma conexão de dados existente.
userId se você desejar remover um usuário de uma conexão de dados existente.
Exemplos de solicitações Postman
GET /v3/users
GET /v3/users/{id}/assets
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman.