Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Gerenciamento de Aplicação

Atualizar aplicação

Atualiza a configuração e metadados de uma aplicação existente. Apenas informações básicas da aplicação podem ser modificadas, as credenciais OAuth2 permanecem inalteradas.

put/open-keys/itp/api/v2/applications/{applicationId}

Path parameters

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

Request body

namestring required

Nome de identificação da aplicação

descriptionstring

Descrição da aplicação

imagestring uri

URL da imagem da empresa

Example request

{
  "image": "https://example.com"
}

Response

retornou com sucesso.

idstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

createdAtstring required
updatedAtstring required
deletedAtstring required
namestring required

Nome de identificação da aplicação

descriptionstring

Descrição da aplicação

imagestring uri

URL da imagem da empresa

clientIdstring required

O client_id é um identificador público para aplicativos.

externalIdstring required

O externalId é o identificador externo da aplicação. Usamos este id como o do Client do Keycloak.

Example response

{
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "image": "https://example.com",
  "accounts": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "owner": {
        "cpfCnpj": "58764789000137",
        "personType": "PESSOA_JURIDICA",
        "name": "Marco Antonio de Brito"
      },
      "paymentAccount": {
        "accountType": "CACC",
        "ispb": "12345678",
        "issuer": "1774",
        "number": "1234567890"
      },
      "paymentKey": {
        "keyType": "CPF",
        "key": "12345678901"
      }
    }
  ],
  "redirects": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "allowedRedirectUrl": "http://localhost:8080/*"
    }
  ],
  "webhooks": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "endpointBaseUrl": "https://itp.com/kong3",
      "authentication": {
        "authType": "bearer_token",
        "data": {
          "name": "<HEADER_NAME>",
          "value": "<VALUE>",
          "token": "<TOKEN>",
          "username": "USERNAME",
          "password": "PASSWORD"
        },
        "add_position": "header"
      }
    }
  ]
}