Client externe — Informations d'identification fédérées

Les informations d'identification fédérées permettent à une application externe OAuth de s'authentifier auprès d'UiPath à l'aide d'un jeton Web JSON (JWT) émis par un fournisseur d'identité externe, sans avoir besoin d'une clé secrète de client. Chaque application prend en charge un maximum de 20 informations d'identification fédérées.

Utilisez les points de terminaison de cette page pour répertorier, créer, récupérer, mettre à jour et supprimer des informations d’identification fédérées pour une application externe OAuth enregistrée. Pour gérer les applications externes elles-mêmes, consultez Gestion des applications externes OAuth.

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Automation Cloud	https://cloud.uipath.com
Automation Cloud pour le Secteur public	https://govcloud.uipath.us
Cloud d'automatisation dédié	https://{customURL}.dedicated.uipath.com

---

Répertorier les informations d’identification fédérées

Récupérez toutes les informations d'identification fédérées enregistrées pour une application externe OAuth spécifique.

Point de terminaison de l’API

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

Paramètres de chemin d'accès

Paramètre	Description
partitionGlobalId	L’ID global de l’organisation.
clientId	ID de l’application externe OAuth.

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Read

En-têtes de requête.

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

Remarque :

Pour obtenir le {access_token}, utilisez un jeton d'administrateur d'organisation ou authentifiez-vous via l'une des méthodes décrites dans Méthodes d'authentification.

Réponses

200 OK

Renvoie un tableau d'objets FederatedCredentialDto . Renvoie un tableau vide si aucune information d'identification n'est enregistrée.

Exemple de requête

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

Exemple de réponse

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

---

Créer un identifiant fédéré

Créez des informations d’identification d’identité fédérée pour une application externe OAuth spécifique.

Remarque :

Chaque application prend en charge un maximum de 20 informations d'identification fédérées.

Point de terminaison de l’API

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

Paramètres de chemin d'accès

Paramètre	Description
partitionGlobalId	L’ID global de l’organisation.
clientId	ID de l’application externe OAuth.

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write

En-têtes de requête.

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

Corps de la requête

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

Champ	Requis	Description
name	Oui (Yes)	Un nom descriptif pour l'identifiant. Doit être unique dans l'application. 128 caractères maximum.
description	Non (No)	Contexte facultatif de l'identifiant. 512 caractères maximum.
issuer	Oui (Yes)	L’URI HTTPS du fournisseur d’identité externe. Doit être accessible au moment de la création.
audience	Oui (Yes)	Une seule chaîne qui doit apparaître dans la revendication JWT aud .
subject	Oui (Yes)	Une valeur qui doit correspondre exactement à la revendication JWT sub .

Réponses

201 Créé

Renvoie l'objet FederatedCredentialDto créé.

400 Requête incorrecte

La requête n’est pas valide. Causes possibles : name n'est pas unique dans le client, issuer n'est pas un URI HTTPS valide, le point de terminaison JWKS de l'émetteur est inaccessible ou le maximum de 20 informations d'identification par application a été atteint.

Erreur 404 - Page introuvable

Le clientId spécifié n’existe pas ou n’appartient pas à l’organisation de l’appelant.

Exemple de requête

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

Exemple de réponse

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

---

Obtenir un identifiant fédéré

Récupérez un identifiant fédéré spécifique par son ID.

Point de terminaison de l’API

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

Paramètres de chemin d'accès

Paramètre	Description
partitionGlobalId	L’ID global de l’organisation.
clientId	ID de l’application externe OAuth.
credentialId	L'ID de l'identifiant fédéré.

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Read

En-têtes de requête.

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

Réponses

200 OK

Renvoie l'objet FederatedCredentialDto pour les informations d'identification demandées.

Erreur 404 - Page introuvable

Les identifiants ou l'application spécifiés n'existent pas dans l'organisation de l'appelant.

Exemple de requête

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

Exemple de réponse

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

---

Mettre à jour un identifiant fédéré

Mettez à jour un identifiant fédéré existant. Tous les champs obligatoires doivent être inclus dans le corps de la requête.

Point de terminaison de l’API

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

Paramètres de chemin d'accès

