PHphilterd
Policies

Get a policy's details.

Changed on

Returns a policy's name, description, notes, current revision, entity tag, whether it is a built-in managed policy, and when it was created and last updated: everything except the policy itself. The ETag header carries the entity tag too, for If-Match. A name starting with managed_ returns that managed policy's details. Admins may read another user's by passing that user's username as owner. Requires the policies:read scope.

get/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

Response

The policy's details.

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 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