Skip to main content
GET
Read a reference type

Autorizaciones

Authorization
string
header
requerido

JWT issued by the identity provider. A producer calls with a service credential issued for the tenant it sends facts for; a reader calls with a user token or a service credential. The tenant is always taken from the token, never from the request path, query or body.

Parámetros de ruta

type
string
requerido

Name of the reference type to read.

Ejemplo:

"acme.order_id"

Respuesta

The reference type as registered: its scope keys, correlation, sensitivity, mask and whether it is searchable.

correlation
enum<string>
requerido

Whether references of this type link facts into flows. Allowed values: exact, none.

Opciones disponibles:
exact,
none
createdAt
string<date-time>
requerido

When the type was registered. RFC 3339, UTC.

description
string
requerido

What the reference identifies, as registered.

ownerIdentity
string
requerido

Verified identity that registered the type, in the form owner/sub; recorded for audit only.

Ejemplo:

"acme/platform-deployer"

scope
string[] | null
requerido

Scope keys that complete the reference identity, sorted.

searchable
boolean
requerido

Whether listFlowsByReference can list facts by this type.

sensitivity
enum<string>
requerido

Protection of values at rest and on reads; see Sensitivity and protected values. Allowed values: none, masked, hashed, encrypted.

Opciones disponibles:
none,
masked,
hashed,
encrypted
type
string
requerido

Reference type name.

Ejemplo:

"acme.order_id"

mask
enum<string>

Display format of the type; omitted when it has none. Allowed values: document.

Opciones disponibles:
document