> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter Credencial Por Tipo

## Token de Acesso

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

## Descrição do Body

<ParamField path="id" type="string" required="true" placeholder="Enter with UnityId">
  ID da Unidade
</ParamField>

<ParamField path="type" type="string" required="true" placeholder="Enter with UnityId">
  Tipo da Credencial
</ParamField>

## Descrição da Resposta

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

<ResponseField name="credentials" type="array" required>
  Lista de credenciais associadas às integrações.

  <ResponseField name="id" type="uuid" required>
    Identificador único da credencial.
  </ResponseField>

  <ResponseField name="name" type="string" required>
    Nome da credencial.
  </ResponseField>

  <ResponseField name="userId" type="uuid" required>
    Identificador do usuário associado.
  </ResponseField>

  <ResponseField name="unityId" type="uuid" required>
    Identificador da unidade associada.
  </ResponseField>

  <ResponseField name="integrationId" type="uuid" required>
    Identificador da integração associada à credencial.
  </ResponseField>

  <ResponseField name="secretId" type="uuid" required>
    Identificador secreto da credencial.
  </ResponseField>

  <ResponseField name="status" type="boolean" required>
    Indica se a credencial está ativa.
  </ResponseField>

  <ResponseField name="virtualKey" type="string" optional>
    Chave virtual associada à credencial.
  </ResponseField>

  <ResponseField name="createdAt" type="string" format="date-time" required>
    Data e hora de criação da credencial.
  </ResponseField>

  <ResponseField name="updatedAt" type="string" format="date-time" optional>
    Data e hora da última atualização da credencial.
  </ResponseField>
</ResponseField>

<ResponseField name="integration" type="array" required>
  Detalhes sobre a integração associada à credencial.

  <ResponseField name="id" type="uuid" required>
    Identificador único da integração.
  </ResponseField>

  <ResponseField name="name" type="string" required>
    Nome da integração.
  </ResponseField>

  <ResponseField name="iconId" type="uuid" required>
    Identificador do ícone associado.
  </ResponseField>

  <ResponseField name="type" type="string" required>
    Tipo da integração (ex: llm).
  </ResponseField>

  <ResponseField name="status" type="boolean" required>
    Indica se a integração está ativa.
  </ResponseField>

  <ResponseField name="validationEndpoint" type="string" optional>
    URL do endpoint de validação da integração.
  </ResponseField>

  <ResponseField name="slug" type="string" optional>
    Slug da integração.
  </ResponseField>

  <ResponseField name="form" type="array" required>
    Campos de formulário para configuração da integração.

    <ResponseField name="name" type="string" required>
      Nome do campo do formulário.
    </ResponseField>

    <ResponseField name="type" type="string" required>
      Tipo do campo do formulário (ex: string).
    </ResponseField>

    <ResponseField name="label" type="string" required>
      Rótulo do campo do formulário.
    </ResponseField>

    <ResponseField name="maxLenght" type="number" optional>
      Tamanho máximo do valor do campo do formulário.
    </ResponseField>

    <ResponseField name="required" type="boolean" required>
      Indica se o campo é obrigatório.
    </ResponseField>
  </ResponseField>

  <ResponseField name="createdAt" type="string" format="date-time" required>
    Data e hora de criação da integração.
  </ResponseField>

  <ResponseField name="updatedAt" type="string" format="date-time" optional>
    Data e hora da última atualização da integração.
  </ResponseField>

  <ResponseField name="icon" type="object" optional>
    Detalhes sobre o ícone da integração.

    <ResponseField name="id" type="uuid" required>
      Identificador único do ícone.
    </ResponseField>

    <ResponseField name="createdAt" type="string" format="date-time" required>
      Data e hora de criação do ícone.
    </ResponseField>

    <ResponseField name="updatedAt" type="string" format="date-time" optional>
      Data e hora da última atualização do ícone.
    </ResponseField>

    <ResponseField name="institutionId" type="uuid" required>
      Identificador da instituição associada ao ícone.
    </ResponseField>

    <ResponseField name="type" type="string" required>
      Tipo do ícone (ex: WidgetHeaderIcon).
    </ResponseField>

    <ResponseField name="fileName" type="string" required>
      Nome do arquivo do ícone.
    </ResponseField>

    <ResponseField name="internalStorageUrl" type="string" required>
      URL de armazenamento interno do ícone.
    </ResponseField>

    <ResponseField name="url" type="string" required>
      URL pública do ícone.
    </ResponseField>

    <ResponseField name="size" type="number" required>
      Tamanho do ícone em bytes.
    </ResponseField>

    <ResponseField name="extension" type="string" required>
      Extensão do arquivo do ícone.
    </ResponseField>

    <ResponseField name="maskName" type="string" optional>
      Nome da máscara associada ao ícone.
    </ResponseField>
  </ResponseField>
</ResponseField>