...
Following are the list of API you can use for performing various actions:
APIs for Managing Users
| Operation | Method | API Endpoint | Example Payload | Example and Notes |
|---|
| Create User | POST | /rest/invitation?resourceIdentifier=users | {
"Invitation":{
"companyID":1,
"contactEmail":"",
"invitationType":300,
"mailRecipient":"new@adeptia.com",
"message":"Adeptia has invited you to use Adeptia Connect",
"roleInfo":"[{\"partner\":1,\"roles\":[2],\"defaultRole\":2}]",
"senderEmail":"adminuser@adeptia.com",
"subject":400
}
} | Example Response: | Code Block |
|---|
| title | Create User |
|---|
| collapse | true |
|---|
| { "invitationId":"11567494226899", "303":[ ] } |
By default this endpoint creates an invitation and returns invitation id in response that can be used while creating the user.
Note:
This may required some modification which will be available in B7. |
| POST | /rest/users/createuser | {
"IndigoUser":{
"firstName":"Test",
"lastName":"User",
"invitationId":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
} | Example Response: | Code Block |
|---|
| title | Create User |
|---|
| collapse | true |
|---|
| {
"IndigoUser":{
"firstName":"Test",
"lastName":"User",
"email":"new@adeptia.com",
"company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
} |
Note:
Use only the invitation Id from the above Create User response.
|
| Update User | PUT | /rest/users/{userId} | {
"IndigoUser":{
"firstName":"Test",
"lastName":"User",
"email":"new@adeptia.com",
"company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
} | Example Response: | Code Block |
|---|
| title | Update User |
|---|
| collapse | true |
|---|
| {
"IndigoUser":{
"firstName":"Test",
"lastName":"User",
"email":"new@adeptia.com",
"company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
} |
|
| Fetch User | GET | /rest/user/{userId} |
|
|
| Fetch All Users (Connect Portal) | GET | /rest/user |
|
|
| Activate User | PUT | /rest/users/activate/{userId} | {} |
|
| Deactivate User | PUT | /rest/users/deactivate/{userId} | {} |
|
| Delete User | PUT | /rest/users/updateowner?oldUserId={userId}&deleteUser=true | {} | By default this endpoint will delete the user who has no dependency else an exception message to move objects will be generated. |
APIs for Managing Partners
...
