voxel.hapi.permissions.list

List hAPI permission details.

Parameters

authkey (optional)
Authentication key associated with a Voxel username
verbosity (optional)
Verbosity of response. Should be one of "compact", "normal", or "extended".

Example Response

<permissions authkey="4eb787e0035b1314a38af2891b125b6b">
  <category name="REQUIRE_SECURE">
    <description>
      Methods that must be accessed via an SSL endpoint
    </description>
    <read>allow</read>
    <update>deny</update>
    <create>deny</create>
    <delete>deny</delete>
  </category>
  ...
</permissions>

Notes

All hAPI permissions for the authenticated hAPI user will be listed. Optionally, the authentication key of a user on the account for whom to list permissions may be specified.

Permissions in hAPI are managed using a matrix of method categories and actions. Within a given category of methods, a user may be (dis)allowed to read, update, create, or delete data. Permissions may be adjusted using hapi.permissions.update.

Sending verbosity=compact will yield a compressed output without category descriptions, in which the permissions for each action are given as attributes in each category tag.

Method Specific Error Codes

None