...
Following are the list of API you can use for performing various actions:
Guidelines
Operation | Method | API Endpoint | Example Payload | Example Response |
---|
Fetch Token | POST | /rest/login/user | { "username":"{name of the user}", "password":"{password}" } |
Code Block |
---|
title | Fetch Token |
---|
collapse | true |
---|
| {
"tokenExpiresDays": 30,
"ACCESS_TOKEN": "fCMjaeyJhbGciOiJIUzI1NiIsImVuYyI6IlNIQS0yNTYifQ.OWpXVzNvblBMOG5Db1hsbmVHbktpRkUzUnZhSVdtTG91c0F2TE1PYytqWWR4L0daRDRmd1lGeHBsT3BEMlR4bEpsQnErSmU5WjA0SQ0KMklzNGlIOHBxeDkrWXJyZXI3aVVtN2Q3QStpd3AyWGhUVzZCVWoraWROcCtlY2VDRGVUS0pHaVVyR2ZvZ2Y4NFlrVnBWVWVjSW1rNw0KTzJ2bXMrcXFxaVFoZmpsNkFjWEladm1aZ3cybEJMcW5JUDZkQzVlWW5xbVp3dU1UMm9sNEpoNEg0eVc3RFgrbUxYWFR1VUJNdkRNLw0KL3dHeUIrMVM1YnMycGRQdnJCRlhFbitTRGZyTUJQdlJZTFlFeXFDaUdBcFBaQXZPODFJb1ZDWDVpWllBUnRzd1RXa0E1NkF1a2lJRw0KVnB4NVNUUDR6TzJKbFR2cEx2c3dZbGl3MWp2OUIza3RFd1NJdGdYRk5EZ0Q1R2lodXRITEhmalkrK05od3ZJYzhMODV2SEdvTzBQag0KMC9zRFJKaWxIT1dwQWxzMjBhTk8yQmN3cEE0eUIvT2tSWUFGbGlQK2R5VW40RUxxUGxxSjVNY1A5eHNMRzErN3E0N3FtQ21sUTB6VA0KQUVDNitqRWhYaDhEVXFLSTNrUnY5R1N4ZW1BNjdlMERaRGo4UlpERUpPS1BkYURKR29CaHNGaHVaSjRwZXJXNHM5dWJoNGtMdk9jTw0KUnRwa2ZodlNWOVExeFZ1U1gwZlQxeDJIR0lyaDZ1eUs1bHZ2QmRuY0NQNy84djl6OVpqa0ppTG5KZFMvR2FJbzIvR3lUeEc4d3J0Yw0KTjhheHpWQ3ZRYVVkdkdQTGZHUFVSSkNDcU1yQWRlYWE5aWlUb0E0SEZPRTVhZU93SFBvQjNPWXRzZFBoenYwRUxlb1pVY2RBZlhjZA0KbTZEL0pVUEhHS0U0Nm1RSU8zMlkwY0J0TUlWdWFjY2hzbFNnWitjMldwUXdLa0ZjTlJBclZ5UUJiQlJxZk9WeTVydFJHQndzU2lQNg0KSVNOZXJaREhmNll6YjJuQ09DTE9TcTNLWklLZVJlOFRTMDc2V001WVU1cTMvMzcyaE5wRzNSN2N4SzgwMDd5RlNYQUFEL3dEWDZDdg0KVEk5eHZ3V0ZkSUo5bnJPNVZ4TWt0T0NweE5GLzdneUdaNWxnWmhZRVYyVmlKZTNlQjN0ajVWS1VQWlhIZHo3ZFA2OVRRd3lpWmhGQQ0KWU9tcFRqYWY1TXE4ckRSVmY1OFlnY2hXMTFLdU9sMlJiTndoL09odUcvb2h0L2JZWGFGM1hmbHBkWTloRmc1dGZkdlhRdHVOcmJYag0KRmNRak42TW9SaDZzR1o0ejVrWXpSdDFPRVVVL1JEU01BbjRwcE5reHZsS2g5YTMweG9TYzhuNkRzVE5KK3U4cmQ4M1dabms5WDEzbQ0KOUdnPQ.2j55KLyRPYo9SHmzixRRCV4w3pPH9BFym-csJwXjqkk"
} |
|
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. |
...