AccessKeyList media.access-key-list@1

Generated at from openvibe-contracts v0.177.0 and openvibe-sdk v0.44.0.

Version
1.0.0
Owner
media
Visibility
first-party
Status
active
Compatibility
backward
Decision
ADR-031
Schema
https://openvibe.network/contracts/media/access-key-list.v1.json

media.access-key-list@1 (ADR-031): GET /api/v1/projects/:project_id/access-keys (capability media.access_key.manage, for a project admin in on_behalf_of): every key of the project, newest first, revoked ones included. No secret is ever listed.

Fields

FieldTypeRequiredDescriptionConstraints
keysmedia.access-keyyes
  • maxItems 500

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: basic
{
  "keys": [
    {
      "id": "ovk_01JZ0000000000000000000K01",
      "project_id": "prj_01JZ0000000000000000000P01",
      "env": "production",
      "name": "ci deploys",
      "permissions": "read-write",
      "zones": [],
      "created_by": "usr_01JZ0000000000000000000A01",
      "created_at": "2026-10-14T12:00:00.000Z",
      "last_used_at": null,
      "revoked_at": null
    }
  ]
}
Rejected: basic
{
  "keys": [
    {
      "id": "ovk_01JZ0000000000000000000K01",
      "secret": "nope"
    }
  ]
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('media.access-key-list@1', value);   // { valid, errors: [{ path, message }] }