PHphilterd
Policies

Get a policy.

Changed on

Returns the full policy with the given name. A name starting with managed_ returns that built-in managed policy. Admins may retrieve another user's policy by passing that user's username as owner. The policy's description and notes are at /api/policies/{policyName}/details. The ETag header identifies the policy as read, together with its description and notes; send it back in If-Match when replacing the policy, setting its details, or rolling it back, so the change is refused if someone else changed the policy since. Requires the policies:read scope.

get/api/policies/{policyName}

Request

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

Path parameters

policyNamestring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

Native policy JSON, preserving field names.

object required

Changes

  • c4f85daa9208Revision changes
    • breaking

      the response's body type changed from string to object for 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

    • info

      added the optional property to the response with the status

  • 4082c17721d8Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status