Créer un client externe

Créez un nouveau client OAuth externe dans une organisation Automation Suite à l’aide de l’API Identity, y compris les champs d’étendue et de corps de la demande requis.

Créez un nouveau client externe.

Point de terminaison de l’API

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

É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 dans Méthodes d'authentification.

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