AGagntcy
PolicyService

PATCH /v1alpha1/policies/{policyId}/rules/{ruleId}

Changed on

Update a Rule.

Request

  • Base URL
    http://localhost:4000
  • Auth
    HTTP bearer and API key in header x-id-api-key

Path parameters

policyIdstring required

The Policy Id to which these Rules belong.

ruleIdstring required

Rule Id to update.

Request body

policyIdstring

The Policy Id to which these Rules belong.

ruleIdstring

Rule Id to update.

namestring

A human-readable name for the Rule.

descriptionstring

A human-readable description for the Rule.

tasksstring[]

The tasks that this Rule applies to.

needsApprovalboolean

Need User Approval for this Rule.

action'RULE_ACTION_UNSPECIFIED' | 'RULE_ACTION_ALLOW' | 'RULE_ACTION_DENY' enum

The action applied for the rule when calling the tasks

Response

OK

idstring

A unique identifier for the Rule.

namestring required

A human-readable name for the Rule.

descriptionstring

A human-readable description for the Rule.

policyIdstring
action'RULE_ACTION_UNSPECIFIED' | 'RULE_ACTION_ALLOW' | 'RULE_ACTION_DENY' enum required

The action applied for the rule when calling the specified tasks

needsApprovalboolean required

Need User Approval for this Rule.

createdAtstring date-time

CreatedAt records the timestamp of when the Rule was initially created

Changes

  • 63464ebf3f61Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the optional property to the response with the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status