Skip to content

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

MethodPathDescriptionAuth required
GET/internal/v1/connector/universal/mappingsList all mappingsJWT + API token
GET/internal/v1/connector/universal/mappings/:idGet mapping detailsJWT + API token
PUT/internal/v1/connector/universal/mappingsCreate or update a mappingJWT + API token
DELETE/internal/v1/connector/universal/mappings/:cid/:idDelete a mappingJWT + API token
DELETE/internal/v1/connector/universal/mappings/:cid/:id/eraseErase mapping and dataJWT + API token
GET/internal/v1/connector/universal/generate/mapping-id/:connector/:idGenerate mapping IDJWT + API token
GET/internal/v1/connector/universal/generate/mapping-uuid/:connector/:idGenerate mapping UUIDJWT + 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:

ParameterTypeDescription
cidstringConnector ID
idstringMapping 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.

Hydden Documentation and Training Hub