> ## Documentation Index
> Fetch the complete documentation index at: https://base39-release-notes-06-mar.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Auditoria

O recurso de auditoria foi criado para fornecer uma funcionalidade simples que permite identificar quem criou ou alterou um registro.

<Note>Este recurso pode não estar disponível para todos os registros ou entidades.</Note>

### Formato dos atributos

```json
{
    ...
    "createdBy": {
        "clientId": "key_653963bddade10e18894f8b5",
        "externalClientId": "oprt_653963bddade10e18894f8b7"    
    },
    "updatedBy": {
        "clientId": "key_653963bddade10e18894f8b5",
        "externalClientId": "oprt_653963bddade10e18894f8b7"     
    }
}
```

### Compreendendo os atributos

| Atributo         | Descrição                                                                                                                                                                                                                                        |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| clientId         | O clientId é o identificador da chave da API somente quando a operação é realizada por um usuário, já quando a operação é executadaa automaticamente via processo e/ou rotiona é preenchido com nome do tenant.                                  |
| externalClientId | Esse é um atributo totalmente opcional e de livre escolha, cabendo ao usuário da API fornecê-lo durante as operações de escrita. Trata-se de um dado adicional, podendo, por exemplo, indicar o ID do operador ou outro identificador relevante. |

<Note>Por ser uma API que adota autenticação entre máquinas (M2M), não identificamos usuários finais, apenas chaves de API nas operações.</Note>