Universal Connector Mappings API
DRAFT — Internal Developer Use Only
This API reference is for internal development teams.
Overview
What it is: The mappings API manages field mappings for universal connectors. Mappings define how raw collected data fields translate to Discovery's internal entity model.
Endpoints
| Method | Path | Description | Auth required |
|---|---|---|---|
GET | /internal/v1/connector/universal/mappings | List all mappings | JWT + API token |
GET | /internal/v1/connector/universal/mappings/:id | Get mapping details | JWT + API token |
PUT | /internal/v1/connector/universal/mappings | Create or update a mapping | JWT + API token |
DELETE | /internal/v1/connector/universal/mappings/:cid/:id | Delete a mapping | JWT + API token |
DELETE | /internal/v1/connector/universal/mappings/:cid/:id/erase | Erase mapping and data | JWT + API token |
GET | /internal/v1/connector/universal/generate/mapping-id/:connector/:id | Generate mapping ID | JWT + API token |
GET | /internal/v1/connector/universal/generate/mapping-uuid/:connector/:id | Generate mapping UUID | JWT + API token |
PUT /internal/v1/connector/universal/mappings
Create or update a field mapping for a universal connector.
Request:
http
PUT /internal/v1/connector/universal/mappings
Authorization: Bearer <token>
Content-Type: application/json
{
"connectorId": "connector-uuid",
"schemaId": "schema-uuid-001",
"mappings": [
{ "source": "userId", "target": "Id", "required": true },
{ "source": "username", "target": "Account Name", "required": true },
{ "source": "email", "target": "Email", "required": false },
{ "source": "role", "target": "Account Type", "required": false }
]
}Response (200):
json
{
"id": "mapping-uuid-001",
"connectorId": "connector-uuid",
"status": "active",
"fieldCount": 4
}DELETE /internal/v1/connector/universal/mappings/:cid/:id/erase
Delete a mapping and erase all data collected using it.
Path parameters:
| Parameter | Type | Description |
|---|---|---|
cid | string | Connector ID |
id | string | Mapping ID |
Request:
http
DELETE /internal/v1/connector/universal/mappings/connector-uuid/mapping-uuid-001/erase
Authorization: Bearer <token>Response (204): No content.
DANGER
This operation permanently deletes the mapping and all associated collected data.
