Skip to main content
GET
Read a reference type

Authorizations

Authorization
string
header
required

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.

Path Parameters

type
string
required

Name of the reference type to read.

Example:

"acme.order_id"

Response

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

correlation
enum<string>
required

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

Available options:
exact,
none
createdAt
string<date-time>
required

When the type was registered. RFC 3339, UTC.

description
string
required

What the reference identifies, as registered.

ownerIdentity
string
required

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

Example:

"acme/platform-deployer"

scope
string[] | null
required

Scope keys that complete the reference identity, sorted.

searchable
boolean
required

Whether listFlowsByReference can list facts by this type.

sensitivity
enum<string>
required

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

Available options:
none,
masked,
hashed,
encrypted
type
string
required

Reference type name.

Example:

"acme.order_id"

mask
enum<string>

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

Available options:
document