InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
DELETE
/v1/accounts/orgs/{org_id}/connections/{connection_id}/grants/{grant_id}

The next call the grant covered is refused.

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

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

connection_id*string

The connection's id, con_ and a ULID, from List connections.

grant_id*string

The grant's id, gnt_ and a ULID.

Response Body

iohr.connections.v1.RevokeGrantResponse

application/json
  1. response

iohr.connections.v1.RevokeGrantResponse

grant?

iohr.connections.v1.Grant

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.connections.revokeGrant("<org_id>", "<connection_id>", "<grant_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.

{  "grant": {    "actions": [      "string"    ],    "connection_id": "string",    "consumer": {      "id": "string",      "kind": "string"    },    "created_at": "string",    "created_by": "string",    "expires_at": "string",    "id": "string",    "revoked_at": "string",    "status": "string"  }}

List grants GET

Who may use which actions of the connection until when, newest first, live, expired and revoked. Needs scope `connections:read`.

List a connection's history GET

Every use of the connection, newest first: who, which action, the executor and the outcome. Never a parameter or a body. Needs scope `connections:read`.