Users
Desc: Create user
This API functionality resembles the Manage Colleagues functionality that is available in the front-end. Using the API you can:
Create a new user
Give that user a role in your organisation
Charity Editor
Charity Reporter
Charity Observer
Give that user a role in one or more of your projects. Roles you can give are
Project Editor
Project Reporter
Project Observer
Decide whether that newly created user is an Organisation-controlled User or a User-controlled User (Note: that you can only select Organisation-controlled User if your organisation has turned on Organisation-controlled Users: Organisation-controlled User Accounts )
If the user is going to be Organisation-controlled, input true in the charity_controlled part; otherwise input false
If you set the newly created user as an Organisation-controlled User, you can choose whether their Email Notifications are turned on or off.
If you want emails to be disabled for the user, then in the disable_email_notification field, input true; otherwise input false
url: api/v2/users
method: POST
NOTE: tmp_key is valid for 15 days only
params:
{
"tmp_key": “Sogi0SG4nQeKKA78dLpfNojuH0bRMyZnfflxjzztC+jjqCj7sawZS4+QMJJNGtb9ag3/cwu8L7Nj83nJTjdMCPu0LD+P53cpZe70MDgdIZ63FlzYYaUS4pE7eFBj4FooJ8xTVhQiFNxL--T8wrBEmkdyx7Ke/Y--hg71W3RVhJhEhHz9Jv7SHA==",
"user": {
"email": "user103@example.com",
"first_name": "User101",
"last_name": "100",
"password": "changeme",
"password_confirmation": "changeme"
}
"charity_controlled": "true",
"disable_email_notification": "false",
"charity_id": 31
}
response:
{
"user": {
"id": 557,
"email": "user104@example.com"
},
"message": "Sign up successfully!!!"
}
Desc: Get users
url: /users
params: default params
response example: default response example (multiple records)
Desc: Get a single user
url: /users/:id
response example: default response example (single record)
Desc: Get user permissions (not merged)
url: /users/permissions
Desc: Reset password (not merged)
url: /users/reset_password
method: POST
body: {
email: my_email@gmail.com,
reset_code: DD3CB5B7C260,
password: new_password
}
Desc: make reset password request - sends reset code to the user email (not merged)
url: /users/request_password_reset_code
method: GET
params: {
email: my_email
}
Desc: check if reset code is correct (not merged)
url: /users/check_password_reset_code
method: GET
params: {
email: my_email,
reset_code: code
}
response: {
is_reset_code_correct: true
}