Get OPA Access Policy Items

GET 
/sites/:siteId/opa/accessPolicy/policyItems

Returns OPA Access Policy Items, can only be requested with ADMIN privileges

Request

Path Parameters

siteId stringrequired

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

policyItems

object[]

Array [

type OpaPolicyItemType (string)

Type of Opa Policy Item

Possible values: [ALLOW]

policy string

OPA Policy in REGO format

allRoles string[]

User must match all roles

anyRoles string[]

User must match any role

attributes

object[]

Array [

key string

Attribute Key

eq

object

Attribute EQ criteria

stringValue string

The value to compare the Attribute Key value to

numberValue number

The value to compare the Attribute Key value to

booleanValue boolean

The value to compare the Attribute Key value to

input

object

matchUsername boolean

Match Input Username

gt

object

Attribute greater than criteria

numberValue number

The value to compare the Attribute Key value to

gte

object

Attribute greater than and equals to criteria

numberValue number

The value to compare the Attribute Key value to

lt

object

Attribute less than criteria

numberValue number

The value to compare the Attribute Key value to

lte

object

Attribute less than and equals to criteria

numberValue number

The value to compare the Attribute Key value to

neq

object

Attribute not equal to criteria

stringValue string

The value to compare the Attribute Key value to

]

]

Example (from schema)

{
  "policyItems": [
    {
      "type": "ALLOW",
      "policy": "string",
      "allRoles": [
        "string"
      ],
      "anyRoles": [
        "string"
      ],
      "attributes": [
        {
          "key": "string",
          "eq": {
            "stringValue": "string",
            "numberValue": 0,
            "booleanValue": true,
            "input": {
              "matchUsername": true
            }
          },
          "gt": {
            "numberValue": 0
          },
          "gte": {
            "numberValue": 0
          },
          "lt": {
            "numberValue": 0
          },
          "lte": {
            "numberValue": 0
          },
          "neq": {
            "stringValue": "string"
          }
        }
      ]
    }
  ]
}

Loading...