Cliente externo: credenciales federadas

Las credenciales federadas permiten que una aplicación externa OAuth se autentique en UiPath utilizando un token web JSON (JWT) emitido por un proveedor de identidad externo, sin requerir un secreto de cliente. Cada aplicación admite un máximo de 20 credenciales federadas.

Utiliza los puntos finales de esta página para enumerar, crear, recuperar, actualizar y eliminar credenciales federadas para una aplicación externa OAuth registrada. Para gestionar las propias aplicaciones externas, consulta Gestionar aplicaciones OAuth externas.

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/

---

Enumerar credenciales federadas

Recuperar todas las credenciales federadas registradas para una aplicación externa OAuth específica.

Punto final de API

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

Parámetros de ruta

Parámetro	Descripción
partitionGlobalId	El ID global de la organización.
clientId	El ID de la aplicación externa OAuth.

Á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'

Nota:

Para obtener el {access_token}, utiliza un token de administrador de la organización o autentícate a través de uno de los métodos descritos en Métodos de autenticación.

Respuesta

200 OK

Devuelve una matriz de objetos FederatedCredentialDto . Devuelve una matriz vacía si no se registran credenciales.

Solicitud de ejemplo

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}'

Respuesta de ejemplo

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main",
    "createdAt": "2026-03-01T10:00:00Z",
    "updatedAt": "2026-03-01T10:00:00Z"
  }
]

---

Crear una credencial federada

Crea una credencial de identidad federada para una aplicación externa OAuth específica.

Nota:

Cada aplicación admite un máximo de 20 credenciales federadas.

Punto final de API

