Create a policy rule.

POST

/api/admin/policies

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "support_user_read", "description": "Allow support users to read user records.", "priority": 100, "effect": "allow", "resource_types": [ "user" ], "actions": [ "read" ], "conditions": [ { "type": "has_role", "params": { "role": "support" } } ] }'

Create a tenant policy rule. The handler requires name and a valid effect, stores resource_types, actions, and conditions as JSON, and returns the new rule identifier.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

JSON request body.

Media type application/json

object

name

required

string

description

string

priority

integer

default: 100

effect

required

string

Allowed values: allow deny

resource_types

Array<string>

actions

Array<string>

conditions

Array<object>

object

type

string

params

object

key

additional properties

key

additional properties

key

additional properties

Example

{
  "name": "support_user_read",
  "description": "Allow support users to read user records.",
  "priority": 100,
  "effect": "allow",
  "resource_types": [
    "user"
  ],
  "actions": [
    "read"
  ],
  "conditions": [
    {
      "type": "has_role",
      "params": {
        "role": "support"
      }
    }
  ]
}

Responses

201

Policy rule creation response.

Media type application/json

object

success

required

boolean

rule_id

required

string

key

additional properties

Example

{
  "success": true,
  "rule_id": "policy_123"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}