ExternerClient

Externe Client-API-Endpunkte in Test Cloud zur Auflistung, zum Erstellen, Aktualisieren und Löschen von OAuth-Anwendungen, die für eine Organisation registriert sind.

Listen Sie alle externen Clients auf

Rufen Sie die vollständige Liste der externen Kunden für eine Organisation ab.

API-Endpunkt

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

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/

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, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, von der Sie die externen Clients abrufen möchten.

{
  "partitionGlobalId": "<organizationId>"
}

Antworten

200 Erfolg

Die Liste der externen Clients für eine bestimmte Organisation wurde erfolgreich abgerufen.

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

Rufen Sie Details für einen bestimmten externen Client ab

Rufen Sie einen bestimmten externen Client von einer Organisation ab und rufen Sie die Geheimnis-ID des ältesten Geheimnisses ab.

API-Endpunkt

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

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/

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, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, von der Sie den externen Client abrufen möchten, und die entsprechende Client-ID.

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

Antworten

200 Erfolg

Der externe Client wurde erfolgreich abgerufen.

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

Aktualisieren Sie einen externen Client

Aktualisieren Sie den Namen, die Umleitungs-URL, Scopes oder Zertifikate einer externen OAuth-Anwendung.

API-Endpunkt

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

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/

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, in der sich der spezifische externe Client befindet, und die entsprechende Client-ID.

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

Antworten

200 Erfolg

Der angegebene externe Client wurde erfolgreich aktualisiert.

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

Löschen Sie externe Clients

Löschen Sie einen bestimmten externen Client.

API-Endpunkt

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

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/

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, aus der Sie den externen Client löschen möchten, und die entsprechende Client-ID.

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

Antworten

204 No content

Der externe Client wurde erfolgreich gelöscht. Es werden keine Werte zurückgegeben.

Neuen externen Client erstellen

Neuen externen Client erstellen.

API-Endpunkt

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

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/

Scopes

Erfordert einen der folgenden Scopes:

• PM.OAuthApp
• PM.OAuthApp.Write

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, den Namen des externen Clients, seinen Vertraulichkeitsstatus, den Umleitungs-URI, die erforderlichen Scopes und die Clientzertifikate.

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

Antworten

201 Erstellt

Der externe Client wurde erfolgreich erstellt.

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

Neues Geheimnis generieren

Generiert einen neuen geheimen Clientschlüssel für den angegebenen externen Client.

API-Endpunkt

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

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/

Scopes

Erfordert einen der folgenden Scopes:

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

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, in der sich der externe Client befindet, und die entsprechende Client-ID.

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

Antworten

200 Erfolg

Der geheime Clientschlüssel wurde erfolgreich für den angegebenen externen Client erstellt.

"string"

Neuen externen Client generieren

Neuen externen Client generieren.

API-Endpunkt

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

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/

Scopes

Erfordert einen der folgenden Scopes:

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

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Client-ID, für die Sie ein Geheimnis generieren möchten, eine entsprechende Beschreibung und die Organisations-ID.

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

Antworten

200 Erfolg

Ein neuer geheimer Clientschlüssel wurde für den angegebenen externen Client erfolgreich generiert.

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

Löschen Sie einen geheimen Clientschlüssel

Löschen Sie einen geheimen Clientschlüssel.

API-Endpunkt

DELETE {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/secrets/{secretId}

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/

Scopes

Erfordert einen der folgenden Scopes:

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

Anforderungsheader

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

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID und die ID des geheimen Clientschlüssels, den Sie löschen möchten.

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

Antworten

204 No content

Der geheime Clientschlüssel wurde erfolgreich gelöscht. Es wird kein Wert zurückgegeben.