> For the complete documentation index, see [llms.txt](https://docs.docbits.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.docbits.com/advanced-functions-and-tools/sql-access/sql-access/api-credentials.md).

# API credentials

## Spalten

* `id`: internal
* `org_id`: ID to organisation
* `sub_org_id`: internal
* `title`: internal
* `credentials_type`: internal
* `credentials_json`: text
* `created_by`: integer
* `created_on`: timestamp with time zone
* `last_modified_on`: timestamp with time zone
* `is_deleted`: boolean
* `deleted_on`: timestamp with time zone
* `last_modified_by`: internal
* `deleted_by`: internal

## Analyse & Beschreibung

```markdown
# Table Documentation: `public.api_credentials`

## Introduction

The `public.api_credentials` table is designed to store and manage API credential information. This table is crucial for organizations to handle their API authentication details securely, ensuring that various services can interact with each other using the correct credentials. It includes information about the type of credentials, the organization to which they belong, and metadata about their creation and modification.

## Column Descriptions

### id
- **Meaning**: A unique identifier for each entry in the table.
- **Role**: Primary key.
- **Typical Contents**: A universally unique identifier (UUID) representing a specific set of API credentials.

### org_id
- **Meaning**: Identifier for the organization that owns the credentials.
- **Role**: Foreign key.
- **Typical Contents**: A UUID that links to the organization's record in another table.

### sub_org_id
- **Meaning**: Identifier for a sub-organization within the main organization.
- **Role**: Foreign key (optional).
- **Typical Contents**: May contain a UUID linking to a sub-organization, or `None`.

### title
- **Meaning**: A descriptive title for the API credentials.
- **Role**: Descriptive field.
- **Typical Contents**: A string such as "supplier_auth" indicating the purpose or usage of the credentials.

### credentials_type
- **Meaning**: Specifies the type of credentials stored.
- **Role**: Descriptive field.
- **Typical Contents**: A string like "ionapi" indicating the format or protocol used by the credentials.

### credentials_json
- **Meaning**: A JSON object containing detailed credential information.
- **Role**: Technical field.
- **Typical Contents**: JSON string with various key-value pairs detailing authentication parameters.

### created_by
- **Meaning**: User ID of the individual who created the credentials record.
- **Role**: Technical field.
- **Typical Contents**: An integer representing the user ID.

### created_on
- **Meaning**: Timestamp indicating when the credentials were created.
- **Role**: Technical field.
- **Typical Contents**: A datetime value with timezone, e.g., `2024-04-08 11:54:55 UTC`.

### last_modified_on
- **Meaning**: Timestamp indicating the last modification time of the credentials.
- **Role**: Technical field.
- **Typical Contents**: A datetime value with timezone, or `None` if never modified.

### is_deleted
- **Meaning**: Flag indicating whether the credentials are marked as deleted.
- **Role**: Technical field.
- **Typical Contents**: A boolean value, where `False` indicates active credentials.

### deleted_on
- **Meaning**: Timestamp indicating when the credentials were marked as deleted.
- **Role**: Technical field.
- **Typical Contents**: A datetime value with timezone, or `None` if not deleted.

### last_modified_by
- **Meaning**: Identifier of the user who last modified the credentials.
- **Role**: Technical field.
- **Typical Contents**: A character string representing the user's ID, or `None`.

### deleted_by
- **Meaning**: Identifier of the user who marked the credentials as deleted.
- **Role**: Technical field.
- **Typical Contents**: A character string representing the user's ID, or `None`.
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.docbits.com/advanced-functions-and-tools/sql-access/sql-access/api-credentials.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
