Criar uma ação para remover um usuário

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 5 min. de leitura

    • Crie uma ação para desativar ou excluir uma conta de usuário na aplicação SaaS.

    Antes de Iniciar

    Se você estiver usando um spoke ServiceNow® Integration Hub existente, descubra se ele tem uma ação para remover um usuário que você pode usar em vez de criar um.

    Função necessária: flow_designer ou administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Esta ação é usada para recuperar assinaturas não utilizadas para reduzir as despesas de software da sua empresa.

    Procedimento

    1. Navegar até Todos > Flow Designer > Designer.
    2. Clique em Novo e selecione Ação.
    3. No formulário, preencha os campos.
      Tabela 1. Formulário Propriedades da ação
      Campo Valor
      Nome Nome de sua escolha. Por exemplo, Remover usuário.
      Acessível de Todos os escopos da aplicação.
      Categoria Deixe este campo em branco.
      Proteção Nenhum.
      Aplicação App Spoke para integração com a aplicação SaaS. Pode ser um spoke Integration Hub existente ou um novo spoke que você criou.
      Anotação em fluxo Deixe este campo em branco.
      Descrição Descrição de sua escolha.
    4. Clique em Enviar.
    5. Na seção Entradas da Descrição da ação, clique em Criar entrada.
    6. Adicione uma entrada de ID de usuário.

      É assim que a ação obtém o ID do usuário a ser excluído.

      Tabela 2. Entradas
      Rótulo Nome Tipo Obrigatório
      ID do usuário userID Cadeia de caracteres Sim
    7. Se a API com a qual você está trabalhando exigir autenticação de usuário para solicitações, adicione entradas para autenticação.
      Exemplos de entradas comuns de autenticação de usuário são ID de usuário administrador e nome do site. Consulte a documentação da API escolhida para saber mais sobre os requisitos de autenticação de usuário em seu caso específico. Se a API exigir um token de acesso, uma variável de valor de credencial será criada automaticamente posteriormente, portanto, você não precisará adicioná-la como uma entrada.

      Ao usar sua ação concluída em um subfluxo, você define quais valores serão passados como essas entradas.

    8. Adicione uma etapa SOAP ou uma etapa REST à descrição da ação.
      Sua escolha dependerá da API da aplicação SaaS com a qual você está integrando.
    9. Se você selecionou SOAP, preencha o formulário conforme mostrado.
      Tabela 3. Formulário de etapa SOAP
      Campo Valor
      Detalhes da Conexão
      Conexão Usar alias de conexão.
      Alias de conexão Alias de conexão que você criou ao criar o perfil de integração. Se você ainda não criou um perfil de integração, siga as etapas para criar um perfil de integração personalizado com um alias de conexão.
      Endpoint Este valor é preenchido automaticamente quando você seleciona o alias de conexão. É definido como a URL de conexão do registro de conexão HTTP(s) vinculado ao alias.
      Detalhes da solicitação
      Criar os Envelopes Manualmente.
      Ações de SOAP Solicitação de API para excluir ou desativar um usuário. Consulte a documentação da API escolhida para selecionar a solicitação apropriada.
      Envelopes de SOAP Mensagem de solicitação XML para excluir um usuário. Consulte a documentação da API escolhida para saber como gravar uma mensagem de solicitação XML. Em geral, o cabeçalho deve ter suas variáveis de entrada para autenticação de usuário, bem como a variável Valor de credencial como o token de acesso. O corpo deve incluir a solicitação para excluir um usuário e a entrada do ID do usuário.
      Nota:
      Para obter um exemplo de um envelope SOAP, consulte a ação Remover usuário usada no subfluxo Webex Recuperar assinatura.
    10. Se você selecionou REST, preencha o formulário conforme mostrado.
      Tabela 4. Formulário de etapa REST
      Campo Valor
      Detalhes da Conexão
      Conexão Usar alias de conexão.
      Alias de conexão Alias de conexão que você criou ao criar o perfil de integração. Se você ainda não criou um perfil de integração, siga as etapas para criar um perfil de integração personalizado com um alias de conexão.
      URL base Este valor é preenchido automaticamente quando você seleciona o alias de conexão. É definido como a URL de conexão do registro de conexão HTTP(s) vinculado ao alias.
      Detalhes da solicitação
      Criar solicitação Manualmente.
      Caminho do recurso Caminho para o recurso. Este valor é anexado ao URL base. Consulte a documentação da API com a qual você está trabalhando para saber como construir o caminho do recurso.
      Método HTTP EXCLUIR.
      Parâmetros de Consulta Adicione um parâmetro para o ID do usuário. Defina o valor como a entrada do ID do usuário.
    11. Adicione uma etapa de script à descrição da ação para tratamento de erros.
      1. Em Tempo de execução necessário, selecione Instância.
      2. Criar variáveis de entrada.
        Tabela 5. Variáveis de entrada
        Nome Valor
        resposta Saída do corpo da resposta da etapa SOAP ou REST
        status_code Saída de Código de status da etapa SOAP ou REST
      3. Criar variáveis de saída.
        Tabela 6. Variáveis de Saída
        Rótulo Nome Tipo Obrigatório
        status status Escolha Sim
        ErrorMessage ErrorMessage Cadeia de caracteres Sim
      4. No campo Script, grave um script para atribuir valores às saídas de status e mensagem de erro.
        • Use a entrada status_code para verificar se há um erro. Defina a saída de status como Erro se houver um erro e Êxito se não houver erro.
        • Nos casos em que há um erro, use a entrada de resposta para obter informações sobre o tipo de erro. Defina a saída da mensagem de erro com uma descrição do erro para que um usuário possa entender o que deu errado.
    12. Em Descrição da ação, clique em Saídas.
    13. Criar variáveis de saída.
      Tabela 7. Variáveis de Saída
      Rótulo Nome Tipo Obrigatório
      Status status Escolha Não
      Mensagem de erro ErrorMessage Cadeia de caracteres Não
    14. Atribua valores às variáveis de saída.
      Tabela 8. Variáveis de Saída
      Rótulo Valor
      Status variável de saída destatus da etapa de script
      Mensagem de erro variável de saídaerror_message da etapa de script
    15. Para testar sua ação, clique em Testar.
      1. Veja os resultados de testes e os logs do sistema para obter detalhes sobre erros.
        Para exibir logs do sistema, navegue até Logs do sistema > Log do Sistema > Todos.
      2. Se sua ação tiver erros, verifique se você está usando os endpoints corretos e se a solicitação de API está estruturada conforme o esperado.
      Nota:
      Ao testar, lembre-se de que esta ação desativa um usuário. Teste esta ação em um ambiente de subprodução. Se apenas um ambiente de produção estiver disponível, você poderá criar usuários falsos para teste.
    16. Depois de verificar se a ação está funcionando conforme o esperado, clique em Publicar.