Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.

assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.

evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.

webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.

settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.

people reads people, groups and investigations with full evidence by default. people_write changes submitted people, groups and memberships. investigations starts or cancels jobs and screenings. decisions records reviews. exports with people-read access exports rosters. delete deletes people, groups and memberships. Existing groups keys retain non-destructive people access. Explicit evidence.read restrictions withhold collected records, posts, media, discovered identifiers and notes.

members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.

A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.

Path Parameters

workspace_id
string
required

The workspace id. A workspace the acting user is not an active member of answers 404, as do another workspace than an API key's own, a malformed id and a test environment's id. The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$
key_id
string
required

The key's id. A key of another workspace answers 404, as does a key of the other environment to an API key. The key's public id, a 26-character ULID.

Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
denied_actions
enum<string>[]
required

Explicit restrictions that override scope grants. An empty list restores the access supplied by the scopes. Rotation preserves these restrictions.

Maximum array length: 3
Available options:
evidence.read,
exports.read,
policy.publish

Response

The key with its updated restrictions. Changes take effect on its next request.

One API key of a workspace, as the console shows it. A key belongs to exactly one environment. Every other field is safe to show.

id
string
required

The key's public id, a 26-character ULID.

Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
workspace_id
string
required

The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$
environment
enum<string>
required

The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.

Available options:
live,
test
prefix
string
required

The public start of the credential, nrk__, which identifies the key in logs and secret stores without its secret.

Pattern: ^nrk_(live|test)_[0-7][0-9A-HJKMNP-TV-Z]{25}$
scopes
enum<string>[]
required

The key's scopes, each at most once.

Required array length: 1 - 22 elements
Available options:
assess,
history,
delete,
webhooks,
detailed,
integrations,
management,
audit,
usage,
investigate,
evidence,
exports,
audit_manage,
settings,
policy_publish,
members,
members_manage,
groups,
people,
people_write,
investigations,
decisions
status
enum<string>
required

active: the key authenticates. expired: a rotation's overlap window has ended (expires_at). revoked: the key was revoked (revoked_at) and answers 401.

Available options:
active,
expired,
revoked
created_at
string<date-time>
required
created_by
string

The external user id of the member who created the key through the console, or the prefix (nrk__) of the management key that created it. Absent for a key NoResponse issued or a rotation made.

Required string length: 1 - 256
Pattern: ^[!-~]{1,256}$
expires_at
string<date-time>

The earlier of the explicit lifetime and any rotation overlap. Rotation preserves the original lifetime.

revoked_at
string<date-time>
revoked_by
string

The external user id of the member who revoked the key through the console, or the prefix of the management key that revoked it. Absent when the key is not revoked or NoResponse revoked it.

Required string length: 1 - 256
Pattern: ^[!-~]{1,256}$
key
string

The credential, nrk_. Present only in the 201 answer that created the key.

Pattern: ^nrk_(live|test)_[0-7][0-9A-HJKMNP-TV-Z]{25}_[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$
name
string

The optional display name supplied for this API key. Preserved on rotation.

Required string length: 1 - 100
purpose
string

Optional operational purpose, at most 200 printable characters without leading or trailing whitespace. Do not put secrets or personal data here. Preserved on rotation and included in the creation request fingerprint; omitted for older credentials.

Required string length: 1 - 200
Pattern: ^[^\x00-\x1f\x7f-\x9f]+$
kind
enum<string>
Available options:
service,
personal
owner_user_id
string

The issuing member's external identity for a personal key. Personal ownership is fixed and the key is revoked when that member loses authority. Service keys belong to the workspace and omit this field.

Required string length: 1 - 256
Pattern: ^[!-~]{1,256}$
rotated_to
string

Replacement public key identifier, or legacy when the successor predates recorded lineage. This field excludes the secret.

Required string length: 1 - 64
last_used_at
string<date-time>

Latest recorded authenticated request observation, updated at most once per minute. Capture is best effort after the response and includes authenticated requests refused by authorization or rate limits. Absence means unknown and does not prove the key was unused. It is independent of diagnostic retention and resets on the replacement key after rotation. This field retains no raw IP or user-agent.

denied_actions
enum<string>[]

Explicit restrictions that override scope grants. An empty list restores the access supplied by the scopes. Rotation preserves these restrictions.

Maximum array length: 3
Available options:
evidence.read,
exports.read,
policy.publish