List all external clients

Retrieve a list of all external OAuth clients for an Automation Suite organization using the Identity API, including required scope and response schema.

Get the full list of external clients for an organization.

API endpoint

GET https://{yourDomain}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

Scopes

Requires either one of the following scopes:

• PM.OAuthApp
• PM.OAuthApp.Read

Request headers

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

Note:

To obtain the {access_token}, make sure to authenticate through one of the methods described in Authentication methods.

Request body

The request body contains the organization ID from where you want to retrieve the external clients.

{
  "partitionGlobalId": "<organizationId>"
}

Responses

200 Success

The list of external clients for a given organization has been successfully retrieved.

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