v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB

ResourceDescriptors

Add a field descriptor

Adds a field to a descriptor. Use this to document a CSV column, JSON path, SQL column, OIDC claim, form field, credential claim, or presentation attribute that can be validated, mapped, governed, or transformed.

post/resource/descriptors/{resourceDescriptorId}/fields

Path parameters

resourceDescriptorIdstring uuid required

Stable identifier for a described external or internal resource shape.

Example:41436f49-040c-4f5f-9c7f-657f43762e2b

Stable identifier of the resource descriptor that describes the shape, representation, and semantic meaning of a connector resource.

Request body

fieldPathstring required

Path or column name within the resource representation.

displayNamestring

Human-readable field name.

valueTypestring required

Logical value type, for example string, number, boolean, date, datetime, object, array, or binary.

requiredboolean

Whether the field is required for validation and mapping.

multiValuedboolean

Whether the field can hold multiple values.

semanticAttributeIdstring uuid

Optional semantic attribute binding used for validation, governance, and policy.

sensitivitystring

Optional sensitivity or classification label used by governance and policy checks.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example request

{
  "fieldPath": "email",
  "displayName": "Work email",
  "valueType": "string",
  "required": true,
  "multiValued": false,
  "semanticAttributeId": "3cb996ce-9d68-4959-b8c4-c97e39258fae",
  "sensitivity": "personal-data",
  "retention": {
    "purpose": "credential-issuance",
    "legalBasis": "contract",
    "retentionPeriod": "P30D",
    "deleteAction": "DELETE"
  }
}

Response

Field descriptor created.