Retrieve a realm ruleset

GET 
/rules/realm/:id

Retrieve a realm ruleset

Request

Path Parameters

id int64required

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

idint64
versionint64
createdOndate-time
lastModifieddate-time
namestringrequired

Possible values: >= 3 characters and <= 255 characters

enabledboolean
rulesstring
langstringrequired

Possible values: [JAVASCRIPT, GROOVY, JSON, FLOW]

meta

object
statusstring

Possible values: [READY, DEPLOYED, COMPILATION_ERROR, VALIDITY_PERIOD_ERROR, EXECUTION_ERROR, LOOP_ERROR, DISABLED, PAUSED, EXPIRED, REMOVED, EMPTY]

errorstring
realmstring
accessPublicReadboolean

Example (from schema)

{
  "id": 0,
  "version": 0,
  "createdOn": "2024-07-29T15:51:28.071Z",
  "lastModified": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "enabled": true,
  "rules": "string",
  "lang": "JAVASCRIPT",
  "meta": {},
  "status": "READY",
  "error": "string",
  "realm": "string",
  "accessPublicRead": true
}