Externer Client – Verbundene Anmeldeinformationen

Mit verbundenen Anmeldeinformationen kann sich eine externe OAuth-Anwendung bei UiPath mithilfe eines JSON Web Tokens (JWT) authentifizieren, das von einem externen Identitätsanbieter ausgestellt wurde, ohne dass ein geheimer Clientschlüssel erforderlich ist. Jede Anwendung unterstützt maximal 20 Verbundanmeldeinformationen.

Verwenden Sie die Endpunkte auf dieser Seite, um verbundene Anmeldedaten für eine registrierte externe OAuth-Anwendung aufzulisten, zu erstellen, abzurufen, zu aktualisieren und zu löschen. Informationen zum Verwalten externer Anwendungen finden Sie unter Verwalten externer OAuth-Anwendungen.

Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:

Cloud Platform	Zugriffs-URL
Test Cloud	https://cloud.uipath.com/
Test Cloud Public Sector	https://govcloud.uipath.us/
Test Cloud Dedicated.	https://{customURL}.dedicated.uipath.com/

---

Listen Sie die verbundenen Anmeldeinformationen auf

Rufen Sie alle verbundenen Anmeldeinformationen ab, die für eine bestimmte externe OAuth-Anwendung registriert sind.

API-Endpunkt

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

Pfadparameter

Parameter	Beschreibung
partitionGlobalId	Die globale ID der Organisation.
clientId	Die ID der externen OAuth-Anwendung.

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Read

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, verwenden Sie ein Organisationsadministrator-Token oder authentifizieren Sie sich mit einer der unter Authentifizierungsmethoden beschriebenen Methoden.

Antworten

200 OK

Gibt ein Array von VerbundCredentialDto- Objekten zurück. Gibt ein leeres Array zurück, wenn keine Anmeldeinformationen registriert sind.

Beispielanforderung

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

Beispielantwort

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

---

Erstellen Sie verbundene Anmeldeinformationen

Erstellen Sie eine Verbundidentitätsanmeldeinformation für eine bestimmte externe OAuth-Anwendung.

Hinweis:

Jede Anwendung unterstützt maximal 20 Verbundanmeldeinformationen.

API-Endpunkt

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

Pfadparameter

Parameter	Beschreibung
partitionGlobalId	Die globale ID der Organisation.
clientId	Die ID der externen OAuth-Anwendung.

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Anforderungstext

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

Feld	Erforderlich	Beschreibung
name	Ja	Ein beschreibender Name für die Anmeldeinformationen. Muss in der Anwendung eindeutig sein. Maximal 128 Zeichen.
description	Nein	Optionaler Kontext für die Anmeldeinformationen. Maximal 512 Zeichen.
issuer	Ja	Der HTTPS-URI des externen Identitätsanbieters. Muss zum Zeitpunkt der Erstellung erreichbar sein.
audience	Ja	Eine einzelne Zeichenfolge, die im JWT aud -Anspruch angezeigt werden muss.
subject	Ja	Ein Wert, der genau mit der JWT-Anforderung sub übereinstimmen muss.

Antworten

201 Erstellt

Gibt das erstellte VerbundCredentialDto -Objekt zurück.

400 Ungültige Anforderung

Die Anforderung ist ungültig. Mögliche Ursachen: name ist innerhalb des Clients nicht eindeutig, issuer ist kein gültiger HTTPS-URI, der JWKS-Endpunkt des Ausstellers ist nicht erreichbar, oder das Maximum von 20 Anmeldeinformationen pro Anwendung wurde erreicht.

404 Nicht gefunden

Das angegebene clientId ist nicht vorhanden oder gehört nicht zur Organisation des Aufrufers.

Beispielanforderung

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"
  }'

Beispielantwort

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

---

Rufen Sie verbundene Anmeldeinformationen ab

Rufen Sie bestimmte Verbundanmeldeinformationen anhand ihrer ID ab.

API-Endpunkt

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

Pfadparameter

Parameter	Beschreibung
partitionGlobalId	Die globale ID der Organisation.
clientId	Die ID der externen OAuth-Anwendung.
credentialId	Die ID der verbundenen Anmeldeinformationen.

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Read

Anforderungsheader

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

Antworten

200 OK

Gibt das VerbundedCredentialDto- Objekt für die angeforderten Anmeldeinformationen zurück.

404 Nicht gefunden

Die angegebenen Anmeldeinformationen oder die Anwendung sind in der Organisation des Aufrufers nicht vorhanden.

Beispielanforderung

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

Beispielantwort

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

---

Aktualisieren Sie verbundene Anmeldeinformationen

Aktualisieren Sie vorhandene Verbundanmeldeinformationen. Alle Pflichtfelder müssen im Anforderungstext enthalten sein.

API-Endpunkt

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

Pfadparameter

