PHphilterd
Policies

Set a policy's description and notes.

Changed on

Sets the description (up to 200 characters) and notes (up to 1000). A field left out is left as it is; an empty value clears it. They are not part of the policy, so this does not create a new version, and the revision stays the same, but the entity tag changes. Send the ETag from your read in If-Match to make the write conditional: if the policy, its description, or its notes changed since, nothing is written and the response is 409 with reason policy_changed. Without If-Match the write is not checked against an earlier read. Managed policies cannot be changed. Admins may change another user's by passing that user's username as owner. Requires the policies:write scope.

put/api/policies/{policyName}/details

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/policies/{policyName}/details
  • Auth
    HTTP bearer

Path parameters

policyNamestring required

Query parameters

ownerstring

Headers

Authorizationstring required
If-Matchstring

Request body

descriptionstring
notesstring

Response

The policy's details after the change. The ETag header identifies them.

descriptionstring
namestring
createdstring date-time
etagstring

Identifies the policy together with its description and notes, and changes when any of them does; the revision alone does not change when only the details do. The ETag header carries the same value, quoted. Send it in If-Match to make a replace, a details change, or a rollback conditional.

lastUpdatedstring date-time
managedboolean
notesstring
revisioninteger

Example response

{
  "etag": "7-0123456789abcdef"
}

Changes

  • adb70fdccccbRevision changes
    • info

      added the new optional header request parameter If-Match

    • info

      added the optional property to the response with the status

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status