InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/rfcs/spaces/{space_id}/settings

The redaction rules the checks apply to its public documents (domains, words, patterns) and how many approvals a decision needs.

Needs scope rfc:read.

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 (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

space_id*string

The space's id, lab_ and a ULID, from List spaces.

Response Body

iohr.rfcs.v1.GetSettingsResponse

application/json
  1. response

iohr.rfcs.v1.GetSettingsResponse

settings?

iohr.rfcs.v1.Settings

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.rfcs.getSettings("<space_id>");  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.

{  "settings": {    "approvals_required": 0,    "redaction": {      "domains": [        "string"      ],      "patterns": [        {          "id": "string",          "re": "string",          "why": "string"        }      ],      "words": [        "string"      ]    },    "updated_at": "string"  }}

Delete a space DELETE

Delete a space with every document, version, comment, review and diagram in it. Owners and admins only; it cannot be undone, so export it first. Needs scope `rfc:write`.

Update a space's settings PUT

Replace the redaction rules and the approvals a decision needs. Owners and admins only. Needs scope `rfc:write`.