UIP-Administrator externe Apps

Syntax und Optionen für „uip admin External-apps“, das OAuth2-Client-Registrierungen und deren verbundene Anmeldeinformationen für externe Anwendungsintegrationen verwaltet.

uip admin external-apps verwaltet OAuth2-Client-Registrierungen – externe Anwendungen und Dienste, die sich bei UiPath mit ihrer eigenen Client-ID/ihrem eigenen Client-Geheimnis (oder Workload-Identitätsvertrag) anstelle der eigenen Anmeldung eines Benutzers authentifizieren. Jede App ist entweder vertraulich (serverseitig, hat ein Geheimnis) oder nicht vertraulich (öffentlich, z. B. eine Spa- oder Mobilgeräte-App, kein Geheimnis). Eine geschachtelte federated-credentials -Gruppe verwaltet Workload-Identity-Folderation-Bindungen (z. B. GitHub Actions OIDC), mit denen sich eine externe App ohne statisches Geheimnis authentifizieren kann.

Zusammenfassung

uip admin external-apps list
uip admin external-apps get <client-id>
uip admin external-apps create <name> [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>] [--non-confidential] [--no-secret]
uip admin external-apps update <client-id> [--name <name>] [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>]
uip admin external-apps delete <client-id>
uip admin external-apps generate-secret <client-id> [--description <text>] [--expiration <date>]
uip admin external-apps delete-secret <secret-id>

uip admin external-apps federated-credentials list <client-id>
uip admin external-apps federated-credentials get <client-id> <credential-id>
uip admin external-apps federated-credentials create <client-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials update <client-id> <credential-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials delete <client-id> <credential-id>

Verben

„Gruppieren“ (Group)	Verb	Zweck
external-apps	list	Listen Sie externe Apps in der Partition auf.
external-apps	get	Rufen Sie die Details einer App nach Client-ID ab.
external-apps	create	Registrieren Sie einen neuen OAuth2-Client.
external-apps	update	Aktualisieren Sie den Namen einer App, den Umleitungs-URI oder die Scopes.
external-apps	delete	Löschen Sie eine App anhand der Client-ID.
external-apps	generate-secret	Generieren Sie einen neuen geheimen Clientschlüssel.
external-apps	delete-secret	Löschen Sie einen bestimmten geheimen Clientschlüssel.
federated-credentials	list	Listen Sie die Verbundanmeldeinformationen einer App auf.
federated-credentials	get	Rufen Sie verbundene Anmeldeinformationen nach ID ab.
federated-credentials	create	Binden Sie einen externen Identitätsanbieter (z. B. GitHub Actions OIDC) für die App.
federated-credentials	update	Aktualisieren Sie eine Verbundanmeldeinformation.
federated-credentials	delete	Entfernen Sie eine Verbundanmeldeinformation.

Konzepte

• Vertraulich vs. nicht vertraulich. Der Standardwert ist vertraulich (serverseitig, ruft einen geheimen Clientschlüssel ab). --non-confidential erstellt einen öffentlichen Client ohne Geheimnis – es unterstützt nur --user-scope (delegierte) Scopes, niemals --app-scope; Das Übergeben von --app-scope an eine nicht vertrauliche App schlägt auf Clientseite fehl.
• Die Scopes werden nach Gewährungstyp aufgeteilt. --user-scope (delegiert, erfordert einen angemeldeten Benutzer) und --app-scope (nur App, Gewährung von Client-Anmeldeinformationen) sind unabhängige Listen – entweder übergeben oder beide. Für create ist mindestens eine erforderlich. Den vollständigen Katalog der verfügbaren Scope-Namen finden Sie unter uip admin scopes list .
• --scope ist ein veralteter Alias für --app-scope. Wenn beides angegeben ist, gewinnt --app-scope; Ein leerer Wert auf entweder (eine leere oder nur Leerzeichen-Zeichenfolge) wird abgelehnt, anstatt im Hintergrund als „keine Scopes“ behandelt zu werden.
• Ein Umleitungs-URI ist immer dann erforderlich, wenn Benutzer-Scopes beteiligt sind – entweder, weil die App nicht vertraulich ist oder weil --user-scope übergeben wurde –, da beide den OAuth2-Autorisierungscode-Flow benötigen. Eine App, die vertraulich ist und nur den App-Scope umfasst, benötigt keinen.
• update leitet Scopes erneut von Ressourcen ab, wenn Sie keine übergeben – wenn Sie sowohl --user-scope als --app-scope weglassen, sendet der Befehl die vorhandenen Scopes der App unverändert, anstatt sie zu löschen; Dieselbe nicht vertrauliche/Umleitungs-URI-Validierung wie create gilt weiterhin für den endgültigen Scope und den Umleitungs-URI.
• Geheimnisse werden einmal angezeigt. Der zurückgegebene Wert von generate-secret kann nicht erneut abgerufen werden – speichern Sie ihn sofort.

