Erstellen Sie einen externen Client

Erstellen Sie einen neuen externen OAuth-Client in einer Automation Suite-Organisation mithilfe der Identity-API, einschließlich des erforderlichen Scope und der Felder für den Anforderungstext.

Neuen externen Client erstellen.

API-Endpunkt

POST https://{yourDomain}/{organizationName}/identity_/api/ExternalClient

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 unter Authentifizierungsmethoden 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"
    }
  ]
}