POST {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials

Parámetros de ruta

Parámetro	Descripción
partitionGlobalId	El ID global de la organización.
clientId	El ID de la aplicación externa OAuth.

Á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'

Solicitar cuerpo

{
  "name": "azure-production-workload",
  "description": "Federated credential for production Azure workload",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

Campo	Obligatorio	Descripción
name	Sí	Un nombre descriptivo para la credencial. Debe ser único dentro de la aplicación. Máximo 128 caracteres.
description	No	Contexto opcional para la credencial. Máximo 512 caracteres.
issuer	Sí	El URI HTTPS del proveedor de identidad externo. Debe ser accesible en el momento de la creación.
audience	Sí	Una sola cadena que debe aparecer en la solicitud JWT aud .
subject	Sí	Un valor que debe coincidir exactamente con la reclamación JWT sub .

Respuesta

201 Creado

Devuelve el objeto FederatedCredentialDto creado.

400 Bad Request

La solicitud no es válida. Posibles causas: name no es único dentro del cliente, issuer no es un URI HTTPS válido, el punto final JWKS del emisor es inalcanzable o se ha alcanzado el máximo de 20 credenciales por aplicación.

404 No encontrado

El clientId especificado no existe o no pertenece a la organización de la persona que llama.

Solicitud de ejemplo

curl --request POST \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

Respuesta de ejemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-01T10:00:00Z"
}

---

Obtener una credencial federada

Recuperar una credencial federada específica por su ID.

Punto final de API

GET {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parámetros de ruta

Parámetro	Descripción
partitionGlobalId	El ID global de la organización.
clientId	El ID de la aplicación externa OAuth.
credentialId	El ID de la credencial federada.

Á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'

Respuesta

200 OK

Devuelve el objeto FederatedCredentialDto para la credencial solicitada.

404 No encontrado

La credencial o aplicación especificada no existe en la organización de la persona que llama.

Solicitud de ejemplo

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

Respuesta de ejemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-15T08:30:00Z"
}

---

Actualizar una credencial federada

Actualizar una credencial federada existente. Todos los campos obligatorios deben incluirse en el cuerpo de la solicitud.

Punto final de API

PUT {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parámetros de ruta

Parámetro	Descripción
partitionGlobalId	El ID global de la organización.
clientId	El ID de la aplicación externa OAuth.
credentialId	El ID de la credencial federada que se actualizará.

Á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'

Solicitar cuerpo

{
  "name": "azure-production-workload-updated",
  "description": "Updated description",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

Campo	Obligatorio	Descripción
name	Sí	Un nombre descriptivo para la credencial. Debe ser único dentro de la aplicación. Máximo 128 caracteres.
description	No	Contexto opcional para la credencial. Máximo 512 caracteres.
issuer	Sí	El URI HTTPS del proveedor de identidad externo. Debe ser accesible en el momento de la creación.
audience	Sí	Una sola cadena que debe aparecer en la solicitud JWT aud .
subject	Sí	Un valor que debe coincidir exactamente con la reclamación JWT sub .

Respuesta

200 OK

Devuelve el objeto FederatedCredentialDto actualizado.

400 Bad Request

Error de validación. Posibles causas: name duplicado, URI de emisor no válido o punto final JWKS inalcanzable.

Solicitud de ejemplo

curl --request PUT \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions — Production",
    "description": "Production branch deployments only",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

Respuesta de ejemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions — Production",
  "description": "Production branch deployments only",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-20T14:00:00Z"
}

---

Eliminar una credencial federada

Eliminar una credencial federada. Esta acción es permanente e invalida inmediatamente cualquier adquisición de tokens utilizando esta credencial.

ADVERTENCIA:

La eliminación es permanente. Después de la eliminación, la credencial ya no se puede utilizar para adquirir nuevos tokens de acceso. Los tokens de acceso ya emitidos antes de la eliminación siguen siendo válidos hasta que caducan.

Punto final de API

DELETE {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parámetros de ruta

Parámetro	Descripción
partitionGlobalId	El ID global de la organización.
clientId	El ID de la aplicación externa OAuth.
credentialId	El ID de la credencial federada que se eliminará.

Á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'

Respuesta

209 Sin contenido

La credencial federada se eliminó correctamente. El cuerpo de la respuesta está vacío.

404 No encontrado

La credencial o aplicación especificada no existe en la organización de la persona que llama.

Solicitud de ejemplo

curl --request DELETE \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

---

Adquirir un token utilizando una credencial federada

Intercambia un JWT de tu proveedor de identidad externo por un token de acceso de UiPath.

Punto final de API

POST {accessURL}/identity_/connect/token

Solicitar encabezados.

--header 'Content-Type: application/x-www-form-urlencoded'

Solicitar cuerpo

grant_type=client_credentials
&client_id={client_id}
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion={jwt_token}
&scope={requested_scopes}

Parámetro	Descripción
grant_type	Debe ser client_credentials.
client_id	El ID de cliente de la aplicación externa OAuth registrada.
client_assertion_type	Debe ser urn:ietf:params:oauth:client-assertion-type:jwt-bearer.
client_assertion	El JWT emitido por tu proveedor de identidad externo.
scope	Los ámbitos OAuth solicitados para el token de acceso.

Respuesta

200 OK

Devuelve un objeto de token de acceso. Utiliza el valor access_token en el encabezado Authorization: Bearer de las llamadas API posteriores.

400 Bad Request

Error en la adquisición del token. Posibles causas: firma JWT no válida, discrepancia de emisor o audiencia, discrepancia de asunto, JWT caducado o JWT supera los 8 KB.

---

Esquemas

CredencialFederadaDto

El objeto devuelto por las operaciones GET, POST y PUT.

Propiedad	Tipo	Anulable	Descripción
id	cadena (uuid)	No	El identificador único de la credencial federada.
clientId	String	Sí	El ID de aplicación de la aplicación externa OAuth a la que pertenece esta credencial.
name	String	Sí	El nombre para mostrar de la credencial federada.
description	String	Sí	La descripción de la credencial federada.
issuer	String	Sí	La URL del proveedor de identidad externo.
audience	String	Sí	El valor de reclamación aud esperado en el JWT.
subject	String	Sí	El valor de reclamación sub esperado en el JWT.
createdAt	cadena (fecha-hora)	No	La marca de tiempo UTC cuando se creó la credencial.
updatedAt	cadena (fecha-hora)	No	La marca de tiempo UTC cuando se actualizó la credencial por última vez.