Permissons | v3 Ushahidi Platform REST API Documentation

v3 Ushahidi Platform REST API Documentation

Get permissions

get

Authorizations

Query parameters

orderbystringOptional

Sorting parameter Available values : entity fields Default value : id

orderstringOptional

Sorting parameter Available values : [ASC,DESC] Default value : ASC

limitinteger · int32Optional

Paging parameter Default value : null

offsetinteger · int32Optional

Paging parameter Default value : 0

qstringOptional

Filter parameter if this parameter is set then the api will return posts containing q text in name property

Responses

200

application/json

401

Unauthorized

application/json

get

GET /api/v3/permissions HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 8,
  "results": [
    {
      "id": 1,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/1",
      "name": "Manage Users",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 2,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/2",
      "name": "Manage Posts",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 3,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/3",
      "name": "Manage Settings",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 4,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/4",
      "name": "Bulk Data Import and Export",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 5,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/5",
      "name": "Edit their own posts",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 6,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/6",
      "name": "Manage Collections and Saved Searches",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 7,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/7",
      "name": "Delete Posts",
      "allowed_privileges": [
        "read",
        "search"
      ]
    },
    {
      "id": 8,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/8",
      "name": "Delete Their Own Posts",
      "allowed_privileges": [
        "read",
        "search"
      ]
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/permissions?orderby=id&order=asc&offset=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/permissions?orderby=id&order=asc&offset=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/permissions?orderby=id&order=asc&offset=0",
  "total_count": 8
}

Get permission

get

Authorizations

Responses

200

application/json

404

Not Found

application/json

get

GET /api/v3/permissions/100 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/permission/1",
  "name": "Manage Users",
  "allowed_privileges": [
    "read",
    "search"
  ]
}