Skip to main content

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

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Este ponto de extremidade não 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 é "".

  • canCreateAndUpdateDcm (booleano): se definido como "verdadeiro", permite ao usuário criar ou atualizar ativos do DCM (fontes de dados, credenciais e cofres externos). Sem essa permissão, os usuários não podem criar, editar e sincronizar seus ativos do DCM a partir do Designer.

  • canShareForExecutionDcm (booleano): se definido como "verdadeiro", permite ao usuário compartilhar as credenciais de conexão do DCM para executar apenas no Server.

  • canShareForCollaborationDcm (booleano): se definido como "verdadeiro", permite ao usuário compartilhar credenciais de conexão do DCM para colaboração.

  • canManageGenericVaultsDcm (booleano): se definido como "verdadeiro", permite ao usuário gerenciar cofres genéricos do DCM.

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/{userId}/deactivate.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Como resposta, você obtém uma matriz de IDs de grupo de usuários dos quais o usuário desativado é removido.

Parâmetros

userId (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'

Enviar um e-mail de redefinição de senha para um usuário

Para enviar um e-mail de redefinição de senha para um usuário existente, use o ponto de extremidade POST {baseURL}/v3/users/{userId}/passwordReset .

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Este ponto de extremidade não pode ser utilizado em instâncias do Server configuradas para autenticação do Windows e autenticação SAML.

Parâmetros

userId (cadeia de caracteres): obrigatório. Insira o ID do usuário para enviar um e-mail de redefinição ao usuário.

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/passwordReset' \
--header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar todos os registros de usuário

Para recuperar todos os registros de usuário acessíveis, use o ponto de extremidade GET {baseURL}/v3/users. Use vários parâmetros como um filtro.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Se searchContract.Verbose for definido como "false" (falso), um objeto de visualização reduzido será retornado.

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'

Recuperar detalhes sobre um usuário específico

Para recuperar detalhes sobre um usuário existente, use o ponto de extremidade GET {baseURL}/v3/users/{userId}.

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

userId (cadeia de caracteres): obrigatório. Insira o ID do usuário para recuperar detalhes sobre esse usuário.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \
--header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar todos os ativos que um usuário possui

Para obter uma lista completa de ativos acessíveis que um usuário existente possui, use o ponto de extremidade GET {baseURL}/v3/users/{userId}/assets.

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • userId (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'

Transferir todos os ativos que um usuário possui para outro

Para transferir todos os ativos (fluxos de trabalho, agendamentos e coleções) de propriedade de um usuário para outro, use o ponto de extremidade PUT {baseURL}/v3/users/{userId}/assetTransfer.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Se qualquer um dos fluxos de trabalho exigir conexões do DCM, conexões do Server ou credenciais run-as específicas para ser executado, esses itens precisam ser atualizados antes que o fluxo de trabalho possa ser executado.

  • Se os usuários não estiverem no mesmo estúdio e quando um fluxo de trabalho for transferido para o novo estúdio, todos os outros usuários no estúdio do novo proprietário também receberão acesso ao fluxo de trabalho, e todos os usuários do antigo estúdio perderão o acesso.

  • Os fluxos de trabalho só podem ser transferidos para um usuário com a função de criador ou de administrador.

  • Se estiver transferindo agendamentos, o novo proprietário deve ter acesso ao fluxo de trabalho agendado, caso contrário, não será possível transferir esse fluxo de trabalho a ele.

  • Se estiver transferindo agendamentos, o novo proprietário deve ter permissão para agendar fluxos de trabalho.

  • Se o usuário for excluído, ele retorna uma lista de IDs de agendamento que serão falharão ou serão desabilitados após a transferência.

Parâmetros

  • userId (cadeia de caracteres): obrigatório. ID do usuário do qual os ativos serão transferidos.

  • contract (corpo):

    • ownerId (cadeia de caracteres): especifique o ID do usuário para o qual transferir ativos (novo proprietário).

    • transferworkflows (booleano): especifique se os fluxos de trabalho devem ser transferidos para o novo proprietário.

    • transferSchedules (booleano): especifique se os agendamentos devem ser transferidos para o novo proprietário.

    • transferCollections (booleano): especifique se as coleções devem ser transferidas para o novo proprietário.

Exemplo de solicitação: cURL

curl -X PUT \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
-d '{ 
  "ownerId": "63d17f6cb049da66d0afd4e2", 
  "transferWorkflows": true, 
  "transferSchedules": true, 
  "transferCollections": true 
}' \
'http://localhost/webapi/v3/users/613a523df9199abfc446d19d/assetTransfer'

Atualizar um usuário existente

Para atualizar os detalhes de um usuário existente, use o ponto de extremidade PUT {baseURL}/v3/users/{userId}.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • O ID do updateContract será substituído pelo valor do ID no URL.

Parâmetros

  • userId (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.

    • 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".

    • canCreateAndUpdateDcm (booleano): se definido como "verdadeiro", permite ao usuário criar ou atualizar ativos do DCM (fontes de dados, credenciais e cofres externos). Sem essa permissão, os usuários não podem criar, editar e sincronizar seus ativos do DCM a partir do Designer.

    • canShareForExecutionDcm (booleano): se definido como "verdadeiro", permite ao usuário compartilhar as credenciais de conexão do DCM para executar apenas no Server.

    • canShareForCollaborationDcm (booleano): se definido como "verdadeiro", permite ao usuário compartilhar credenciais de conexão do DCM para colaboração.

    • canManageGenericVaultsDcm (booleano): se definido como "verdadeiro", permite ao usuário gerenciar cofres genéricos do DCM.

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 um usuário

Para excluir um usuário existente do sistema, use o ponto de extremidade DELETE {baseURL}/v3/users/{userId}.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • No momento, não há uma opção equivalente na interface do usuário (IU) para excluir um usuário. A única ação disponível é marcar o usuário como inativo.

Cuidado

  • Se o usuário que você deseja excluir tiver algum ativo atribuído (por exemplo, fluxos de trabalho, agendamentos, coleções) ou for membro de grupos de usuários, a solicitação de exclusão falhará.

  • A API retornará uma resposta de erro 400 Solicitação incorreta (400 Bad Request) indicando que o usuário não pode ser excluído devido à propriedade de um ou mais ativos.

  • Se uma tentativa de exclusão for feita e o sistema sinalizar o usuário como isDeleted=true, o e-mail, nome e sobrenome do usuário serão ocultados no banco de dados. No entanto, isso não removerá totalmente o registro do usuário, pois é necessário manter a integridade referencial com fluxos de trabalho que o usuário pode ter criado ou modificado.

Parâmetros

userId (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:

Exemplos de solicitações Postman

GET /v3/users

Example of the GET request in Postman.

GET /v3/users/{id}/assets

Example of the GET request in Postman.

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman.

Nesta secção: