IdentityResolveRequest identity.resolve-request@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
network
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/identity/resolve-request.v1.json

identity.resolve-request@1: the request of identity.subject.resolve on OpenVibe.Network. GET /internal/identity/resolve?subject_id= or ?system=&id=[&type=user] takes no body. POST /internal/identity/resolve-batch: { subject_ids } or { system, type?, ids } (at most 500; 413 beyond).

Fields

This schema has no named fields.

Examples

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

Valid: legacy
{
  "system": "live",
  "type": "user",
  "ids": [
    "17",
    42
  ]
}
Valid: subjects
{
  "subject_ids": [
    "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  ]
}
Rejected: ids-without-system
{
  "ids": [
    "17"
  ]
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('identity.resolve-request@1', value);   // { valid, errors: [{ path, message }] }