> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.datagol.ai/llms.txt > Use this file to discover all available pages before exploring further. # Login to DataGOL > ## 1️⃣ Overview **Purpose:** Authenticates a user into the DataGOL Platform. On success, it returns the user's profile, including their administrative roles and assigned permissions within the workspace. --- ## 2️⃣ Endpoint ``` bash POST /idp/api/v1/user/login ``` Base URL: ``` https://be.datagol.ai ``` --- ## 3️⃣ Request Headers | Header | Required | | --- | --- | | Content-Type: application/json | ✅ Yes | --- ## 4️⃣ Request Body Schema ``` json { "email": "string", "password": "string" } ``` --- ## 5️⃣ Field Descriptions ### Login Fields | Field | Type | Description | | --- | --- | --- | | email | string | The registered email address (e.g., [sample_email@datagol.com](https://mailto:sample_email@datagol.com)). | | password | string | The user's account password. | --- ## 6️⃣ Example Request ``` bash curl -X POST https://be.datagol.ai/idp/api/v1/user/login \ -H "Content-Type: application/json" \ -d '{ "email": "sample_email@datagol.com", "password": "UserPassword123" }' ``` --- ## 7️⃣ Behavior Summary Authenticates a user into the DataGOL Platform and returns the user profile with administrative roles and workspace permissions. ## OpenAPI ````yaml /openapi/openapi.yaml post /idp/api/v1/user/login openapi: 3.0.0 info: title: DataGOL APIs version: 1.0.0 description: '' servers: - url: https://be.datagol.ai - url: https://be.datagol.ai - url: https://kg.datagol.ai - url: https://ai.datagol.ai security: [] tags: - name: Links & Joins description: > ## 🔗 Links & Joins LINK and LOOKUP are special workbook column types that enable relational data modeling across tables. | Column Type | Purpose | |---|---| | `LINK` | Defines a relationship between two tables | | `LOOKUP` | Projects columns from an associated table via a link | Both are configured through `ColumnDTO.colOptions`. A table can have multiple link columns, and each link can have multiple lookup columns. --- ## 📐 UI Data Types - **LINK** — Special column used to represent inter-table relations - **LOOKUP** — Special column used to project associated table fields via a link --- ## 🔗 LINK Semantics A LINK column stores metadata for: - `tableId` — Current table - `associatedTableId` — Associated (linked) table - `relationType` — Type of relationship - `linkColumnId` — Link column identifier **Supported relation patterns:** | Pattern | Description | |---|---| | `ONE_TO_ONE` | Each record in the source maps to one record in the destination | | `ONE_TO_MANY` | One source record maps to many destination records | | `MANY_TO_MANY` | Many source records map to many destination records | --- ## 🔍 LOOKUP Semantics - A LOOKUP column is tightly coupled with a specific LINK column - References a link using `linkColumnId` - Represents a selected column from the associated table - Multiple lookup columns can be defined for the same link --- ## 🗂️ Metadata in `ColumnDTO.colOptions` Use `colOptions` to persist link/lookup metadata. | Field | Description | |---|---| | `columnId` | Current column ID | | `tableId` | Current table ID | | `associatedTableId` | Associated table ID | | `linkColumnId` | Link column ID — used by LOOKUP; references the LINK column's `columnId` | | `relationType` | Relation semantics for LINK | --- ## 🔄 Manual Linking Record Flow To create manual record-level links: 1. Fetch associated table schema/data 2. User selects associated record(s) to link 3. Send linking payload with: - `sourceRecordId` — PK of the current table row - `destinationRecordId` — PK of the associated table row - `linkColumnId` — LINK column identifier 4. Backend resolves link metadata from `linkColumnId` (relation type, associated table, direction/constraints) 5. Backend applies relation rules and stores the link relation --- ## 📋 Record Linking Contract | Field | Description | |---|---| | `sourceRecordId` | PK of the current table row | | `destinationRecordId` | PK of the associated table row | | `linkColumnId` | LINK column identifier | | `tableId` | Current table ID | > Backend derives all remaining relation metadata from the link configuration. --- ## ⚠️ Important Notes > - LINK and LOOKUP are **column-level constructs** first; record linking is a data-level operation built on top > - LOOKUP behavior depends on LINK existence and metadata integrity > - With multiple links to the same associated table, each LOOKUP must bind to the correct `linkColumnId` > - Always treat the associated row ID as the associated table PK for linking UI selection paths: /idp/api/v1/user/login: post: tags: - Getting Started summary: Login to DataGOL description: >- ## 1️⃣ Overview **Purpose:** Authenticates a user into the DataGOL Platform. On success, it returns the user's profile, including their administrative roles and assigned permissions within the workspace. --- ## 2️⃣ Endpoint ``` bash POST /idp/api/v1/user/login ``` Base URL: ``` https://be.datagol.ai ``` --- ## 3️⃣ Request Headers | Header | Required | | --- | --- | | Content-Type: application/json | ✅ Yes | --- ## 4️⃣ Request Body Schema ``` json { "email": "string", "password": "string" } ``` --- ## 5️⃣ Field Descriptions ### Login Fields | Field | Type | Description | | --- | --- | --- | | email | string | The registered email address (e.g., [sample_email@datagol.com](https://mailto:sample_email@datagol.com)). | | password | string | The user's account password. | --- ## 6️⃣ Example Request ``` bash curl -X POST https://be.datagol.ai/idp/api/v1/user/login \ -H "Content-Type: application/json" \ -d '{ "email": "sample_email@datagol.com", "password": "UserPassword123" }' ``` --- ## 7️⃣ Behavior Summary Authenticates a user into the DataGOL Platform and returns the user profile with administrative roles and workspace permissions. requestBody: content: application/json: schema: type: object properties: email: type: string format: email password: type: string example: email: sample_email@datagol.com password: password123 responses: '200': description: Login to DataGOL ````