ClientExterne

Lister tous les clients externes

Obtenir la liste complète des clients externes d'une organisation.

Point de terminaison de l’API

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

É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}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la requête contient l'ID de l'organisation à partir de laquelle vous souhaitez récupérer les clients externes.

{
  "partitionGlobalId": "<organizationId>"
}

Réponses

200 Réussite

La liste des clients externes pour une organisation donnée a été récupérée avec succès.

[
  {
    "name": "string",
    "id": "string",
    "secret": "string",
    "isConfidential": true,
    "redirectUri": "string",
    "resources": [
      {
        "name": "string",
        "displayName": "string",
        "description": "string",
        "scopes": [
          {
            "name": "string",
            "displayName": "string",
            "description": "string",
            "type": "user"
          }
        ]
      }
    ],
    "secrets": [
      {
        "id": 0,
        "description": "string",
        "secret": "string",
        "creationTime": "2025-07-18T12:52:37.566Z",
        "expiryTime": "2025-07-18T12:52:37.566Z"
      }
    ]
  }
]

Obtenir les détails d'un client externe spécifique

Obtenez un client externe spécifique d'une organisation et obtenez l' ID du secret de la plus ancienne clé secrète.

Point de terminaison de l’API

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

É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}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la demande contient l'ID de l'organisation à partir de laquelle vous souhaitez obtenir le client externe, ainsi que l'ID client correspondant.

{
  "partitionGlobalId": "<organizationId>"
  "clientId": "<clientId>"
}

Réponses

200 Réussite

Le client externe a été récupéré avec succès.

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T12:57:01.155Z",
      "expiryTime": "2025-07-18T12:57:01.155Z"
    }
  ]
}

Mettre à jour un client externe

Mettez à jour le nom, l'URL de redirection, les étendues ou les certificats d'une application OAuth.

Point de terminaison de l’API

PUT {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la requête contient l'ID de l'organisation où se trouve le client externe spécifique, ainsi que l'ID client correspondant.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Réponses

200 Réussite

Le client externe spécifié a été mis à jour avec succès.

Example Value
Schema
{
  "name": "string",
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

Supprimer des clients externes

Supprimez un client externe spécifique.

Point de terminaison de l’API

DELETE {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la requête contient l'ID de l'organisation à partir de laquelle vous souhaitez supprimer le client externe, ainsi que l'ID client correspondant.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Réponses

204 Aucun contenu

Le client externe a été supprimé avec succès. Aucune valeur n'est renvoyée.

Créer un nouveau client externe

Créez un nouveau client externe.

Point de terminaison de l’API

POST {accessURL}/{organizationName}/identity_/api/ExternalClient

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la demande comprend l'ID de l'organisation, le nom du client externe, son statut de confidentialité, l'URI de redirection, les étendues requises et les certificats client.

{
  "partitionGlobalId": "orgId",
  "name": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

Réponses

201 Créé

Le client externe a été créé avec succès.

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T13:53:12.823Z",
      "expiryTime": "2025-07-18T13:53:12.823Z"
    }
  ]
}

Générer une nouvelle clé secrète

Générez une nouvelle clé secrète de client pour le client externe donné.

Point de terminaison de l’API

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

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthSecret.Write

En-têtes de requête.

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la requête contient l'ID de l'organisation où se trouve le client externe, ainsi que l'ID client correspondant.

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

Réponses

200 Réussite

La clé secrète du client a été créée avec succès pour le client externe donné.

"string"

Générer un nouveau client externe

Générez un nouveau client externe.

Point de terminaison de l’API

POST {accessURL}/{organizationName}/identity_/api/ExternalClient/GenerateSecret

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthAppSecret.Write

En-têtes de requête.

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la demande contient l'ID client pour lequel vous souhaitez générer une clé secrète, une description correspondante, ainsi que l'ID de l'organisation.

{
  "clientId": "string",
  "description": "string",
  "partitionGlobalId": "orgId",
  "expiryTime": "2025-07-18T13:24:15.806Z"
}

Réponses

200 Réussite

Une nouvelle clé secrète de client a été générée avec succès pour le client externe donné.

{
  "id": 0,
  "description": "string",
  "secret": "string",
  "creationTime": "2025-07-18T13:56:16.889Z",
  "expiryTime": "2025-07-18T13:56:16.889Z"

Supprimer une clé secrète de client

Supprimez une clé secrète de client.

Point de terminaison de l’API

DELETE {accessURL}/{organizationName}/identity_/api/{partitionGlobalId}/secrets/{secretsId}

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

Nécessite l’une des étendues suivantes :

• PM.OAuthApp
• PM.OAuthApp.Write
• PM.OAuthAppSecret.Write

En-têtes de requête.

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la requête contient l'ID de l'organisation et l'ID de la clé secrète du client que vous souhaitez supprimer.

{
  "partitionGlobalId": "<organizationId>",
  "secretId": "<secretId>"
}

Réponses

204 Aucun contenu

La suppression de la clé secrète du client a été effectuée. Aucune valeur n'est renvoyée.