Login & Register

login

POSThttps://ushahididocs.api.ushahidi.io/oauth/token

Body

application/x-www-form-urlencoded

username*string

The Ushahidi login username/email

Example: "[e-mail]"

password*string

The Ushahidi password

Example: "Doc@test2022"

grant_type*string

Login grant type. Use Password for this grant type

Example: "password"

client_id*string

The user client ID

Example: "ushahidiui"

client_secret*string

The client unique secret indentifier

Example: "35e7f0bca957836d05ca0492211b0ac707671261"

scopestring

You need to also provide the scope. you can add multiple scope to this parameters. (Scope Options - posts, country_codes, media, forms, api, tags, savedsearches, sets, users, stats, layers, config, messages, notifications, webhooks, contacts, roles, permissions, csv, tos dataproviders, migrate, apikeys)

Example: "posts country_codes media forms api tags savedsearches sets users stats layers config messages notifications webhooks contacts roles permissions csv tos dataproviders migrate apikeys"

Response

200

OK

Body

application/json; charset=UTF-8

token_type*string

expires_in*integer (int32)

access_token*string

refresh_token*string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/oauth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "client_id": "ushahidiui",
      "client_secret": "35e7f0bca957836d05ca0492211b0ac707671261",
      "grant_type": "password",
      "password": "Doc@test2022",
      "username": "[e-mail]"
    }),
});
const data = await response.json();

Response

200

{
  "token_type": "text",
  "expires_in": 0,
  "access_token": "text",
  "refresh_token": "text"
}

register

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

Request Body

Name	Type	Description
email*	String	The user's email address
password*	String	The user's password

200: OK

{
    "id": 13,
    "url": "http://localhost:8000/api/v3/users/13",
    "email": "[e-mail]",
    "realname": null,
    "logins": 0,
    "failed_attempts": 0,
    "last_login": null,
    "last_attempt": null,
    "created": "2022-11-03T23:19:23+00:00",
    "updated": null,
    "role": "user",
    "language": null,
    "contacts": [],
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
    ],
    "gravatar": "276f7d2512f5e6e6f99b5e405b944581"
}

password reset

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

Request Body

Name	Type	Description
email*	String	The user's registered email address

200: OK Ok

confirm password reset

POST https://ushahididocs.api.ushahidi.io/api/v3/passwordreset/confirm

Request Body

Name	Type	Description
token*	String	The password reset token the user received in their mail
password*	String	The user's new password

200: OK Ok