permission_checks

check_contact_permission

POST

/api/v2/permission_checks/check_contact_permission

Whether the contact, signed in with the role, has access ('r' or 'rw') to path, and why.

Code
Runs the site's engine on the saved rules. ``deciding`` names the rule that decided (null for a free pass or
the default); on V2 ``also_matching`` lists the weaker rules that also match, and on V1 ``replaced`` the rules
with the same path that the deciding one overwrote.

check_contact_permission › Request Body

contact_id

string · uuid · required

role_id

string · uuid · required

path

string · minLength: 1 · maxLength: 500 · required

access

string · enum · required

Enum values:

check_contact_permission › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/permission_checks/check_contact_permission

curl --request POST \
  --url /api/v2/permission_checks/check_contact_permission \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "00000000-0000-0000-0000-000000000000",
  "role_id": "00000000-0000-0000-0000-000000000000",
  "path": "path",
  "access": "r"
}
'

Example Request Body

{
  "contact_id": "00000000-0000-0000-0000-000000000000",
  "role_id": "00000000-0000-0000-0000-000000000000",
  "path": "path",
  "access": "r"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "allowed": true,
    "engine": {
      "version": "version",
      "restriction": true
    },
    "free_pass": true,
    "default_applied": true,
    "staff_account": true,
    "deciding": {
      "layer": "layer",
      "source_name": "source_name",
      "permission_level_id": "permission_level_id",
      "permission_level_name": "permission_level_name",
      "rule": "rule",
      "access": "access",
      "locked": true
    },
    "also_matching": [
      {
        "layer": "layer",
        "source_name": "source_name",
        "permission_level_id": "permission_level_id",
        "permission_level_name": "permission_level_name",
        "rule": "rule",
        "access": "access",
        "locked": true
      }
    ],
    "replaced": [
      {
        "layer": "layer",
        "source_name": "source_name",
        "permission_level_id": "permission_level_id",
        "permission_level_name": "permission_level_name",
        "rule": "rule",
        "access": "access",
        "locked": true
      }
    ]
  }
}

json

application/json

retrieve_contact_permission_levels

POST

/api/v2/permission_checks/retrieve_contact_permission_levels

The levels that apply to the contact signed in with the role, in the order the engine merges them.

Code
Returns
-------
dict
    ``{engine: {version, restriction}, staff_account, layers: [{layer, source_name, permission_level_id,
    permission_level_name}]}``: the role's level, each user group's levels, then the contact's own.

retrieve_contact_permission_levels › Request Body

contact_id

string · uuid · required

role_id

string · uuid · required

retrieve_contact_permission_levels › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/permission_checks/retrieve_contact_permission_levels

curl --request POST \
  --url /api/v2/permission_checks/retrieve_contact_permission_levels \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "00000000-0000-0000-0000-000000000000",
  "role_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "contact_id": "00000000-0000-0000-0000-000000000000",
  "role_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "engine": {
      "version": "version",
      "restriction": true
    },
    "staff_account": true,
    "layers": [
      {
        "layer": "layer",
        "source_name": "source_name",
        "permission_level_id": "permission_level_id",
        "permission_level_name": "permission_level_name"
      }
    ]
  }
}

json

application/json

perils permission_levels