GET

Permission List

Display all assignable permissions for Asset

The implied property of a given permission shows which additional permissions are automatically granted when assigning that particular permission.

The contradictory property shows which permissions are removed when assigning that particular permission.

GET /api/v2/permissions/

Example

  curl -X GET https://[kpi]/api/v2/permissions/

Response

   {
      "count": 9,
      "next": null,
      "previous": null,
      "results": [
          {
              "url": "http://kpi/api/v2/permissions/change_submissions/",
              "codename": "change_submissions",
              "implied": [
                  "http://kpi/api/v2/permissions/view_asset/"
              ],
              "contradictory": [
                  "http://kpi/api/v2/permissions/partial_submissions/"
              ],
              "name": "Can modify submitted data for asset"
           },
           ...
          {
              "url": "http://kpi/api/v2/permissions/add_submissions/",
              "codename": "add_submissions",
              "implied": [],
              "contradictory": [],
              "name": "Can submit data to asset"
           }
      ]
   }

GET /api/v2/permissions/{codename}

Example

  curl -X GET https://[kpi]/api/v2/permissions/change_submissions

Response

          {
              "url": "http://kpi/api/v2/permissions/change_submissions/",
              "codename": "change_submissions",
              "implied": [
                  "http://kpi/api/v2/permissions/view_asset/"
              ],
              "contradictory": [
                  "http://kpi/api/v2/permissions/partial_submissions/"
              ],
              "name": "Can modify submitted data for asset"
           }

CURRENT ENDPOINT

GET /api/v2/permissions/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/add_submissions/",
            "codename": "add_submissions",
            "implied": [],
            "contradictory": [],
            "name": "Can submit data to asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/change_asset/",
            "codename": "change_asset",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [],
            "name": "Can change asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/change_submissions/",
            "codename": "change_submissions",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/add_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [
                "https://kf.kobotoolbox.org/api/v2/permissions/partial_submissions/"
            ],
            "name": "Can modify submitted data for asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/delete_submissions/",
            "codename": "delete_submissions",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [
                "https://kf.kobotoolbox.org/api/v2/permissions/partial_submissions/"
            ],
            "name": "Can delete submitted data for asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/discover_asset/",
            "codename": "discover_asset",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [],
            "name": "Can discover asset in public lists"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/manage_asset/",
            "codename": "manage_asset",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/validate_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/",
                "https://kf.kobotoolbox.org/api/v2/permissions/change_asset/",
                "https://kf.kobotoolbox.org/api/v2/permissions/change_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/discover_asset/",
                "https://kf.kobotoolbox.org/api/v2/permissions/add_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/delete_submissions/"
            ],
            "contradictory": [],
            "name": "Can manage all aspects of asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/partial_submissions/",
            "codename": "partial_submissions",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/change_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/delete_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/validate_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/manage_asset/"
            ],
            "name": "Can make partial actions on submitted data for asset for specific users"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/validate_submissions/",
            "codename": "validate_submissions",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [
                "https://kf.kobotoolbox.org/api/v2/permissions/partial_submissions/"
            ],
            "name": "Can validate submitted data asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/",
            "codename": "view_asset",
            "implied": [],
            "contradictory": [],
            "name": "Can view asset"
        },
        {
            "url": "https://kf.kobotoolbox.org/api/v2/permissions/view_submissions/",
            "codename": "view_submissions",
            "implied": [
                "https://kf.kobotoolbox.org/api/v2/permissions/view_asset/"
            ],
            "contradictory": [
                "https://kf.kobotoolbox.org/api/v2/permissions/partial_submissions/"
            ],
            "name": "Can view submitted data for asset"
        }
    ]
}