Rules

Patch authorization rules

Performs a set of rule management actions as specified in a JSON patch. The actions are performed synchronously and transactionally. A resource collection of all created and revised rules is returned. If the patch is not successfully applied, changes are rolled back.

For every action, the patch must specify an operation (add, replace, remove, test, or copy) and a target URI (for example, /authorization/rules/{ruleId} or, to create a new rule, /authorization/rules). Each add and replace operation requires a valid rule representation. Each copy operation requires a 'from' URI that identifies the original rule.

You cannot save duplicate rules, so a patch that includes a copy operation must also include an operation that modifies or deletes either the original rule or the new rule.

You can combine operations to migrate existing rules. For example, you might copy a rule, then update the new rule (using the 'replace' operation), and then delete the original rule.

New rules that do not yet have known rule IDs are added to a zero-indexed ordered list. To reference such rules, use the substitution token @CREATED#@ (where '#' is the index of the target rule).

patch/rules

Request

  • Base URL: http://example.com/authorization
  • URL: http://example.com/authorization/rules
  • Auth: none declared

Request body

op'add' | 'replace' | 'remove' | 'test' | 'copy' required

The type of operation to perform on the defined rule.

pathstring required

The URI of the rule.

Response

The request succeeded. Returned if the patch was applied successfully.

state'pending' | 'running' | 'completed' | 'completedWithErrors' | 'failed'

Defines the current state of an action.

Changes

No recorded changes to this operation across all 1 revision of this API.