UIP-Administrator der externen Apps-Liste

Listen Sie externe Apps in der Partition auf. Keine Filter-/Paginierungsoptionen.

Beispiel

uip admin external-apps list

Datenform (--output json)

{ "Code": "ExternalClientList", "Data": [{ "id": "my-app", "name": "My Application", "isConfidential": true }] }

Abrufen externer Apps durch UIP-Administrator

Rufen Sie Details der externen App nach Client-ID ab.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App. Finden Sie es mit external-apps list.

Beispiel

uip admin external-apps get my-app

Datenform (--output json)

{ "Code": "ExternalClientDetails", "Data": { "id": "my-app", "name": "My Application", "isConfidential": true, "redirectUri": "https://example.com/callback" } }

UIP-Administrator externen Apps erstellen

Erstellen Sie eine externe App (standardmäßig vertraulich).

Argumente

Name	Erforderlich	Zweck
<name>	ja	Anzeigename der App.

Optionen

Long	Wert	Beschreibung
--redirect-uri <uri>	durch Kommas getrennt sind	Umleitungs-URI(s) für den OAuth2-Flow. Erforderlich, wenn es nicht vertraulich ist oder wenn --user-scope festgelegt ist.
--user-scope <scopes>	durch Komma oder Leerzeichen getrennt werden	Delegierte (Benutzer-)Scopes.
--app-scope <scopes>	durch Komma oder Leerzeichen getrennt werden	Anwendungs-Scopes (nur App). Nicht zulässig für eine nicht vertrauliche App.
--scope <scopes>	durch Komma oder Leerzeichen getrennt werden	Veralteter Alias für --app-scope.
--non-confidential	Markieren	Erstellen Sie einen öffentlichen Client (kein Geheimnis).
--no-secret	Markieren	Generieren eines geheimen Clientschlüssels bei der Erstellung überspringen (nur vertrauliche Apps).

Mindestens eines von --user-scope/--app-scope ist erforderlich.

Beispiele

# Confidential app with application scopes only
uip admin external-apps create "My App" --app-scope "OR.Folders,OR.Assets"

# Confidential app with both user and app scopes
uip admin external-apps create "My App" --user-scope "OR.Folders" --app-scope "OR.Jobs" --redirect-uri "https://example.com/callback"

# Public client (SPA) with user scopes
uip admin external-apps create "My SPA" --non-confidential --user-scope "OR.Folders" --redirect-uri "http://localhost:3000/callback"

Datenform (--output json)

{ "Code": "ExternalClientCreated", "Data": { "id": "my-app", "name": "My App", "isConfidential": true, "secret": "generated-secret-value" } }

secret ist nur für eine vertrauliche App vorhanden, die ohne --no-secret erstellt wurde.

UIP-Administratorexterne Apps aktualisieren

Aktualisieren Sie den Namen einer App, den Umleitungs-URI oder die Scopes. Mindestens eines von --name/--redirect-uri/--user-scope/--app-scope ist erforderlich.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.

Optionen

Long	Short	Wert	Beschreibung
--name <name>	-n	string	Neuer Anzeigename.
--redirect-uri <uri>		durch Kommas getrennt sind	Neue(n) Umleitungs-URI(s).
--user-scope <scopes>		durch Komma oder Leerzeichen getrennt werden	Neue delegierte Scopes.
--app-scope <scopes>		durch Komma oder Leerzeichen getrennt werden	Neue Anwendungs-Scopes.
--scope <scopes>		durch Komma oder Leerzeichen getrennt werden	Veralteter Alias für --app-scope.

Beispiel

uip admin external-apps update my-app-id --name "Updated App" --app-scope "OR.Folders"

Datenform (--output json)

{ "Code": "ExternalClientUpdated" }

UIP-Administrator externen Apps löschen

Löschen Sie eine externe App anhand der Client-ID.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.

Beispiel

uip admin external-apps delete my-app-id

Datenform (--output json)

{ "Code": "ExternalClientDeleted", "Data": { "Id": "my-app-id", "Status": "Deleted successfully" } }

UIP-Administrator externen Apps generieren Geheimnis

Generieren Sie ein neues Geheimnis für eine externe App. Der geheime Wert wird nur einmal angezeigt.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.

Optionen

Long	Wert	Beschreibung
--description <text>	string	Beschreibung für das Geheimnis.
--expiration <date>	ISO 8601	Ablaufdatum.

Beispiel

uip admin external-apps generate-secret my-app

Datenform (--output json)

