Recursos disponíveis

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
• API do StudioWeb
• Acesso à API de Contextualização
• PIMS
• Acesso à API do Process Mining
• Acesso à API do Traces
• API do Data Fabric
• IXP.ServiçoExterno

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 do ID de partição especificado (organização ou locatário).
• GET /identity_/api/Group/{partitionGlobalId}/{groupId}—Recupera o grupo local ou interno especificado no ID de partição especificado.
• 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.

Contas do Robot

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

Configuração

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

Certificados SAML

• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/primary - Carregue ou atualize o certificado do SAML primário.
• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/secondary - Carregue ou atualize o certificado do SAML secundário.
• POST https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch – Alterne o certificado secundário para se tornar o certificado primário.
• GET https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates – Obtenha o par de certificados para a organização.
• DELETE https://cloud.uipath.com/{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 específicas do usuário.
• 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 /lease_/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 /lease_/api/account/{accountId}/user-license/group/{groupId}—Aloca ou atualiza uma regra de grupo.