API reference
Share a client case
Grant a customer organisation or named people (by email, sign-in required) access to the client case. expires_at is optional: the default is 30 days and the longest is 365.
Needs scope cases:share.
bearerAuthorizationBearer <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.
case_id*stringThe client case's id, cas_ and 32 hex characters, from List client cases.
iohr.cases.v1.CreateShareRequest; path variables override their fields
application/json- body
iohr.cases.v1.CreateShareRequest
case_id?stringexpires_at?stringgrantee?stringgrantee_kind?stringiohr.cases.v1.CreateShareResponse
application/json- response
iohr.cases.v1.CreateShareResponse
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.createShare("<case_id>", { expires_at: "<expires_at>", grantee: "<grantee>", grantee_kind: "<grantee_kind>", }); 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.
{ "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" }}