User Management Service
- Create a new user
- Get information about the user
- Update information about the user
- Delete the user
- Get information about the currently logged in user
- Upload a photo of the user
- Download the photo of the user
- Forgot Password or Resend Invitation
- Change Password
User Management Service
Please remember that creating/updating/deleting an user is possible only for the clients who has the permission to do it.
Create a new user
URL: https://api-stage.bimplus.net/v2/users
Example: https://api-stage.bimplus.net/v2/users
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
mandatory |
string |
Email of the user |
|
status |
optional |
will be ignored |
The status of the account (Active / Inactive) |
password |
mandatory |
string |
Password of the user |
firstname | optional | string | First name of the user |
lastname | optional | string | Last name of the user |
company | optional | string | Company of the user |
displayname | optional | string | Display name of the user |
info | optional | string | Information of the user |
gender | optional | string | Gender of the user |
phoneWork | optional | string | Office phone number of the user |
phoneHome | optional | string | Home phone number of the user |
fax | optional | string | Fax number of the user |
mobile | optional | string | Mobile number of the user |
birthDate | optional | string | Birth date of the user |
address | optional | object | Address of the user |
street | optional | string | Street name of the user |
streetNr | optional | string | Street number of the user |
zip | optional | string | Zip code |
city | optional | string | City name of the user |
country | optional | string | Country name of the user |
preferedLanguage | optional | string | Preferred language of the user (will be set in the portal) |
teams | will be ignored | array | Team list of the user |
team | will be ignored | object | Information about an user's team (See the team service) |
projects | will be ignored | array | Project list of the user |
project | will be ignored | object | Information about an user's project (See the project service) |
photo | will be ignored | string | Download link for user's photo |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "email" : "test@bimplus.net", "password" : "test" }
Status: 201 Created
{ "projects": [], "teams": [], "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active", "firstname": "", "lastname": "", "company": "", "displayname": "", "info": "", "gender": "", "phoneWork": "", "phoneHome": "", "fax": "", "mobile": "", "birthDate": "", "address": { "street": "", "streetNr": "", "zip": "", "city": "", "country": "" }, "preferedLanguage": "" }
Get information about the user
URL: https://api-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "projects": [], "teams": [], "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active", "firstname": "", "lastname": "", "company": "", "displayname": "", "info": "", "gender": "", "phoneWork": "", "phoneHome": "", "fax": "", "mobile": "", "birthDate": "", "address": { "street": "", "streetNr": "", "zip": "", "city": "", "country": "" }, "preferedLanguage": "" }
Update information about the user
URL: https://api-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
mandatory |
string |
Email of the user |
|
status |
mandatory |
string |
The status of the account (Active / Inactive) |
password |
mandatory |
string |
Password of the user |
firstname | optional | string | First name of the user |
lastname | optional | string | Last name of the user |
company | optional | string | Company of the user |
displayname | optional | string | Display name of the user |
info | optional | string | Information of the user |
gender | optional | string | Gender of the user |
phoneWork | optional | string | Office phone number of the user |
phoneHome | optional | string | Home phone number of the user |
fax | optional | string | Fax number of the user |
mobile | optional | string | Mobile number of the user |
birthDate | optional | string | Birth date of the user |
address | optional | object | Address of the user |
street | optional | string | Street name of the user |
streetNr | optional | string | Street number of the user |
zip | optional | string | Zip code |
city | optional | string | City name of the user |
country | optional | string | Country name of the user |
preferredLanguage | optional | string | Preferred language of the user (will be set in the portal) |
teams | will be ignored | array | Team list of the user |
team | will be ignored | object | Information about an user's team (See the team service) |
projects | will be ignored | array | Project list of the user |
project | will be ignored | object | Information about an user's project (See the project service) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "email": "updated_test@bimplus.net", "status": "Active", "password": "test" }
Status: 200 OK
Delete the user
URL: https://api-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.bimplus.net/v2/users/08b8195a-a2ad-11e2-9993-002215ea7d6b
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get information about the currently logged in user
URL: https://api-stage.bimplus.net/v2/user
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "projects": [], "teams": [], "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active", "firstname": "", "lastname": "", "company": "", "displayname": "", "info": "", "gender": "", "phoneWork": "", "phoneHome": "", "fax": "", "mobile": "", "birthDate": "", "address": { "street": "", "streetNr": "", "zip": "", "city": "", "country": "" }, "preferedLanguage": "" }
Upload a photo of the user
URL: https://api-stage.bimplus.net/v2/user/photo
Example: https://api-stage.bimplus.net/v2/user/photo
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 200 OK
{ "photo": "/attachments/dfd38a17-4d55-4f1b-a2af-f2304b79e9e8/download", "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed", "email": "jayaraj.purushothaman@gmail.com" }
Download the photo of the user
URL: https://api-stage.bimplus.net/v2/user/photo OR https://api-stage.bimplus.net/v2/user/photo?api-token=token (If the client cannot use the token in the header request)
Example: https://api-stage.bimplus.net/v2/user/photo OR https://api-stage.bimplus.net/v2/user/photo?api-token=9c1874a62c974dcfa75e0132c423a088
The photo could also be downloaded by using the the property of "photo"(which is a url) in the v2/user json response.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "projects": [], "teams": [], "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active", "firstname": "", "lastname": "", "company": "", "displayname": "", "info": "", "gender": "", "phoneWork": "", "phoneHome": "", "fax": "", "mobile": "", "birthDate": "", "address": { "street": "", "streetNr": "", "zip": "", "city": "", "country": "" }, "preferedLanguage": "" }
Forgot Password or Resend Invitation
URL: https://api-stage.bimplus.net/v2/auth-forgot
Example: https://api-stage.bimplus.net/v2/auth-forgot
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
user_id |
mandatory |
string(guid) |
Recipient user_id (i.e the user who has triggered the forgot password action or the user who will be re-invited to join the team) |
creator_user_id |
optional |
string(guid) |
This will be used only for the re-send invitation case to identify the user who has sent the invitation. |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "user_id": "user@bimplus.net", "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4" }
Status: 201 Created
{ "user_id": "user@bimplus.net", "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4" }
Change Password
URL: https://api-stage.bimplus.net/v2/change_password
Example: https://api-stage.bimplus.net/v2/change_password
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
old |
mandatory |
string |
Old password |
new |
mandatory |
string |
New password |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "old": "old_pwd", "new": "new_pwd" }
Status: 200 OK
{ "user_id": "user@bimplus.net", "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4" }