User Management Service
...
User Management Service
...
| Anchor |
|---|
| createInvitation |
|---|
| createInvitation |
|---|
|
This API handles invitation of new user to Bimplus.
There will be two modes of invitations:
- To a team
- To a team and one or multiple projects
Both will be handled with the same API.
Any team member can invite user to a team, but to invite to a project, he has to have project admin rights.
The invitation will not create new user in Bimplus. The user will be created only after he accepts the invitation.
Create and Send invitation to new user
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: <teamslug>/invitations URL: https://api-stage.bimplus.net/v2/<team_slug>/invitations Example: https://api-stage.bimplus.net/v2/bimplus/invitations JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
email | mandatory | string | Email of the new user | | invitationText | mandatory | string | Message text for an invited user | | projects | optional | object | List of objects which contains pairs of project id with role id the new user is invited to.
Property in the request is optional. If not present, it means that the invitation is just to the team. | status | optional | will be ignored | The status of the account (Active / Disabled) | sender | optional | string | The sender must have a valid Bimplus account and must be member of the team | | team | optional | string | Team for which the invitation is valid | | teamRole | optional | string | Team role is optional. If missing default is team member role | | status | optional | string | Invitation status | | validTo | optional | date | Date the invitation is valid to | | created | optional | date | Creation date of the invitation | | changed | optional | date | Recent modification date of the invitation | | counter | optional | string | Home phone number of the user |
|
| Card |
|---|
| | Creates and sends a new invitation to the new user. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"email":"newuser@allplan.com",
"invitationText":"Some text",
"projects":[{
"projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
"roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
}
]
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"id":"55896fad-187e-47da-bdb6-b441607e3de3",
"email":"newuser@allplan.com",
"sender":{
"id":"b664c6d9-d8ab-4257-88b0-d38588d979dc",
"email":"testadmin@allplan.com",
"firstname":"Test",
"lastname":"Admin"
},
"team":{
"id":"d7a504fe-b2ef-4847-bf79-d3733d93e478",
"slug":"testteam",
"name":"Test Team"
},
"invitationText":"Some text",
"created":"2016-12-01T07:51:20.843",
"changed":"2016-12-01T07:51:20.843",
"validTo":"2016-12-08T07:51:20.843",
"projects":[{
"projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
"roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
}
]
}
|
|
|
| Anchor |
|---|
| getInvitation |
|---|
| getInvitation |
|---|
|
Get information about the invitation
| Deck of Cards |
|---|
|
| Card |
|---|
| | Get information about a specified invitation. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"id":"55896fad-187e-47da-bdb6-b441607e3de3",
"email":"newuser@allplan.com",
"sender":{
"id":"b664c6d9-d8ab-4257-88b0-d38588d979dc",
"email":"testadmin@allplan.com",
"firstname":"Test",
"lastname":"Admin"
},
"team":{
"id":"d7a504fe-b2ef-4847-bf79-d3733d93e478",
"slug":"testteam",
"name":"Test Team"
},
"invitationText":"Some text",
"created":"2016-12-01T07:51:20.843",
"changed":"2016-12-01T07:51:20.843",
"validTo":"2016-12-08T07:51:20.843",
"projects":[{
"projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
"roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
}
]
} |
|
|
| Anchor |
|---|
| updateInvitation |
|---|
| updateInvitation |
|---|
|
Update and Resend invitation to the new user
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: <teamslug>/invitations/<invitation_id> URL: https://api-stage.bimplus.net/v2/ <teamslug>/invitations/<invitation_id> Example: https://api-stage.bimplus.net/v2/bimplus/invitations/55896fad-187e-47da-bdb6-b441607e3de3 JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
email | mandatory | string | Email of the new user | | invitationText | mandatory | string | Message text for an invited user | | projects | optional | object | List of objects which contains pairs of project id with role id the new user is invited to.
Property in the request is optional. If not present, it means that the invitation is just to the team. | status | optional | will be ignored | The status of the account (Active / Disabled) | sender | optional | string | The sender must have a valid Bimplus account and must be member of the team | | team | optional | string | Team for which the invitation is valid | | teamRole | optional | string | Team role is optional. If missing default is team member role | | status | optional | string | Invitation status | | validTo | optional | date | Date the invitation is valid to | | created | optional | date | Creation date of the invitation | | changed | optional | date | Recent modification date of the invitation | | counter | optional | string | Home phone number of the user |
|
| Card |
|---|
| Update invitation information to the new user. Only the Sender is able to Update and Resend the invitation to the new user.
The invitation might change the invitation text and projects. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"invitationText":"Some text",
"projects":[{
"projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
"roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
}
]
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| {
"id":"55896fad-187e-47da-bdb6-b441607e3de3",
"email":"newuser@allplan.com",
"sender":{
"id":"b664c6d9-d8ab-4257-88b0-d38588d979dc",
"email":"testadmin@allplan.com",
"firstname":"Test",
"lastname":"Admin"
},
"team":{
"id":"d7a504fe-b2ef-4847-bf79-d3733d93e478",
"slug":"testteam",
"name":"Test Team"
},
"invitationText":"Some text",
"created":"2016-12-01T07:51:20.843",
"changed":"2016-12-01T07:51:20.843",
"validTo":"2016-12-08T07:51:20.843",
"projects":[{
"projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
"roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
}
]
} |
|
|
| Anchor |
|---|
| deleteInvitation |
|---|
| deleteInvitation |
|---|
|
Cancel invitation
| Deck of Cards |
|---|
|
| Card |
|---|
| | Delete a specified invitation for new user. Please remember that only the Sender is able to delete the invitation |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| getCurrentUserInfo |
|---|
| getCurrentUserInfo |
|---|
|