/v1/issuer/data_source_mappings/{id}
API Key
Update a mapping
Update mapping properties. Only provided fields are updated.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
id
*
|
path | string | Data source mapping ID |
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Request Body
Parameters for updating a data source mapping
name
string
Custom name for the mapping
Example: Updated HR Mapping
field_mapping
object
Maps data source columns to credential claims
Example: {"name":"display_name","employee_id":"employee_number"}
query_config
object
Query configuration for data extraction
Example: {"table":"employees","where":"status IN ('active', 'on_leave')"}
Response
Content-Type: application/json
success
boolean
data
object
A mapping between a data source and credential schema
slug
*
string
URL-friendly identifier
Example: employee-database-employee-badge
name
string
nullable
Optional custom name for the mapping
Example: Employee Badge Mapping
display_name
*
string
Display name (custom name or auto-generated)
Example: Employee Database → Employee Badge
data_source
*
object
The linked data source
slug
string
Example: employee-database
name
string
Example: Employee Database
source_type
string
Allowed values: "postgresql", "csv"
Example: postgresql
credential_schema
*
object
The linked credential schema
uuid
string (uuid)
Example: 60476b28-5bfc-4cd5-a65a-9ac898a7223c
slug
string
Example: employee-badge
name
string
Example: Employee Badge
field_mapping
object
nullable
Maps data source columns to credential claims (full view only)
Example: {"name":"full_name","email":"email_address"}
query_config
object
nullable
Query configuration for data extraction (full view only)
Example: {"table":"employees","columns":["full_name","email_address"]}
automation_count
*
integer
Number of automations using this mapping
created_at
*
string (date-time)
When the mapping was created
updated_at
*
string (date-time)
When the mapping was last updated
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.data_source_mappings.update(
id="example_id",
body={
"name": "Updated HR Mapping",
"field_mapping": {
"name": "display_name",
"employee_id": "employee_number"
},
"query_config": {
"table": "employees",
"where": "status IN ('active', 'on_leave')"
}
}
)client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.data_source_mappings.update(
id: "example_id",
body: {
name: "Updated HR Mapping",
field_mapping: {
name: "display_name",
employee_id: "employee_number"
},
query_config: {
table: "employees",
where: "status IN ('active', 'on_leave')"
}
}
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.data_source_mappings.update({
id: "example_id",
body: {
name: "Updated HR Mapping",
fieldMapping: {
name: "display_name",
employeeId: "employee_number"
},
queryConfig: {
table: "employees",
where: "status IN ('active', 'on_leave')"
}
}
});curl -X PATCH 'https://api.aho.com/v1/issuer/data_source_mappings/example_id' \
-H 'X-API-Key: $AHO_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Updated HR Mapping",
"field_mapping": {
"name": "display_name",
"employee_id": "employee_number"
},
"query_config": {
"table": "employees",
"where": "status IN ('active', 'on_leave')"
}
}'Try It
Log in to test this endpoint directly from the documentation.
Log in