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 #relações-de-objetos-6518518 seção Relações com 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 carregar um novo fluxo de trabalho, use o ponto de extremidade POST {baseURL}/v3/workflows.

Nota

Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.

Parâmetros

  • UserContract (body): Para criar um novo usuário, o parâmetro userContract é necessário. Especifique os seguintes parâmetros:

    • name (cadeia de caracteres): obrigatório. Introduza o primeiro nome de um utilizador.

    • name (cadeia de caracteres): obrigatório. Introduza o apelido de um utilizador.

    • name (cadeia de caracteres): obrigatório. Introduza o endereço de e-mail de um utilizador.

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

    • isPublic (booleano): opcional. Especifique se a API está habilitada para um usuário. Quando não selecionado, o valor padrão é "false".

    • credentialId (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 valor "Default" é usado.

    • force (booleano): opcional. Selecione se um utilizador está ativo ou desativado. Quando não especificado, o valor "Default" é usado.

    • name (cadeia de caracteres): opcional. Introduza o fuso horário, por exemplo, Europe/Kiev. Quando não especificado, o valor "Default" é usado.

Exemplo de solicitação: cURL

Curl --location --REQUEST post 'http://localhost/webapi/v3/users' --header 'Content-Type: Application/x-www-form-urlencoded' --header 'Authorization: BearerTokenGoesHere' --data-urlencode 'firstName' 'john' --data-urlencode 'lastName' John.Doe@emailexample.com'

Desabilitar um usuário

Para desativar um usuário no sistema, use o {baseURL}endpoint POST /v3/Users/{id}/deactivate .

Parâmetros

  • workerTag (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador para desativar este utilizador.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

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 {baseURL}endpoint POST /v3{id}/users/ /passwordReset .

Nota

Este ponto de extremidade só pode ser utilizado em instâncias do Server configuradas para autenticação do Windows.

Parâmetros

  • workerTag (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador para repor a respetiva palavra-passe.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Pesquisar usuários

Para pesquisar usuários, use o {baseURL}endpoint Get /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 selecionar 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.

  • force (booleano): opcional. Selecione se um utilizador está ativo ou desativado.

  • name (cadeia de caracteres): opcional. Digite 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.

  • name (cadeia de caracteres): opcional. Introduza o nome do utilizador.

  • name (cadeia de caracteres): opcional. Introduza o apelido do utilizador.

  • CreatedApós (data-hora): Opcional. Insira a data e a hora após a qual o fluxo de trabalho foi criado. Insira a data e a hora no formato ISO8601.

  • CreatedAntes ( data-hora): Opcional. Insira a data e a hora antes da qual o fluxo de trabalho foi criado. Insira a data e a hora no formato ISO8601.

Exemplo de solicitação: cURL

Curl --localização --REQUEST Get 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' --header 'Authorization: BearerTokenGoesHere'

Procurar por um usuário

Para pesquisar um usuário específico, use o{baseURL}endpoint Get /v3/users/{id} .

Parâmetros

  • workerTag (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador para obter informações sobre este utilizador.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Recuperar todos os ativos que um usuário possui

Para obter uma lista completa de ativos que um usuário possui, use o {baseURL}endpoint Get /v3/users/{id}/assets .

Parâmetros

  • workerTag (cadeia de caracteres): obrigatório. Introduza um ID de utilizador para recuperar a lista de ativos para este utilizador.

  • name (cadeia de caracteres): opcional. Selecione os tipos de ativos que deseja retornar. O padrão é definido como 'All'.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer token-bearer-aqui'

Atualizar um usuário existente

Para atualizar um usuário existente, use o{baseURL}endpoint PUT /v3/Users/{id} .

Nota

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

Parâmetros

  • workerTag (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador para atualizar este utilizador.

  • updateWorkflowContract (corpo): obrigatório. Para atualizar um usuário, o parâmetro updateContract é necessário. Especifique o seguinte:

    • createdAfter (cadeia de caracteres): opcional. Introduza uma ID de utilizador para a atualizar.

    • name (cadeia de caracteres): obrigatório. Introduza o primeiro nome de um utilizador.

    • name (cadeia de caracteres): obrigatório. Introduza o apelido de um utilizador.

    • name (cadeia de caracteres): obrigatório. Introduza o endereço de e-mail de um utilizador.

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

    • isPublic (booleano): obrigatório. Especifique se a API está habilitada para um usuário.

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

    • isPublic (booleano): obrigatório. Selecione se pretende bloquear esta conta de utilizador.

    • isPublic (booleano): obrigatório. Selecione se um utilizador está ativo ou desativado.

    • isPublic (booleano): obrigatório. Especifique se o endereço de e-mail de um usuário está validado.

    • name (cadeia de caracteres): obrigatório. Introduza o fuso horário, por exemplo, Europe/Kiev, etc.

    • workflowCredentialType (cadeia de caracteres): obrigatório. Os valores de linguagem suportados são "de-de", "en-us", "es-es", "fr-fr", "it-it", "ja-jp", "pt-br", "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: BearerTokenGoesHere' --data-urlencode 'firstName'' --data-urlencode-lencode-jdoe@alteryx.com' data-urlencode 'canAssignJobs' --data-urlencode 'canCreateCollections'' --data-urlencode 'isApiEnabled'' --data-urlencode 'defaultCredentialId

Excluir usuário

Para excluir um usuário específico do sistema, use o {baseURL}endpoint DELETE /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

  • workerTag (cadeia de caracteres): obrigatório. Introduza o ID de utilizador que pretende eliminar.

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:

Exemplos de solicitações Postman

Obter /v3/usuários

Example of the GET request in Postman.

OBTENHA /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: