Sign in
Docs
API referenceCoordinator

API reference

Revoke a watch grant

Have a token? Manage tokens in the console
DELETE
/v1/coordinator/watch-grants/{grant_id}

End a grant. Streams it opened end within a tick and the next one is public. Staff only.

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.

Path Parameters

grant_id*string

The grant's id, wgr_ and a ULID, from List watch grants.

Query Parameters

account_id?string

Response Body

iohr.coordinator.v1.RevokeWatchAccessResponse

application/json
  1. response

iohr.coordinator.v1.RevokeWatchAccessResponse

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.revokeWatchAccess("<grant_id>");  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"  }}