ClienteExterno

Pontos de extremidade de API do cliente externo para gerenciar aplicativos externos do OAuth registrados em uma organização.

Liste todos os clientes externos

Obtenha a lista completa de clientes externos de uma organização.

Ponto de Extremidade da API

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Read

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém a ID da organização de onde você deseja recuperar os clientes externos.

{
  "partitionGlobalId": "<organizationId>"
}

Resposta

200 Sucesso

A lista de clientes externos de uma organização fornecida foi recuperada com sucesso.

[
  {
    "name": "string",
    "id": "string",
    "secret": "string",
    "isConfidential": true,
    "redirectUri": "string",
    "resources": [
      {
        "name": "string",
        "displayName": "string",
        "description": "string",
        "scopes": [
          {
            "name": "string",
            "displayName": "string",
            "description": "string",
            "type": "user"
          }
        ]
      }
    ],
    "secrets": [
      {
        "id": 0,
        "description": "string",
        "secret": "string",
        "creationTime": "2025-07-18T12:52:37.566Z",
        "expiryTime": "2025-07-18T12:52:37.566Z"
      }
    ]
  }
]

Obter detalhes de um cliente externo específico

Obtenha um cliente externo específico de uma organização e obtenha o ID do segredo do segredo mais antigo.

Ponto de Extremidade da API

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Read

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém a ID da organização de onde você deseja obter o cliente externo e a ID do cliente correspondente.

{
  "partitionGlobalId": "<organizationId>"
  "clientId": "<clientId>"
}

Resposta

200 Sucesso

O cliente externo foi recuperado com sucesso.

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T12:57:01.155Z",
      "expiryTime": "2025-07-18T12:57:01.155Z"
    }
  ]
}

Atualizar um cliente externo

Atualize o nome, URL de redirecionamento, escopos ou certificados de um aplicativo externo do OAuth.

Ponto de Extremidade da API

PUT {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém o ID da organização onde o cliente externo específico está localizado e o ID do cliente correspondente.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Resposta

200 Sucesso

O cliente externo especificado foi atualizado com sucesso.

Example Value
Schema
{
  "name": "string",
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

Excluir clientes externos

Exclua um cliente externo específico.

Ponto de Extremidade da API

DELETE {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém a ID da organização de onde você deseja excluir o cliente externo e a ID do cliente correspondente.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Resposta

204 Sem conteúdo

O cliente externo foi excluído com sucesso. Nenhum valor é retornado.

Criar um novo cliente externo

Crie um novo cliente externo.

Ponto de Extremidade da API

POST {accessURL}/{organizationName}/identity_/api/ExternalClient

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação inclui a ID da organização, o nome do cliente externo, seu status de confidencialidade, o URI de redirecionamento, os escopos exigidos e os certificados do cliente.

{
  "partitionGlobalId": "orgId",
  "name": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

Resposta

201 criado

O cliente externo foi criado com sucesso.

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T13:53:12.823Z",
      "expiryTime": "2025-07-18T13:53:12.823Z"
    }
  ]
}

Gerar um novo segredo

Gerar um novo segredo do cliente para o cliente externo fornecido.

Ponto de Extremidade da API

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthSecret.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém o ID da organização onde o cliente externo está localizado e o ID do cliente correspondente.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Resposta

200 Sucesso

O segredo do cliente foi criado com sucesso para o cliente externo fornecido.

"string"

Gerar um novo cliente externo

Gere um novo cliente externo.

Ponto de extremidade da API

POST {accessURL}/{organizationName}/identity_/api/ExternalClient/GenerateSecret

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthAppSecret.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém o ID do cliente para o qual você deseja gerar um segredo, uma descrição correspondente e o ID da organização.

{
  "clientId": "string",
  "description": "string",
  "partitionGlobalId": "orgId",
  "expiryTime": "2025-07-18T13:24:15.806Z"
}

Resposta

200 Sucesso

Um novo segredo do cliente foi gerado com sucesso para o cliente externo fornecido.

{
  "id": 0,
  "description": "string",
  "secret": "string",
  "creationTime": "2025-07-18T13:56:16.889Z",
  "expiryTime": "2025-07-18T13:56:16.889Z"

Excluir um segredo do cliente

Excluir um segredo do cliente.

Ponto de Extremidade da API

DELETE {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/secrets/{secretId}

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthAppSecret.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Corpo da Solicitação

O corpo da solicitação contém o ID da organização e o ID do segredo do cliente que você deseja excluir.

{
  "partitionGlobalId": "<organizationId>",
  "secretId": "<secretId>"
}

Resposta

204 Sem conteúdo

O segredo do cliente foi excluído com sucesso. Nenhum valor é retornado.