Skip to main content
GET
Introspect API key

Authorizations

X-API-Key
string
header
required

Per-manufacturer API key in the X-API-Key header, format emidat-{key_id}-{secret} where key_id is a random public handle. Issued by an owner in the Emidat dashboard; carries its own permission scopes, optional plant restrictions, and optional expiry. A revoked, expired, or unknown key returns 401. See the Authentication guide for details.

Response

What the calling key can do right now.

manufacturer_id
string<uuid>
required

Emidat UUID of the manufacturer the key belongs to. This endpoint is the only way to obtain it — the key_id segment of the key is a random handle and encodes nothing about the manufacturer.

api_key_id
string<uuid>
required

Emidat UUID of the key itself. Use it to tell keys apart in the Emidat UI and in support requests; it is not a credential.

owner_profile_id
string<uuid>
required

Emidat UUID of the member who issued the key. The key can never do more than that member currently may.

scopes
enum<string>[]
required

The permissions the key can exercise, after intersecting its grant with the issuing member's current role. An endpoint that requires a scope the key does not hold answers 403. An edit: scope is only granted alongside its view: counterpart — a key never writes a field it cannot read.

Available options:
view:plants,
view:processes,
edit:processes,
view:products,
edit:products,
view:recipes,
edit:recipes,
view:materials,
edit:materials
plant_ids
string<uuid>[]
required

The plants the key can reach, listed explicitly — there is no wildcard for "all plants". An empty list means the key reaches none: plant-scoped reads come back empty and GET …/{id} answers 403.