Paramètre	Description
partitionGlobalId	L’ID global de l’organisation.
clientId	ID de l’application externe OAuth.
credentialId	L'ID de l'identifiant fédéré à mettre à jour.

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write

En-têtes de requête.

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

Corps de la requête

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

Champ	Requis	Description
name	Oui (Yes)	Un nom descriptif pour l'identifiant. Doit être unique dans l'application. 128 caractères maximum.
description	Non (No)	Contexte facultatif de l'identifiant. 512 caractères maximum.
issuer	Oui (Yes)	L’URI HTTPS du fournisseur d’identité externe. Doit être accessible au moment de la création.
audience	Oui (Yes)	Une seule chaîne qui doit apparaître dans la revendication JWT aud .
subject	Oui (Yes)	Une valeur qui doit correspondre exactement à la revendication JWT sub .

Réponses

200 OK

Renvoie l'objet FederatedCredentialDto mis à jour.

400 Requête incorrecte

Échec de la validation. Causes possibles : name présent en double, URI d’émetteur non valide ou un point de terminaison JWKS inaccessible.

Exemple de requête

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

Exemple de réponse

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

---

Supprimer un identifiant fédéré

Supprimez un identifiant fédéré. Cette action est permanente et invalide immédiatement toute acquisition de jeton utilisant ces informations d’identification.

Avertissement :

La suppression est permanente. Après sa suppression, les informations d’identification ne peuvent plus être utilisées pour acquérir de nouveaux jetons d’accès. Les jetons d’accès déjà émis avant la suppression restent valides jusqu’à leur expiration.

Point de terminaison de l’API

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

Paramètres de chemin d'accès

Paramètre	Description
partitionGlobalId	L’ID global de l’organisation.
clientId	ID de l’application externe OAuth.
credentialId	L'ID de l'identifiant fédéré à supprimer.

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write

En-têtes de requête.

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

Réponses

204 Aucun contenu

Les informations d’identification fédérées ont été supprimées avec succès. Le corps de la réponse est vide.

Erreur 404 - Page introuvable

Les identifiants ou l'application spécifiés n'existent pas dans l'organisation de l'appelant.

Exemple de requête

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

---

Obtenir un jeton à l'aide d'informations d’identification fédérées

Échangez un JWT avec votre fournisseur d’identité externe pour un jeton d’accès UiPath.

Point de terminaison de l’API

POST {accessURL}/identity_/connect/token

En-têtes de requête.

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

Corps de la requête

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}

Paramètre	Description
grant_type	Doit être client_credentials.
client_id	ID client de l'application externe OAuth enregistrée.
client_assertion_type	Doit être urn:ietf:params:oauth:client-assertion-type:jwt-bearer.
client_assertion	Le JWT émis par votre fournisseur d’identité externe.
scope	Les étendues OAuth demandées pour le jeton d’accès.

Réponses

200 OK

Renvoie un objet jeton d’accès. Utilisez la valeur access_token dans l'en-tête Authorization: Bearer des appels d'API suivants.

400 Requête incorrecte

L’acquisition du jeton a échoué. Causes possibles : signature JWT invalide, incompatibilité de l’émetteur ou de l’audience, incompatibilité d’objet JWT expiré ; ou JWT dépasse 8 ko.

---

Schémas

Dto_informations d’identification fédérées

Objet renvoyé par les opérations GET, POST et PUT.

Propriété	Saisie de texte	Nullable	Description
id	chaîne (UUID)	Non (No)	L'identifiant unique de l'identifiant fédéré.
clientId	string	Oui (Yes)	ID d'application de l'application externe OAuth à laquelle appartiennent ces informations d'identification.
name	string	Oui (Yes)	Le nom complet de l'identifiant fédéré.
description	string	Oui (Yes)	La description de l'identifiant fédéré.
issuer	string	Oui (Yes)	URL du fournisseur d’identité externe.
audience	string	Oui (Yes)	La valeur de la revendication aud attendue dans le JWT.
subject	string	Oui (Yes)	La valeur de la revendication sub attendue dans le JWT.
createdAt	string (date-time)	Non (No)	L’horodatage UTC lors de la création des informations d’identification.
updatedAt	string (date-time)	Non (No)	L’horodatage UTC lorsque les informations d’identification ont été mises à jour pour la dernière fois.