Policies

List existing policies.

Changed on

Returns the caller's policies, paged, each with its name, description, revision, and when it was created and last changed. Admins may list another user's policies by passing that user's username as owner, or every user's with all_users=true, which also names each policy's owner and requires ADMIN_CROSS_USER_ACCESS_ENABLED. With managed=true, returns the built-in managed policies instead. With deleted=true, returns the caller's (or owner's) deleted policies whose version history is kept, by name, each with its latest revision and when and by whom it was deleted; read a deleted policy's history with GET /api/policies/{policyName}/versions. Requires the policies:read scope.

get/api/policies

Request

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

Query parameters

ownerstring
all_usersboolean
managedboolean
deletedboolean
qstring
sortstring
orderstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

A page of policies in policies, and the total. With deleted, each item describes a deleted policy.

totalinteger

How many policies the listing has across every page.

Changes

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • breaking

      added to the / response property oneOf list for the response status