Versions Compared

Old Version 28

changes.mady.by.user Akash Kumar Jaiswal

Saved on

compared with

New Version 29

changes.mady.by.user Akash Kumar Jaiswal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Key

Header Information (value)

Content Typeapplication/json
ACCESS_TOKENTo fetch get the Access Token, refer below table for more details.

...

OperationMethodAPI EndpointExample PayloadExample Response
Fetch Get Access TokenPOST

/rest/login/user

{

"username":"{User Name}",

"password":"{Password}"

}


Code Block
titleFetch Token
collapsetrue
{
"tokenExpiresDays": 30,
"ACCESS_TOKEN": "{access token}"
}


...

OperationMethodAPI EndpointExample PayloadExample and Notes
Create UserPOST/rest/invitation?resourceIdentifier=users

{
"Invitation":{
"companyID":1,
"contactEmail":"",
"invitationType":300,
"mailRecipient":"new@adeptiajames.paul@abc.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
titleCreate User
collapsetrue
{ "invitationId":"11567494226899", "303":[ ] }

By default this This endpoint creates an invitation and returns return invitation id in response that can be used which you will use while creating the user.


POST/rest/users/createuser

{
"IndigoUser":{
"firstName":"TestJames",
"lastName":"UserPaul",
"invitationId":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
}

Example Response:

Code Block
titleCreate User
collapsetrue
{
 "IndigoUser":{
 "firstName":"TestJames",
 "lastName":"UserPaul",
 "email":"new@adeptiajames.paul@abc.com",
 "company":"Adeptia",
 "id":"11567413236623",
 "userPartnerRole":[
 {
 "partner":{
 "id":1
 },
 "role":{
 "id":2
 },
 "user":{
 "id":"11567413236623"
 },
 "defaultRole":true
 }
 ]
 }
}


Note:

Use the invitation Id from the above Create User response.

Update UserPUT/rest/users/{userId}

{
"IndigoUser":{
"firstName":"TestJames",
"lastName":"UserPaul",
"email":"new@adeptiajames.paul@abc.com",

"company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
}

Example Response:

Code Block
titleUpdate User
collapsetrue
{
 "IndigoUser":{
 "firstName":"Test",
 "lastName":"User",
 "email":"new@adeptiajames.paul@abc.com",
 "company":"Adeptia",
 "id":"11567413236623",
 "userPartnerRole":[
 {
 "partner":{
 "id":1
 },
 "role":{
 "id":2
 },
 "user":{
 "id":"11567413236623"
 },
 "defaultRole":true
 }
 ]
 }
}


Fetch Get UserGET/rest/user/{userId}

Fetch Get All Users (Connect Portal)GET/rest/user?limit={maximum number of users}

Using this API, you will get only Connect Portal users.

By default the value of limit is 1. Moreover, the limit stands for maximum number of users can be fetched from the database.
Activate UserPUT/rest/users/activate/{userId}{}EMPTY
Deactivate UserPUT/rest/users/deactivate/{userId}{}EMPTY
Delete UserPUT/rest/users/updateowner?oldUserId={userId}&deleteUser=true{}EMPTYBy default this endpoint will delete the user who has no dependency else an exception message to move objects will be generated.

...