applications externes d'administrateur UIP

Syntaxe et options pour `uip admin remote-apps`, qui gère les enregistrements de clients OAuth2 et leurs informations d'identification fédérées pour les intégrations d'applications externes.

uip admin external-apps gère les enregistrements de clients OAuth2 — les applications externes et les services qui s'authentifient par rapport à UiPath en utilisant leur propre ID/clé secrète de client (ou fédération d'identité de charge de travail) plutôt que la propre connexion d'un utilisateur. Chaque application est soit confidentielle (côté serveur, contient un secret), soit non confidentielle (public, par ex. un SPA ou une application mobile, aucun secret). Un groupe federated-credentials imbriqué gère les liaisons charge de travail-identité-génération (par exemple GitHub Actions OIDC) qui permettent à une application externe de s’authentifier sans aucune clé secrète statique.

Synthèse

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>

Verbes

Groupe	Verbe	Objectif
external-apps	list	Répertoriez les applications externes dans la partition.
external-apps	get	Obtenir les détails d'une application par ID de client.
external-apps	create	Enregistrez un nouveau client OAuth2.
external-apps	update	Mettez à jour le nom d'une application, l'URI de redirection ou les étendues.
external-apps	delete	Supprimez une application par ID client.
external-apps	generate-secret	Générez une nouvelle clé secrète de client.
external-apps	delete-secret	Supprimez une clé secrète de client spécifique.
federated-credentials	list	Répertoriez les informations d'identification fédérées d'une application.
federated-credentials	get	Obtenez une information d’identification fédérée par ID.
federated-credentials	create	Liez un fournisseur d’identité externe (par exemple GitHub Actions OIDC) vers l'application.
federated-credentials	update	Mettez à jour un identifiant fédéré.
federated-credentials	delete	Supprimez une information d’identification fédérée.

Concepts

• Confidentiel vs. non confidentiel. La valeur par défaut est confidentielle (côté serveur, obtient une clé secrète de client). --non-confidential crée un client public sans secret — il prend uniquement en charge les étendues --user-scope (déléguées), jamais --app-scope; la transmission de --app-scope sur une application non confidentielle échoue côté client.
• Les étendues sont divisées par type d’accord. --user-scope (délégué, nécessite un utilisateur connecté) et --app-scope (application uniquement, octroi d’informations d’identification au client) sont des listes indépendantes à transmettre l’une ou l’autre. Au moins une est requise sur create. Voir uip admin scopes list pour obtenir le catalogue complet des noms d'étendues disponibles.
• --scope est un alias obsolète pour --app-scope Si les deux sont donnés, --app-scope l'emporte; une valeur vide sur l'une ou l'autre (une chaîne vide ou constituée d'espaces uniquement) est rejetée plutôt que traitée en mode silencieux comme « aucune étendue».
• Un URI de redirection est requis chaque fois que des étendues d'utilisateurs sont impliquées , soit parce que l'application n'est pas confidentielle, soit parce que --user-scope a été transmis, car les deux ont besoin du flux de code d'autorisation OAuth2. Une application confidentielle et spécifique à l’application n’en a pas besoin.
• update extrait à nouveau les étendues des ressources lorsque vous n'en transmettez aucune — si vous omettez à la fois --user-scope et --app-scope, la commande renvoie les étendues existantes de l'application inchangées plutôt que de les effacer; la même validation non confidentielle/redirection-URI que create s’applique toujours à l’ensemble de l’étendue finale et à l’URI de redirection.
• Les clés secrètes s'affichent une fois. La valeur renvoyée par generate-secret ne peut pas être récupérée à nouveau — l'enregistrer immédiatement.

Administrateur UIP - Liste d'applications externes

Répertoriez les applications externes dans la partition. Aucune option de filtrage/pagination.

Exemple

uip admin external-apps list

Format des données (--sortie json)

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

admin-uip apps-externes obtenir

Obtenez les détails de l’application externe par ID client.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe. Trouvez-le avec external-apps list.

Exemple

uip admin external-apps get my-app

Format des données (--sortie json)

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

création d'applications externes d'administrateur UiP

Créez une application externe ( confidentielle par défaut).

Arguments

Nom	Requis	Objectif
<name>	oui	Nom complet de l'application.

Options

Long	Valeur (Value)	Description
--redirect-uri <uri>	Séparé par des virgules	URI de redirection pour le flux OAuth2. Obligatoire lorsque la valeur n'est pas confidentielle ou lorsque l'option --user-scope est définie.
--user-scope <scopes>	séparés par des virgules ou des espaces	Étendues déléguées (utilisateur).
--app-scope <scopes>	séparés par des virgules ou des espaces	Étendues d'application (application uniquement). Non autorisé sur une application non confidentielle.
--scope <scopes>	séparés par des virgules ou des espaces	Alias obsolète pour --app-scope.
--non-confidential	Drapeau	Créez un client public (aucun secret).
--no-secret	Drapeau	Ignorer la génération d'une clé secrète de client lors de la création (applications confidentielles uniquement).

