policies

Changed on

PolicyBinding Viewset

patch/policies/bindings/{policy_binding_uuid}/

Request

  • Base URL: https://api.goauthentik.io/api/v3
  • URL: https://api.goauthentik.io/api/v3/policies/bindings/{policy_binding_uuid}/
  • Auth: HTTP bearer

Path parameters

policy_binding_uuidstring uuid required

A UUID string identifying this Policy Binding.

Request body

policystring uuid nullable
groupstring uuid nullable
userinteger nullable
targetstring uuid
negateboolean

Negates the outcome of the policy. Messages are unaffected.

enabledboolean
dry_runboolean

Execute the policy but ignore its result.

orderinteger
timeoutinteger

Timeout after which Policy execution is terminated.

failure_resultboolean

Result if the Policy execution fails.

Response

pkstring uuid required
policystring uuid nullable
groupstring uuid nullable
userinteger nullable
targetstring uuid required
negateboolean

Negates the outcome of the policy. Messages are unaffected.

enabledboolean
dry_runboolean

Execute the policy but ignore its result.

orderinteger required
timeoutinteger

Timeout after which Policy execution is terminated.

failure_resultboolean

Result if the Policy execution fails.

expiresstring date-time nullable required
expiringboolean required

Changes

  • a1e3f6c427d9Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • c5b9786ece16Revision changes
    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status