Parameter	Beschreibung
partitionGlobalId	Die globale ID der Organisation.
clientId	Die ID der externen OAuth-Anwendung.
credentialId	Die ID der verbundenen Anmeldeinformationen, die aktualisiert werden sollen.

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Anforderungstext

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

Feld	Erforderlich	Beschreibung
name	Ja	Ein beschreibender Name für die Anmeldeinformationen. Muss in der Anwendung eindeutig sein. Maximal 128 Zeichen.
description	Nein	Optionaler Kontext für die Anmeldeinformationen. Maximal 512 Zeichen.
issuer	Ja	Der HTTPS-URI des externen Identitätsanbieters. Muss zum Zeitpunkt der Erstellung erreichbar sein.
audience	Ja	Eine einzelne Zeichenfolge, die im JWT aud -Anspruch angezeigt werden muss.
subject	Ja	Ein Wert, der genau mit der JWT-Anforderung sub übereinstimmen muss.

Antworten

200 OK

Gibt das aktualisierte VerbundCredentialDto -Objekt zurück.

400 Ungültige Anforderung

Validierung fehlgeschlagen. Mögliche Ursachen: doppelter name, ungültiger Aussteller-URI oder nicht erreichbarer JWKS-Endpunkt.

Beispielanforderung

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"
  }'

Beispielantwort

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

---

Löschen Sie verbundene Anmeldeinformationen

Löschen Sie verbundene Anmeldeinformationen. Diese Aktion ist dauerhaft und macht jeden Tokenerwerb mit diesen Zugangsdaten sofort ungültig.

Warnung:

Das Löschen ist endgültig. Nach dem Löschen können die Anmeldeinformationen nicht mehr verwendet werden, um neue Zugriffstoken zu erwerben. Zugriffstoken, die bereits vor der Löschung ausgegeben wurden, bleiben gültig, bis sie ablaufen.

API-Endpunkt

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

Pfadparameter

Parameter	Beschreibung
partitionGlobalId	Die globale ID der Organisation.
clientId	Die ID der externen OAuth-Anwendung.
credentialId	Die ID der verbundenen Anmeldeinformationen, die gelöscht werden sollen.

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Antworten

204 Kein Inhalt

Die verbundenen Anmeldeinformationen wurden erfolgreich gelöscht. Der Antworttext ist leer.

404 Nicht gefunden

Die angegebenen Anmeldeinformationen oder die Anwendung sind in der Organisation des Aufrufers nicht vorhanden.

Beispielanforderung

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

---

Erwerben Sie ein Token mithilfe von verbundenen Anmeldeinformationen

Tauschen Sie ein JWT von Ihrem externen Identitätsanbieter gegen ein UiPath-Zugriffstoken aus.

API-Endpunkt

POST {accessURL}/identity_/connect/token

Anforderungsheader

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

Anforderungstext

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}

Parameter	Beschreibung
grant_type	Muss client_credentials sein.
client_id	Die Client-ID der registrierten externen OAuth-Anwendung.
client_assertion_type	Muss urn:ietf:params:oauth:client-assertion-type:jwt-bearer sein.
client_assertion	Das von Ihrem externen Identitätsanbieter ausgestellte JWT.
scope	Die für das Zugriffstoken angeforderten OAuth-Scopes.

Antworten

200 OK

Gibt ein Zugriffstokenobjekt zurück. Verwenden Sie den Wert access_token im Authorization: Bearer -Header nachfolgender API-Aufrufe.

400 Ungültige Anforderung

Fehler beim Tokenerwerb. Mögliche Ursachen: JWT-Signatur ungültig, Aussteller oder Zielgruppe nicht übereinstimmend, Betreff nicht übereinstimmend, abgelaufenes JWT oder JWT ist 8 KB überschritten.

---

Schemas

VerbundAnmeldeinformationsDto

Das von GET-, POST- und PUT-Vorgängen zurückgegebene Objekt.

Eigenschaften	Typ	NULL-fähig	Beschreibung
id	Zeichenfolge (UUID)	Nein	Der eindeutige Bezeichner der verbundenen Anmeldeinformationen.
clientId	string	Ja	Die Anwendungs-ID der externen OAuth-Anwendung, zu der diese Anmeldeinformationen gehören.
name	string	Ja	Der Anzeigename der verbundenen Anmeldeinformationen.
description	string	Ja	Die Beschreibung der verbundenen Anmeldeinformationen.
issuer	string	Ja	Die URL des externen Identitätsanbieters.
audience	string	Ja	Der erwartete Anspruchswert aud im JWT.
subject	string	Ja	Der erwartete Anspruchswert sub im JWT.
createdAt	string (Datum-Uhrzeit)	Nein	Der UTC-Zeitstempel, wann die Anmeldeinformationen erstellt wurden.
updatedAt	string (Datum-Uhrzeit)	Nein	Der UTC-Zeitstempel, wann die Anmeldeinformationen zuletzt aktualisiert wurden.