{ "Code": "ExternalClientSecretGenerated", "Data": { "id": 1, "secret": "generated-secret-value" } }

UIP-Administrator externen Apps löschen-Geheimnis

Ein bestimmtes Geheimnis aus einer externen App löschen – eine App kann mehrere aktive Geheimnisse haben; dadurch wird nur eines entfernt.

Argumente

Name	Erforderlich	Zweck
<secret-id>	ja	Geheime ID (numerisch). Zu finden über external-apps get.

Beispiel

uip admin external-apps delete-secret 12345

Datenform (--output json)

{ "Code": "ExternalClientSecretDeleted", "Data": { "Id": "12345", "Status": "Deleted successfully" } }

UIP-Administrator externen-Apps föderierte-credentials-Liste

Listen Sie Verbundanmeldeinformationen für eine externe App auf.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.

Beispiel

uip admin external-apps federated-credentials list my-app-id

Datenform (--output json)

{ "Code": "FederatedCredentialList", "Data": [{ "id": "fc000000-0000-0000-0000-000000000001", "name": "GitHub Actions", "issuer": "https://token.actions.githubusercontent.com" }] }

UIP-Administrator für das Abrufen externer Apps föderierter Anmeldeinformationen

Rufen Sie verbundene Anmeldeinformationen nach ID ab.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.
<credential-id>	ja	Verbund-Anmeldeinformations-ID (UUID).

Beispiel

uip admin external-apps federated-credentials get my-app-id fc000000-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "FederatedCredentialDetails",
  "Data": {
    "id": "fc000000-0000-0000-0000-000000000001",
    "name": "GitHub Actions",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "api://AzureADTokenExchange",
    "subject": "repo:org/repo:ref:refs/heads/main"
  }
}

UIP-Administrator externe-Apps föderierte-Anmeldeinformationen erstellen

Binden Sie einen externen Identitätsanbieter an die App – ermöglicht einen Verbund der Workload-Identität (z. B. einen GitHub Actions-Workflow, der ohne gespeichertes Geheimnis authentifiziert wird).

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.

Optionen

Long	Short	Wert	Erforderlich	Beschreibung
--name <name>	-n	string	ja	Anmeldeinformationsname.
--issuer <url>		url	ja	URL des Tokenausstellers, z. B https://token.actions.githubusercontent.com).
--audience <audience>		string	ja	Erwartete Zielgruppenanspruch, z. B api://AzureADTokenExchange).
--subject <subject>		string	ja	Erwarteter Anspruch auf Betreff, z. B. repo:org/repo:ref:refs/heads/main).
--description <text>		string	nein	Beschreibung.

Beispiel

uip admin external-apps federated-credentials create my-app-id \
  --name "GitHub Actions" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:ref:refs/heads/main"

Datenform (--output json)

{ "Code": "FederatedCredentialCreated" }

Aktualisierung der UIP-Administrator externen-Apps Verbund-Anmeldeinformationen

Aktualisieren Sie eine Verbundanmeldeinformation – alle vier Identitätsfelder sind bei jedem Aufruf erforderlich (keine teilweise Aktualisierung).

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.
<credential-id>	ja	Verbund-Anmeldeinformations-ID (UUID).

Optionen

Long	Short	Wert	Erforderlich	Beschreibung
--name <name>	-n	string	ja	Anmeldeinformationsname.
--issuer <url>		url	ja	URL des Tokenausstellers.
--audience <audience>		string	ja	Erwartete Zielgruppenanspruch.
--subject <subject>		string	ja	Erwarteter Anspruch auf Betreff.
--description <text>		string	nein	Beschreibung.

Beispiel

uip admin external-apps federated-credentials update my-app-id fc000000-0000-0000-0000-000000000001 \
  --name "GitHub Actions (prod)" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:environment:production"

Datenform (--output json)

{ "Code": "FederatedCredentialUpdated" }

UIP-Administrator externen-Apps föderierte-Anmeldeinformationen löschen

Löschen Sie Verbundanmeldeinformationen aus einer externen App.

Argumente

Name	Erforderlich	Zweck
<client-id>	ja	ID der externen App.
<credential-id>	ja	Verbund-Anmeldeinformations-ID (UUID).

Beispiel

uip admin external-apps federated-credentials delete my-app-id fc000000-0000-0000-0000-000000000001

Datenform (--output json)

{ "Code": "FederatedCredentialDeleted", "Data": { "Id": "fc000000-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

Zugehörig

• uip admin robot-accounts / pat / scopes – der gemeinsame OAuth2-Scope-Katalog, aus dem diese Apps stammen.
• uip admin users – Verzeichnisbenutzer und -gruppen.
• uip admin smtp – E-Mail-Konfiguration der Organisation.

Siehe auch

• Globale Optionen
• Exitcodes