Skip to main content
GET
Read a reference type

Autorizações

Authorization
string
header
obrigatório

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 caminho

type
string
obrigatório

Name of the reference type to read.

Exemplo:

"acme.order_id"

Resposta

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

correlation
enum<string>
obrigatório

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

Opções disponíveis:
exact,
none
createdAt
string<date-time>
obrigatório

When the type was registered. RFC 3339, UTC.

description
string
obrigatório

What the reference identifies, as registered.

ownerIdentity
string
obrigatório

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

Exemplo:

"acme/platform-deployer"

scope
string[] | null
obrigatório

Scope keys that complete the reference identity, sorted.

searchable
boolean
obrigatório

Whether listFlowsByReference can list facts by this type.

sensitivity
enum<string>
obrigatório

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

Opções disponíveis:
none,
masked,
hashed,
encrypted
type
string
obrigatório

Reference type name.

Exemplo:

"acme.order_id"

mask
enum<string>

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

Opções disponíveis:
document