Roles

Get roles

get

/api/v3/roles

Authorizations

Query parameters

orderbystring

Sorting parameter Available values : entity fields Default value : id

orderstring

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

limitinteger · int32

Paging parameter Default value : null

offsetinteger · int32

Paging parameter Default value : 0

qstring

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

namestring

Filter parameter return the roles with name value

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/roles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

200

{
  "count": 1,
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/roles?orderby=id&order=asc&offset=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/roles?orderby=id&order=asc&offset=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/roles?orderby=id&order=asc&offset=0",
  "total_count": 1,
  "results": [
    {
      "id": 2,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/roles/2",
      "name": "admin",
      "display_name": "Admin",
      "protected": true,
      "permissions": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "search"
      ]
    }
  ]
}

OK

add role

POST https://ushahididocs.api.ushahidi.io/api/v3/roles

Request Body

Name	Type	Description
name	String	Name of the User
permissions	array	An array containing strings of role permissions
description	String	Role description
display_name	String	The user display name
protected	Boolean	Set True to protect the role and false for unprotected

200: OK

{
  "id": 0,
  "url": "string",
  "name": "string",
  "display_name": "string",
  "description": "string",
  "permissions": [
    true
  ],
  "allowed_priviledges": [
    "string"
  ]
}

Get role

get

/api/v3/roles/100

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/roles/100' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 1,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/roles/1",
  "name": "user",
  "display_name": "User",
  "protected": true,
  "permissions": [
    "Edit their own posts",
    "Delete Their Own Posts"
  ],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "search"
  ]
}

OK

edit role

PUT https://ushahididocs.api.ushahidi.io/api/v3/roles/1

Request Body

Name	Type	Description
display_name	String	Display name
permissions	Array	An array containing strings of permissions
description	String	Role description
protected	Boolean	Set True to protect the role and false for unprotected

200: OK

{
  "id": 1,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/roles/1",
  "name": "user",
  "display_name": "test user2",
  "description": "test user description",
  "permissions": [
    "Edit their own posts",
    "Delete Their Own Posts"
  ],
  "protected": true,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "search"
  ]
}

Delete role

delete

/api/v3/roles/8

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://ushahididocs.api.ushahidi.io/api/v3/roles/8' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": 5,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/roles/5",
  "name": "importer",
  "display_name": "Importer",
  "protected": false,
  "permissions": [
    "Bulk Data Import and Export",
    "Edit their own posts",
    "Delete Their Own Posts"
  ],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

OK