Obter Credencial Por Tipo

GET /api/v1/credential/unity/{id}/type/{type}

Obter Credencial Por Tipo

cURL

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/credential/unity/{id}/type/{type}

200

{
  "credentials": [
    {
      "id": "<string>",
      "name": "<string>",
      "userId": "<string>",
      "unityId": "<string>",
      "integrationId": "<string>",
      "secretId": "<string>",
      "status": true,
      "virtualKey": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "integration": [
    {
      "id": "<string>",
      "name": "<string>",
      "iconId": "<string>",
      "type": "<string>",
      "status": true,
      "validationEndpoint": "<string>",
      "slug": "<string>",
      "form": [
        {
          "name": "<string>",
          "type": "<string>",
          "label": "<string>",
          "maxLenght": 123,
          "required": true
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "icon": {
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "institutionId": "<string>",
        "type": "<string>",
        "fileName": "<string>",
        "internalStorageUrl": "<string>",
        "url": "<string>",
        "size": 123,
        "extension": "<string>",
        "maskName": "<string>"
      }
    }
  ]
}

Token de Acesso

Authorization · string

Token de acesso (“Bearer” deve estar antes do token)

Descrição do Body

id · string · required

ID da Unidade

type · string · required

Tipo da Credencial

Descrição da Resposta

Abaixo você verá a descrição da resposta de todas as credenciais por tipo

credentials · array · required

Lista de credenciais associadas às integrações.

id · uuid · required

Identificador único da credencial.

name · string · required

Nome da credencial.

userId · uuid · required

Identificador do usuário associado.

unityId · uuid · required

Identificador da unidade associada.

integrationId · uuid · required

Identificador da integração associada à credencial.

secretId · uuid · required

Identificador secreto da credencial.

status · boolean · required

Indica se a credencial está ativa.

virtualKey · string

Chave virtual associada à credencial.

createdAt · string · required

Data e hora de criação da credencial.

updatedAt · string

Data e hora da última atualização da credencial.

integration · array · required

Detalhes sobre a integração associada à credencial.

id · uuid · required

Identificador único da integração.

name · string · required

Nome da integração.

iconId · uuid · required

Identificador do ícone associado.

type · string · required

Tipo da integração (ex: llm).

status · boolean · required

Indica se a integração está ativa.

validationEndpoint · string

URL do endpoint de validação da integração.

slug · string

Slug da integração.

form · array · required

Campos de formulário para configuração da integração.

name · string · required

Nome do campo do formulário.

type · string · required

Tipo do campo do formulário (ex: string).

label · string · required

Rótulo do campo do formulário.

maxLenght · number

Tamanho máximo do valor do campo do formulário.

required · boolean · required

Indica se o campo é obrigatório.

createdAt · string · required

Data e hora de criação da integração.

updatedAt · string

Data e hora da última atualização da integração.

icon · object

Detalhes sobre o ícone da integração.

id · uuid · required

Identificador único do ícone.

createdAt · string · required

Data e hora de criação do ícone.

updatedAt · string

Data e hora da última atualização do ícone.

institutionId · uuid · required

Identificador da instituição associada ao ícone.

type · string · required

Tipo do ícone (ex: WidgetHeaderIcon).

fileName · string · required

Nome do arquivo do ícone.

internalStorageUrl · string · required

URL de armazenamento interno do ícone.

url · string · required

URL pública do ícone.

size · number · required

Tamanho do ícone em bytes.

extension · string · required

Extensão do arquivo do ícone.

maskName · string

Nome da máscara associada ao ícone.