Gerar um novo cliente externo

Gere um novo cliente OAuth externo em uma organização do Automation Suite usando a API do Identity, incluindo o escopo e o esquema de resposta necessários.

Gere um novo cliente externo.

Ponto de Extremidade da API

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

Escopos

Requer um dos seguintes escopos:

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

Cabeçalhos de solicitação.

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

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos em Métodos de autenticação.

Corpo da Solicitação

O corpo da solicitação contém o ID do cliente para o qual você deseja gerar um segredo, uma descrição correspondente e o ID da organização.

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

Resposta

200 Sucesso

Um novo segredo do cliente foi gerado com sucesso para o cliente externo fornecido.

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