Recursos disponíveis

Pontos de extremidade de API de gerenciamento de plataforma disponíveis no Automation Suite, cobrindo recursos de Auditoria, Grupo, Conta de robô, Modelo de mensagem, Configuração, certificados SAML, Usuário e Alocação de licença.

O UiPath® expõe as seguintes APIs:

• API do Orchestrator
• API do Test Manager
• Acesso à API de gerenciamento de plataforma
  • Auditoria — recuperação e download de logs de auditoria na organização.
  • Licenciamento — recuperação e alocação de licenças.
  • Identidade — criação, atualização ou exclusão de contas e gerenciamento de configurações da organização.
• API do Document Understanding
• API do AI Center
• API do UiPath Marketplace
• API da UiPath Academy
• PIMS
• Acesso à API do Process Mining
• Acesso à API do Traces
• API do Data Service.

Este guia é dedicado ao acesso ao recurso dentro do contexto da plataforma (Gerenciamento de plataforma) para a organização. Consulte a documentação de produto específico para obter informações sobre APIs baseadas em produtos.

Observação:

As APIs de Gerenciamento de plataforma estão passando por um processo de aprimoramento funcional, o que pode causar quebra de alterações nos pontos de extremidade. É por isso que as APIs atuais estão marcadas como Visualização em nossa documentação de referência.

Auditar

• GET /audit_/api/auditlogs - Recupera os logs de auditoria de sua organização.
• GET /audit_/api/auditlogs/download - Baixa os logs de auditoria de sua organização.

Grupo

• GET /identity_/api/Group/{partitionGlobalId} - Recupera todos os grupos locais e integrados da ID da partição especificada (organização ou tenant).
• GET /identity_/api/Group/{partitionGlobalId}/{groupId} - Recupera o grupo local ou integrado especificado na ID da partição especificada.
• POST /identity_/api/Group - Cria um novo grupo local.
• PUT /identity_/api/Group/{groupId} - Atualiza as informações de um grupo local.
• DELETE /identity_/api/Group/{partitionGlobalId} - Exclui todos os grupos locais da ID da partição especificada (organização ou tenant).
• DELETE /identity_/api/Group/{partitionGlobalId}/{groupId} - Exclui o grupo local especificado.

Conta de robô

• GET /identity_/api/RobotAccount/{partitionGlobalId} - Recupera todas as contas de Robots na ID da partição especificada (seja da organização ou do tenant).
• GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - Recupera a conta de Robot especificada na ID da partição especificada.
• POST /identity_/api/RobotAccount - Cria uma nova conta de UiPath Robot.
• PUT /identity_/api/RobotAccount/{robotAccountId} - Atualiza as informações da conta de robô especificada.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - Exclui a conta de robô especificada.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId} - Exclui todas as contas de Robots na ID da partição especificada.

Modelo de mensagem

• GET /identity_/api/MessageTemplate - Recupera um modelo de mensagem usando o filtro fornecido.
• GET /identity_/api/MessageTemplate/{templateId} - Recupera o modelo de mensagem especificado.
• PUT /identity_/api/MessageTemplate/{templateId} - Atualiza o modelo de mensagem especificado.

Configuração

• GET /identity_/api/Setting - Recupera as configurações de um aplicativo com base em uma lista de chaves para um tenant específico.
• PUT /identity_/api/Setting - Atualiza ou cria novas configurações em um tenant específico.

Certificados SAML

• PUT https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/primary - Carregue ou atualize o certificado do SAML primário.
• PUT https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/secondary - Carregue ou atualize o certificado do SAML secundário.
• POST https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch - Alterne o certificado secundário para se tornar o certificado primário.
• GET https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates - Obtenha o par de certificados para a organização.
• DELETE https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/{certificateId} - Excluir um certificado com base em seu ID.

Usuário

• GET /identity_/api/User/{userId} - Recupera informações sobre o usuário especificado.
• POST /identity_/api/User/{userId}/changepassword - Atualiza a senha para o usuário especificado.
• PUT /identity_/api/User/{userId} - Atualiza as informações de usuário especificadas.
• DELETE /identity_/api/User - Exclui todos os usuários.
• DELETE /identity_/api/User/{userId} - Exclui o usuário especificado.

Alocação de Licenças

• GET /la/api/account​/{accountId}​/user-license​/group​/{groupId} - Recupera uma lista de todas as licenças de usuário disponíveis para criar ou editar um grupo.
• PUT /la/api/account/{accountId}/user-license/group/{groupId} - Aloca ou atualiza uma regra de grupo.

Gerenciamento de recursos de licença

• PUT /lrm/api/host/{hostAccountId}/organization/{organizationId}/license - Aloca licenças a uma organização do host.
• PUT /lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType} - Aloca licenças a um serviço.