Au moins une des propriétés --user-scope/--app-scope est requise.

Exemples

# 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"

Format des données (--sortie json)

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

secret est présent uniquement pour une application confidentielle créée sans --no-secret.

mise à jour des applications externes d’administrateur UiP

Mettez à jour le nom d'une application, l'URI de redirection ou les étendues. Au moins une des --name/--redirect-uri/--user-scope/--app-scope est requise.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.

Options

Long	Short	Valeur (Value)	Description
--name <name>	-n	string	Nouveau nom complet.
--redirect-uri <uri>		Séparé par des virgules	Nouveaux URI de redirection.
--user-scope <scopes>		séparés par des virgules ou des espaces	Nouvelles étendues déléguées.
--app-scope <scopes>		séparés par des virgules ou des espaces	Nouvelles étendues d'application.
--scope <scopes>		séparés par des virgules ou des espaces	Alias obsolète pour --app-scope.

Exemple

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

Format des données (--sortie json)

{ "Code": "ExternalClientUpdated" }

Administrateur UIP suppression d'applications externes

Supprimez une application externe par ID client.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.

Exemple

uip admin external-apps delete my-app-id

Format des données (--sortie json)

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

Administrateur UIP External-Appsgenerate-Secret

Générez une nouvelle clé secrète pour une application externe. La valeur du secret ne s'affiche qu'une seule fois.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.

Options

Long	Valeur (Value)	Description
--description <text>	string	Description de la clé secrète.
--expiration <date>	ISO 8601	Date d’expiration.

Exemple

uip admin external-apps generate-secret my-app

Format des données (--sortie json)

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

Administrateur UIP External-Apps Delete-Secret

Supprimer un secret spécifique d’une application externe — une application peut avoir plusieurs secrets actifs; cela n'en supprime qu'une seule.

Arguments

Nom	Requis	Objectif
<secret-id>	oui	ID du secret (numérique). Retrouvez-le via external-apps get.

Exemple

uip admin external-apps delete-secret 12345

Format des données (--sortie json)

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

Administrateur UIP externe-apps - Liste des informations d’identification workflows

Répertoriez les informations d’identification fédérées pour une application externe.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.

Exemple

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

Format des données (--sortie json)

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

admin-uip External-apps driven-redentials - Obtenir

Obtenez une information d’identification fédérée par ID.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.
<credential-id>	oui	ID d’informations d’identification fédéré.

Exemple

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

Format des données (--sortie 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"
  }
}

Création de l’administrateur UiPath External-Apps Federated-Credentials

Lier un fournisseur d'identité externe à l'application - active la fédération d'identité de la charge de travail (par exemple, un workflow GitHub Actions s'authentifiant sans secret stocké).

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.

Options

Long	Short	Valeur (Value)	Requis	Description
--name <name>	-n	string	oui	Nom des informations d’identification.
--issuer <url>		url	oui	URL de l'émetteur du jeton, par ex. https://token.actions.githubusercontent.com.
--audience <audience>		string	oui	Revendication d'audience attendue, par exemple api://AzureADTokenExchange.
--subject <subject>		string	oui	Revendication d’objet attendue, par exemple repo:org/repo:ref:refs/heads/main.
--description <text>		string	non	Description.

Exemple

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"

Format des données (--sortie json)

{ "Code": "FederatedCredentialCreated" }

Mise à jour des informations d’identification défiénées dans les applications externes d’administrateur UIP

Mettez à jour des informations d'identification fédérées — les quatre champs d'identité sont requis pour chaque appel (aucune mise à jour partielle).

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.
<credential-id>	oui	ID d’informations d’identification fédéré.

Options

Long	Short	Valeur (Value)	Requis	Description
--name <name>	-n	string	oui	Nom des informations d’identification.
--issuer <url>		url	oui	URL de l’émetteur du jeton.
--audience <audience>		string	oui	Revendication d'audience attendue.
--subject <subject>		string	oui	Revendication de l'objet attendue.
--description <text>		string	non	Description.

Exemple

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"

Format des données (--sortie json)

{ "Code": "FederatedCredentialUpdated" }

admin-uip External-apps driven-redentials - Suppression

Supprimez les informations d’identification fédérées d’une application externe.

Arguments

Nom	Requis	Objectif
<client-id>	oui	ID d’application externe.
<credential-id>	oui	ID d’informations d’identification fédéré.

Exemple

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

Format des données (--sortie json)

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

Associé

• uip admin robot-accounts / pat / scopes — le catalogue d'étendues OAuth2 partagé à partir duquel ces applications s'appuient.
• uip admin users — utilisateurs et groupes de l'annuaire.
• uip admin smtp — configuration des e-mails de l'organisation.

Voir également

• Options globales
• Codes de sortie