Roles

Get roles

GEThttps://ushahididocs.api.ushahidi.io/api/v3/roles

Query parameters

Response

200401

OK

Body

application/json

countinteger

resultsarray of RoleResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "results": [
    {
      "url": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "permissions": [
        false
      ],
      "allowed_priviledges": [
        "text"
      ]
    }
  ],
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text"
}

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

GEThttps://ushahididocs.api.ushahidi.io/api/v3/roles/100

Response

200404

OK

Body

application/json

idinteger

urlstring

namestring

display_namestring

descriptionstring

permissionsarray of boolean

allowed_priviledgesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/roles/100', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "url": "text",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "permissions": [
    false
  ],
  "allowed_priviledges": [
    "text"
  ]
}

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

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/roles/8

Response

200404

OK

Body

application/json

idinteger

urlstring

namestring

display_namestring

descriptionstring

permissionsarray of boolean

allowed_priviledgesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/roles/8', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "url": "text",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "permissions": [
    false
  ],
  "allowed_priviledges": [
    "text"
  ]
}