外部クライアントを更新する

Identity API を使用して、Automation Suite 組織内の外部 OAuth クライアントの名前、リダイレクト URL、スコープ、証明書を更新します。

外部 OAuth アプリケーションの名前、リダイレクト URL、スコープ、または証明書を更新します。

API エンドポイント

PUT https://{yourDomain}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

スコープ

次のスコープのいずれかが必要です。

• PM.OAuthApp
• PM.OAuthApp.Write

要求ヘッダー

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

注:

{access_token}を取得するには、「認証方法」に記載されているいずれかの方法で認証を行ってください。

要求本文

要求本文には、特定の外部クライアントが存在する組織 ID と、対応するクライアント ID が含まれます。

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

応答

200 サクセス

指定した外部クライアントが正常に更新されました。

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