Integrations - Scopes API

Integrations are a new feature currently in beta-test: this API is subject to change without notice.

List all scopes of an integration

List all scopes of an integration with a specific ID.

GET /integrations/:id/scopes

Response

Status: 200 OK
[
  {
    "id": 1,
    "effect": "allow",
    "actions": [
      "request:Read",
      "request:Update"
    ],
    "nodeID": "..."
  },
  "..."
]

The response contains these fields by default.

Collection Fields

By default the following fields will appear in collections of integration scopes:

id effect actions

Get a single scope of an integration

GET /integrations/:id/scopes/:scope_id

Response

Status: 200 OK
{
  "id": 1,
  "effect": "allow",
  "actions": [
    "request:Read",
    "request:Update"
  ],
  "nodeID": "..."
}

The response contains these fields.

Fields

actions
Required array of string — Actions this scope applies to. Each action has the format <record type>:<operation>.
created_at
Readonly datetime — The date and time at which the scope was created.
conditions
Required array of string — Conditions for this scope.
effect
Required enum, default: allow — Whether this scope allows or prevents access. Valid values are:
  • allow: Allow the actions of this scope
  • deny: Deny (i.e. do not allow) the actions of this scope
id
Readonly integer — The unique ID of the scope.
updated_at
Readonly datetime — The date and time of the last update of the scope. If the scope has no updates it contains the created_at value.