test-cloud

latest

false

Importante :

La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía de la API de Test Cloud

ENTREGA:

Última actualización 7 de abr. de 2026

ClienteExterno

Enumerar todos los clientes externos

Obtenga la lista completa de clientes externos para una organización.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Read

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización desde la que desea recuperar los clientes externos.

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

Respuesta

200 Correcto

La lista de clientes externos para una organización determinada se ha recuperado correctamente.

[
  {
    "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"
      }
    ]
  }
]
[
  {
    "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"
      }
    ]
  }
]

Obtener detalles de un cliente externo específico

Obtenga un cliente externo específico de una organización y obtenga el ID de secreto del secreto más antiguo.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Read

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización de la que quieres obtener el cliente externo y el ID de cliente correspondiente.

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

Respuesta

200 Correcto

El cliente externo se ha recuperado correctamente.

{
  "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"
    }
  ]
}
{
  "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"
    }
  ]
}

Actualizar un cliente externo

Actualiza el nombre, la URL de redirección, los ámbitos o los certificados de una aplicación OAuth externa.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización donde se encuentra el cliente externo específico y el ID de cliente correspondiente.

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

Respuesta

200 Correcto

El cliente externo especificado se ha actualizado correctamente.

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

Eliminar clientes externos

Elimina un cliente externo específico.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización de la que quieres eliminar el cliente externo y el ID de cliente correspondiente.

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

Respuesta

204 Sin contenido

El cliente externo se ha eliminado correctamente. No se devuelven valores.

Crear un nuevo cliente externo

Crea un nuevo cliente externo.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud incluye el ID de la organización, el nombre del cliente externo, su estado de confidencialidad, el URI de redirección, los ámbitos necesarios y los certificados de cliente.

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

Respuesta

201 Creado

El cliente externo se ha creado correctamente.

{
  "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"
    }
  ]
}
{
  "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"
    }
  ]
}

Generar un nuevo secreto

Genera un nuevo secreto de cliente para el cliente externo dado.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write
PM.SecretoOAuth.Escritura

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización donde se encuentra el cliente externo y el ID de cliente correspondiente.

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

Respuesta

200 Correcto

El secreto de cliente se ha creado correctamente para el cliente externo dado.

"string"
"string"

Generar un nuevo cliente externo

Genera un nuevo cliente externo.

Punto de conexión de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write
PM.OAuthAppSecret.Write

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de cliente para el que quieres generar un secreto, una descripción correspondiente y el ID de la organización.

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

Respuesta

200 Correcto

Se ha generado correctamente un nuevo secreto de cliente para el cliente externo dado.

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

Eliminar un secreto de cliente

Eliminar un secreto de cliente.

Punto final de API

DELETE {accessURL}/{organizationName}/identity_/api/{partitionGlobalId}/secrets/{secretsId}

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.AplicaciónOAuth
PM.OAuthApp.Write
PM.OAuthAppSecret.Write

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Solicitar cuerpo

El cuerpo de la solicitud contiene el ID de la organización y el ID del secreto de cliente que deseas eliminar.

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

Respuesta

204 Sin contenido

El secreto de cliente se ha eliminado correctamente. No se devuelve ningún valor.

En esta página

Enumerar todos los clientes externos
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Obtener detalles de un cliente externo específico
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Actualizar un cliente externo
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Eliminar clientes externos
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Crear un nuevo cliente externo
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Generar un nuevo secreto
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Generar un nuevo cliente externo
Punto de conexión de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta
Eliminar un secreto de cliente
Punto final de API
Ámbitos
Solicitar encabezados.
Solicitar cuerpo
Respuesta

¿Te ha resultado útil esta página?

AnteriorDescargar eventos

Sig.Cliente externo: credenciales federadas

Guía de la API de Test Cloud

Enumerar todos los clientes externos​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

200 Correcto​

Obtener detalles de un cliente externo específico​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

200 Correcto​

Actualizar un cliente externo​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

200 Correcto​

Eliminar clientes externos​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

204 Sin contenido​

Crear un nuevo cliente externo​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

201 Creado​

Generar un nuevo secreto​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

200 Correcto​

Generar un nuevo cliente externo​

Punto de conexión de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

200 Correcto​

Eliminar un secreto de cliente​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Solicitar cuerpo​

Respuesta​

204 Sin contenido​

¿Te ha resultado útil esta página?

Enumerar todos los clientes externos

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

200 Correcto

Obtener detalles de un cliente externo específico

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

200 Correcto

Actualizar un cliente externo

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

200 Correcto

Eliminar clientes externos

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

204 Sin contenido

Crear un nuevo cliente externo

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

201 Creado

Generar un nuevo secreto

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

200 Correcto

Generar un nuevo cliente externo

Punto de conexión de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

200 Correcto

Eliminar un secreto de cliente

Punto final de API

Ámbitos

Solicitar encabezados.

Solicitar cuerpo

Respuesta

204 Sin contenido