API User Management

Jump to bottom Edit New page

Matt Campbell edited this page Feb 10, 2015 · 4 revisions

#User Management API

GET /user

"user_admin" scope required
login required

Returns a list of all users.

curl -i --user admin:<pw> -X GET http://localhost:4000/user

{
	"users": [
	{
     "active": true, 
     "email": "email@email", 
     "first_name": null, 
     "id": 1, 
     "last_name": null, 
     "organization_id": null, 
     "phone_alternate": null, 
     "phone_primary": null, 
     "role": "Administrator", 
     "scopes": [
       "user_admin"
     ], 
     "user_id": "1", 
     "user_name": "admin"
    }
  ]
}

##GET /user/int:id

"user_admin" scope required
login required

Returns a single user by id.

curl -i --user admin:<pw> -X GET http://localhost:4000/user/1

{
  "active": true, 
  "email": "email@email", 
  "first_name": null, 
  "id": 1, 
  "last_name": null, 
  "organization_id": null, 
  "phone_alternate": null, 
  "phone_primary": null, 
  "role": "Administrator", 
  "scopes": [
    "user_admin"
  ], 
  "user_id": "1", 
  "user_name": "admin"
}

POST /user

PUT /user/int:id