Sign in
InOrbit
Docs

API reference

Create or replace a policy

Have a token? Manage tokens in the console
PUT
/v1/guardrails/policies/{name}

Create or replace a policy by its name. Only a person who owns or administers the account, never an assistant. Audited by name.

Needs scope decisions:write.

Authorization

bearer
headerAuthorizationBearer <token>

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

name*string

Request Body

iohr.guardrails.v1.PutPolicyRequest; path variables override their fields

application/json
  1. body

iohr.guardrails.v1.PutPolicyRequest

account_id?string
effect?string
enabled?boolean
name?string
reason?string
rule?string
source_kind?string
source_ref?string
space_id?string

Response Body

iohr.guardrails.v1.PutPolicyResponse

application/json
  1. response

iohr.guardrails.v1.PutPolicyResponse

policy?

iohr.guardrails.v1.Policy

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.guardrails.putPolicy("<name>", {    effect: "<effect>",    reason: "<reason>",    rule: "<rule>",    source_kind: "<source_kind>",  });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

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.

{  "policy": {    "account_id": "string",    "effect": "string",    "enabled": true,    "name": "string",    "reason": "string",    "rule": "string",    "source_kind": "string",    "source_ref": "string",    "space_id": "string",    "updated_at": "string",    "updated_by": "string"  }}

List policies GET

The account's guardrail policies, by name: effect, rule, reason and source. Needs scope `decisions:read`.

Record an attestation POST

Store an attestation about a document of the account: a signed envelope whose signature is verified against one of the platform's attestation keys before it is stored. Needs scope `decisions:write`.