/
Post Users API

Post Users API

You can register new users on Makerble via the API

When creating users and submitting their new passwords, you must adhere to the following password strength criteria:

  • Must be at least 8 characters long

  • Must contain at least 1 number

  • Must contain at least 1 special character

  • Must contain at least 1 capital letter


API Documentation

Users

Desc: Create user

You must request an API Key in order to use the API to create new users. Send an email to api-key-request@makerble.com with a link to this article: https://makerble.atlassian.net/wiki/spaces/DEV/pages/1257472001 (you will be unable to view that article)

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

Example

 

method: POST

params:

{
"auth_code": “qspehLnbRlUS0uiA2mNwwXTDpZkg/3pOHko=--/Z7U95nqfvPfyQ2l--dA/nDJzKY98PHnQMl85uDQ==",
"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!!!"
}

 

Example with screenshots

First you create the user, then you get the user, then you can assign the user to a project

 

Related content

Users (API)
Users (API)
Read with this
Add organisation-controlled users to your account
Add organisation-controlled users to your account
More like this
Get Users (API
Get Users (API
Read with this
Add new users to your organisation
Add new users to your organisation
More like this
Get Started - how to use the Makerble API: Summary
Get Started - how to use the Makerble API: Summary
Read with this
Add users to a project
Add users to a project
More like this