v3 Ushahidi Platform REST API Documentation
  • V3
    • Overview
    • Login & Register
    • Posts
      • Sub Posts & Translation
    • Tags
    • Configuration
    • Data provider
    • Country Code
    • Tos
    • Permissons
    • Roles
    • Users
      • User Settings
    • Saved Search
    • Collections
      • Collections Page
    • Messages
    • Exports
    • Contacts
    • HXL
    • Media
    • Verifier
    • Migration
    • Notification
    • Layer
    • Webhooks
    • Api Keys
    • Forms
      • Form Attribute
      • Form Contacts
      • Form Role
      • Form Stages
    • CSV
    • Test
  • V5
    • Overview
    • Posts
    • Surveys
    • Categories
Powered by GitBook
On this page
  1. V3

Users

PreviousRolesNextUser Settings

add user

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

Request Body

Name
Type
Description

email

String

The user's email address

failed_attempts

Integer

Number of failed attempts

logins

integer

Number of login attempts

realname

String

The user's real name

password

String

The user's password

last_attempt

String

Date of previous login attempt

last_login

String

Last login date

gravatar

String

The user's gravatar

role

String

user's roleString

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

edit user

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

Request Body

Name
Type
Description

email

String

The user's email address

failed_attempts

Integer

Number of failed attempts

logins

integer

Number of login attempts

realname

String

The user's real name

password

String

The user's password

last_attempt

String

Date of previous login attempt

last_login

String

Last login date

gravatar

String

The user's gravatar

role

String

user's roleString

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

edit admin user

PUT https://ushahididocs.api.ushahidi.io/api/v3/users/me

Request Body

Name
Type
Description

email

String

The user's email address

failed_attempts

Integer

Number of failed attempts

logins

integer

Number of login attempts

realname

String

The user's real name

password

String

The user's password

last_attempt

String

Date of previous login attempt

last_login

String

Last login date

gravatar

String

The user's gravatar

role

String

user's roleString

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

get users

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

rolestringOptional

Filter parameter to return the users who have the role/roles. ItAccepts multiple values as an array or as a string but they will be separated by a comma

Responses
200
OK
application/json
401
Unauthorized
application/json
get
GET /api/v3/users HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 11,
  "results": [
    {
      "id": 1,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/1",
      "email": "test5@v3.ushahidi.com",
      "realname": "Test User",
      "logins": 1,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "updated": "2022-10-12T17:43:01.000Z",
      "role": "user",
      "contacts": [
        {
          "id": "1",
          "user_id": "1",
          "type": "phone",
          "contact": "123456789",
          "created": "0",
          "can_notify": "0"
        },
        {
          "id": "4",
          "user_id": "1",
          "type": "email",
          "contact": "robbie@ushahidi.com",
          "created": "0",
          "can_notify": "0"
        }
      ],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "1bef20a68c42ddc2f7d56a91d743cbe4"
    },
    {
      "id": 2,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2",
      "email": "admin@ushahidi.com",
      "realname": "Test User",
      "logins": 1,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "updated": "2022-10-12T17:48:09.000Z",
      "role": "admin",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "3578216d69634e299351bb18b7c7fc46"
    },
    {
      "id": 3,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/3",
      "email": "test@v3.ushahidi.com",
      "realname": "Test User",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "user",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "982d5f5e2b53f4843ca1fe521025b342"
    },
    {
      "id": 4,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/4",
      "email": "importadmin@ushahidi.com",
      "realname": "Import admin",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "admin",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "c667c46b2d69005b456f0bbff0935297"
    },
    {
      "id": 5,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/5",
      "email": "demo@ushahidi.com",
      "realname": "Demo",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "admin",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "6e5562e5ac73cdff1c2c8b3b341fddf7"
    },
    {
      "id": 6,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/6",
      "email": "manager@ushahidi.com",
      "realname": "Manager",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "manager",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "48ee41c3fcea33d677c75aefca9293fc"
    },
    {
      "id": 7,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/7",
      "email": "importer@ushahidi.com",
      "realname": "Importer",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "6becb41fec259d4206e32b038439df3f"
    },
    {
      "id": 9,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/9",
      "email": "sets@ushahidi.com",
      "realname": "Sets",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "sets",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "324509b8efe1d480fc094010fb577019"
    },
    {
      "id": 10,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/10",
      "email": "settingsmanager@ushahidi.com",
      "realname": "Settings Manager",
      "logins": 0,
      "failed_attempts": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": "settingsmanager",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "739096134b0557256853dfdf87295aa3"
    },
    {
      "id": 11,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/11",
      "email": "test3@v3.ushahidi.com",
      "realname": "Test User",
      "logins": 0,
      "failed_attempts": 0,
      "created": "2022-10-12T17:37:42.000Z",
      "role": "user",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "efcce0e9872c8640a361cab9e2ede9a2"
    },
    {
      "id": 12,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/12",
      "email": "test4@v3.ushahidi.com",
      "realname": "Test User",
      "logins": 1,
      "failed_attempts": 0,
      "created": "2022-10-12T17:39:11.000Z",
      "role": "user",
      "contacts": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
      ],
      "gravatar": "df2b78c283eab681750183e449acc6bf"
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/users?orderby=id&order=asc&offset=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/users?orderby=id&order=asc&offset=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/users?orderby=id&order=asc&offset=0",
  "total_count": 11
}

get user

get
Authorizations
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
get
GET /api/v3/users/3 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 3,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/3",
  "email": "test@v3.ushahidi.com",
  "realname": "Test User",
  "logins": 0,
  "failed_attempts": 0,
  "created": "1970-01-01T00:00:00.000Z",
  "role": "user",
  "contacts": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "read_full",
    "register"
  ],
  "gravatar": "982d5f5e2b53f4843ca1fe521025b342"
}

delete user

delete
Authorizations
Responses
200
OK
application/json
404
Not Found
application/json
delete
DELETE /api/v3/users/80 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 8,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/8",
  "email": "cannoteditor@ushahidi.com",
  "realname": "CannotEditor",
  "logins": 0,
  "failed_attempts": 0,
  "created": "1970-01-01T00:00:00.000Z",
  "role": "noedit",
  "contacts": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search",
    "read_full",
    "register"
  ],
  "gravatar": "751293f3d634b7f892f5441b2741abe6"
}

get account/admin user

get
Authorizations
Responses
200
OK
application/json
401
Unauthorized
application/json
get
GET /api/v3/users/me HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 2,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/users/2",
  "email": "admin@ushahidi.com",
  "realname": "Admin",
  "logins": 0,
  "failed_attempts": 0,
  "created": "1970-01-01T00:00:00.000Z",
  "role": "admin",
  "contacts": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "search",
    "read_full",
    "register"
  ],
  "gravatar": "3578216d69634e299351bb18b7c7fc46"
}
  • GETget users
  • add user
  • GETget user
  • edit user
  • edit admin user
  • DELETEdelete user
  • GETget account/admin user