Documentation Documentation

Users

List Users

Property Description
Resource URL /api/users
Method GET
Type None
Body None
Param None

Sample Request

GET /api/users HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

Sample Response

{
  "users": [
    {
      "api_model": {},
      "first_name": "John",
      "last_name": "Smith",
      "email_address": "[email protected]",
      "password": "$2a$10$mRVfrAf72N66anVNhA1KVuYaOwOrXhFzxyg6bwgZemUeVo2MNOpIa",
      "org_id": "54b53d3aeba6db5c35000002",
      "active": true,
      "id": "54b53d4bf25b920f09361526",
      "access_key": "0cf5e6c37add465a406f19807c081765"
    },
    {
      "api_model": {},
      "first_name": "Test",
      "last_name": "User",
      "email_address": "[email protected]",
      "password": "",
      "org_id": "54b53d3aeba6db5c35000002",
      "active": true,
      "id": "54bd0ad9ff4329b88985aafb",
      "access_key": "f81ee6f0c8f2467d539c132c8a422346"
    }
  ],
  "pages": 0
}

Get User

Property Description
Resource URL /api/users/{user-id}
Method GET
Type None
Body None
Param None

Sample Request

GET /api/users/54bd0ad9ff4329b88985aafb HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

Sample Response

{
  "api_model": {},
  "first_name": "Test",
  "last_name": "User",
  "email_address": "[email protected]",
  "password": "",
  "org_id": "54b53d3aeba6db5c35000002",
  "active": true,
  "id": "54bd0ad9ff4329b88985aafb",
  "access_key": "f81ee6f0c8f2467d539c132c8a422346"
}

Add User

Note: You can add a user via the API without a password by leaving out the password field. You then use Set User Password request to add a password.

You need to have the users Permission object set to write to use Add User.

If you do set a password, you need to keep a record of it, to enable the password to be reset in the future.

Property Description
Resource URL /api/users
Method POST
Type None
Body User Object
Param None

Sample Request

POST /api/users HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

{
  "first_name": "Jason",
  "last_name": "Jasonson",
  "email_address": "[email protected]",
  "active": true,
  "password": "thisisatest",
  "user_permissions": { "IsAdmin": "admin" }
}

Sample Response

{
  "Status": "OK",
  "Message": "User created",
  "Meta": ""
}

Set User Password

If a user is created with a blank password, you will need to add a password in a second API call to set a password. In this scenario, the current_password field is not required. To change an current password, you need to know the existing password set in Add User.

You need to have the users Permission object set to write to use Set User Password.

Property Description
Resource URL /api/users/{user-id}/actions/reset
Method POST
Type None
Body Password Object
Param None

Sample Request

POST /api/users/54c25e845d932847067402e2/actions/reset HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

{
  "current_password": "12345",
  "new_password":"test123456",
  "user_permissions": { "IsAdmin": "admin" }
}

Sample Response

{
  "Status": "OK",
  "Message": "User password updated",
  "Meta": ""
}

Allow Reset Password

Property Description
Resource URL /admin/users/{user-id}/actions/allow_reset_passwords
Method PUT
Type None
Body None
Param None

Sample Request

PUT -H "admin-auth: <your secret>" http://<dashboard>/admin/users/{user-id}/actions/allow_reset_passwords

Sample Response

{
  "Status": "OK",
  "Message": "User updated",
  "Meta": 
    { …user object payload …}
}

Disallow Reset Password

Property Description
Resource URL /admin/users/{user-id}/actions/disallow_reset_passwords
Method PUT
Type None
Body None
Param None

Sample Request

PUT -H "admin-auth: <your secret>" http://<dashboard>/admin/users/{user-id}/actions/disallow_reset_passwords

Sample Response

{
  "Status": "OK",
  "Message": "User updated",
  "Meta": 
    { …user object payload …}
}

Update User

You need to have the users Permission object set to write to use Update User.

Property Description
Resource URL /api/users/{user-id}
Method PUT
Type None
Body User Object
Param None

Sample Request

PUT /api/users/54c25e845d932847067402e2 HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

{
  "first_name": "Jason",
  "last_name": "File",
  "email_address": "[email protected]",
  "active": true,
  "user_permissions": { "IsAdmin": "admin" }
}

Sample Response

{
  "Status": "OK",
  "Message": "User updated",
  "Meta": null
}

Delete User

Property Description
Resource URL /api/users/{user-id}
Method DELETE
Type None
Body None
Param None

Sample Request

DELETE /api/users/54c25e845d932847067402e2 HTTP/1.1
Host: localhost:3000
authorization:7a7b140f-2480-4d5a-4e78-24049e3ba7f8

Sample Response

{
  "Status": "OK",
  "Message": "User deleted",
  "Meta": ""
}