Sign in
Docs
API referenceCoordinator

API reference

Grant the full picture

Have a token? Manage tokens in the console
POST
/v1/coordinator/watch-grants

Give an account or a person the full coordinator picture, with a note. Staff only (an admin or a verified inorbit.hr address), so a grant cannot be passed on. expires_at ends the grant on its own; an expired grant shows the public picture and a new grant replaces it.

Needs scope coordinator:write.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Request Body

iohr.coordinator.v1.GrantWatchAccessRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.GrantWatchAccessRequest

account_id?string
expires_at?string
grantee?string
grantee_kind?string
note?string

Response Body

iohr.coordinator.v1.GrantWatchAccessResponse

application/json
  1. response

iohr.coordinator.v1.GrantWatchAccessResponse

grant?

iohr.coordinator.v1.WatchGrant

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.coordinator.grantWatchAccess({    expires_at: "<expires_at>",    grantee: "<grantee>",    grantee_kind: "<grantee_kind>",    note: "<note>",  });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "grant": {    "active": true,    "expires_at": "string",    "granted_at": "string",    "granted_by": "string",    "grantee": "string",    "grantee_kind": "string",    "id": "string",    "note": "string",    "revoked_at": "string",    "revoked_by": "string"  }}