Sign in
Docs
API referenceCases

API reference

Revoke a share

Have a token? Manage tokens in the console
POST
/v1/cases/shares/{share_id}/revoke

End a share now. The row and its opens are kept.

Needs scope cases:share.

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

share_id*string

The share's id, shr_ and 32 hex characters, from List the shares of a client case.

Request Body

iohr.cases.v1.RevokeShareRequest; path variables override their fields

application/json
  1. body

iohr.cases.v1.RevokeShareRequest

share_id?string

Response Body

iohr.cases.v1.RevokeShareResponse

application/json
  1. response

iohr.cases.v1.RevokeShareResponse

share?

iohr.cases.v1.Share

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.cases.revokeShare("<share_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
{  "share": {    "case_id": "string",    "expires_at": "string",    "granted_at": "string",    "granted_by": "string",    "grantee": "string",    "grantee_kind": "string",    "revoked_at": "string",    "revoked_by": "string",    "share_id": "string",    "state": "string"  }}