Virima API Specification - UserService Services

The requests documented in this section are directed to UserService resources, which represent User login, logout,createAccount and gets loggedin user -- as called by a partner or directly by a webapp using the API..

Contents

1 editUser POST Interface
2 setEmailPreference POST Interface
3 getEmailPreferenceEntity GET Interface
4 getAllUser GET Interface
5 getAllVendor GET Interface
6 getAllUserDetails POST Interface
7 getAllEntity GET Interface
8 addLDAPConfiguration POST Interface
9 authenticateLDAPConfiguration POST Interface
10 saveLDAPPropertyMapping POST Interface
11 getLDAPUserProperties GET Interface
12 getLDAPConfiguration GET Interface
13 syncWithLDAP GET Interface
14 testLDAPConnection GET Interface
15 testAzureADConnection GET Interface
16 addADConfiguration POST Interface
17 addADConfigurationForPrivateCon POST Interface
18 authenticateADConfigurationForPrivateCon POST Interface
19 saveADPropertyMapping POST Interface
20 getADUserProperties GET Interface
21 getADUserPropertiesForPrivateCon GET Interface
22 syncWithADforPublicCon GET Interface
23 syncWithADforPrivateCon GET Interface
24 isInitialImportDone GET Interface
25 isInitialImportDoneLDAP GET Interface
26 testADConnection GET Interface
27 testADConnectionForPrivateCon GET Interface
28 getUserRoles GET Interface
29 savePassword POST Interface
30 setThemeForUser GET Interface
31 getCartItemCount GET Interface
32 getCustomerId GET Interface
33 getAzureADUserProperties GET Interface
34 saveAzureADConfig POST Interface
35 saveAzureADPropertyMapping POST Interface
36 importAzureADUsers GET Interface
37 getAzureAdImportScheduleDetails GET Interface
38 editAzureAdImportScheduleDetails POST Interface
39 getAllGroup GET Interface
40 getAllGroupsIncludingInactiveUser GET Interface
41 getAllDepartment GET Interface
42 generateAPIKeyForUser GET Interface
43 getAdImportScheduleDetails GET Interface
44 editAdImportScheduleDetails POST Interface
45 getDefaultLandingPage GET Interface
46 getAllPropertiesForWorkflow GET Interface
47 updateBulkEdit POST Interface

editUser POST Interface

Method: POST

Relative URL: userservice/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
userinfo	UserInfo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITUSER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "createdOn":?,
   "lastModifiedOn":?,
   "email":"?",
   "ldap":?,
   "ldapConfig": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "ad":?,
   "adConfig": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "azureAdAuthentication":?,
   "azureAdConfig": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "isVIP":?,
   "clientUser":?,
   "online":?,
   "password":"?",
   "userName":"?",
   "firstName":"?",
   "lastName":"?",
   "displayName":"?",
   "address":"?",
   "allowAccess":?,
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "location": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "phone":"?",
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "reportTo": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "designation": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "landingPage": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "language":"?",
   "isVendor":?,
   "samlAuthentication":?,
   "samlConfig": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "normalAuthentication":?,
   "driveId":"?",
   "superAdmin":?,
   "customerList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "enableMFA":?,
   "twoFactorSecretKey":"?",
   "mfaType":"?",
   "isImport":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

setEmailPreference POST Interface

Method: POST

Relative URL: userservice/set-email-preferenece

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
preferncelist	ArrayOfPreference

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SETEMAILPREFERENCE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "preference":[
      {
         "entity":"?",
         "isNotify":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getEmailPreferenceEntity GET Interface

Method: GET

Relative URL: userservice/get-email-preferenece-entities/user-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllUser GET Interface

getAllUser Service (GET) is called when a partner, or the application is trying to get all user associated with loggedin customer id.

Kills an active session

Method: GET

Relative URL: userservice/getalluser

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
userList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllVendor GET Interface

getAllVendor Service (GET) is called when a partner, or the application is trying to get all user associated with loggedin customer id.

Kills an active session

Method: GET

Relative URL: userservice/getallvendor

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
vendorList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":1213676690,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2037024163,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":1768537717,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllUserDetails POST Interface

Method: POST

Relative URL: userservice/get-all-user-details/page-number/number

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterInput	FilterInput

Response Structure:

Field Name	Type	Description
arrayOfUserDetails	ArrayOfUserDetails

Example Request:

GETALLUSERDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1208914583,
   "module":"?",
   "className":"?",
   "dbClassName":"?",
   "isDashboard":?,
   "snKey":"?",
   "snValue":"?",
   "mainTabSubListSubTab":"?",
   "importType":"?",
   "sort": {
         "id":10882313,
         "sortKey":"?",
         "sortOrder":"?",
         "propertyName":"?",
         "mapProperty":?
      },
   "filters":[
      {
         "id":2147483647,
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "totalResults":?,
   "filterRuleList":[
      {
         "id":2147483647,
         "filterKey":"?",
         "filterValue":"?",
         "operatorDisplayName":"?"
      }   ],
   "responseList":[
      {
         "id":2147483647,
         "createdOn":?,
         "lastModifiedOn":?,
         "email":"?",
         "ldap":?,
         "ldapConfig": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "ad":?,
         "adConfig": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "azureAdAuthentication":?,
         "azureAdConfig": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isVIP":?,
         "clientUser":?,
         "online":?,
         "password":"?",
         "userName":"?",
         "firstName":"?",
         "lastName":"?",
         "displayName":"?",
         "address":"?",
         "allowAccess":?,
         "role":[
            {
               "id":1556628580,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "department":[
            {
               "id":1115542260,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "group":[
            {
               "id":792196396,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "location": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "phone":"?",
         "archive":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "uniqueId":"?",
         "reportTo": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "designation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "landingPage": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "language":"?",
         "isVendor":?,
         "samlAuthentication":?,
         "samlConfig": {
               "id":1589508994,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "normalAuthentication":?,
         "driveId":"?",
         "superAdmin":?,
         "customerList":[
            {
               "id":2062325736,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "enableMFA":?,
         "twoFactorSecretKey":"?",
         "mfaType":"?",
         "isImport":?
      }   ]
}

getAllEntity GET Interface

Method: GET

Relative URL: userservice/get-all-entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
entityList	ArrayOfEntity

Example Request:

Example Response:

{
   "id":1118559927,
   "responseList":[
      {
         "id":250673362,
         "entityName":"?",
         "displayName":"?",
         "moduleName":"?"
      }   ]
}

addLDAPConfiguration POST Interface

Method: POST

Relative URL: userservice/add-ldap-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDLDAPCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

authenticateLDAPConfiguration POST Interface

Method: POST

Relative URL: userservice/authenticate-ldap-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

AUTHENTICATELDAPCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveLDAPPropertyMapping POST Interface

Method: POST

Relative URL: userservice/save-ldap-property-mapping

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVELDAPPROPERTYMAPPING 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":495090125,
   "response":"?"
}

getLDAPUserProperties GET Interface

Method: GET

Relative URL: userservice/get-ldap-user-properties/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getLDAPConfiguration GET Interface

Method: GET

Relative URL: userservice/get-ldap-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	LDAPPojo

Example Request:

Example Response:

{
   "id":2147483647,
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "id":2147483647,
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

syncWithLDAP GET Interface

Method: GET

Relative URL: userservice/sync-with-ldap/id/type-of-import/ldap-import-is-acticve

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

testLDAPConnection GET Interface

Method: GET

Relative URL: userservice/test-ldap-connection/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1488891846,
   "response":"?"
}

testAzureADConnection GET Interface

Method: GET

Relative URL: userservice/test-azure-ad-connection/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addADConfiguration POST Interface

Method: POST

Relative URL: userservice/add-ad-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDADCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addADConfigurationForPrivateCon POST Interface

Method: POST

Relative URL: userservice/add-ad-configuration-for-private-con

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDADCONFIGURATIONFORPRIVATECON 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":1510985638,
   "response":"?"
}

authenticateADConfigurationForPrivateCon POST Interface

Method: POST

Relative URL: userservice/authenticate-ad-configuration-for-private-con

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

AUTHENTICATEADCONFIGURATIONFORPRIVATECON 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveADPropertyMapping POST Interface

Method: POST

Relative URL: userservice/save-ad-property-mapping

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	LDAPPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEADPROPERTYMAPPING 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "host":"?",
   "domain":"?",
   "authenticationMethod":"?",
   "baseDN":"?",
   "bindDN":"?",
   "bindPassword":"?",
   "searchAttribute":"?",
   "clientId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "map":[
      {
         "name":"?",
         "mapName":"?",
         "map":?
      }   ],
   "isInitialImportDone":?,
   "importTriggeredAt":?,
   "importCompletedAt":?
}

Example Response:

{
   "id":789179736,
   "response":"?"
}

getADUserProperties GET Interface

Method: GET

Relative URL: userservice/get-ad-user-properties/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":189231924,
   "response":"?"
}

getADUserPropertiesForPrivateCon GET Interface

Method: GET

Relative URL: userservice/get-ad-user-properties-for-private-con/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1185954743,
   "response":"?"
}

syncWithADforPublicCon GET Interface

Method: GET

Relative URL: userservice/sync-with-ad-for-public-con/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":194824043,
   "response":"?"
}

syncWithADforPrivateCon GET Interface

Method: GET

Relative URL: userservice/sync-with-ad-for-private-con/id/type-of-import/ad-import-is-acticve/reflect-account-status/mail-permission

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":545252184,
   "response":"?"
}

isInitialImportDone GET Interface

Method: GET

Relative URL: userservice/is-initial-import-done/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

isInitialImportDoneLDAP GET Interface

Method: GET

Relative URL: userservice/is-initial-import-done-ldap/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

testADConnection GET Interface

Method: GET

Relative URL: userservice/test-ad-connection/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

testADConnectionForPrivateCon GET Interface

Method: GET

Relative URL: userservice/test-ad-connection-for-private-con/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getUserRoles GET Interface

Method: GET

Relative URL: userservice/get-all-user-roles/user-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

savePassword POST Interface

Method: POST

Relative URL: userservice/save-password

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
password	Password

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEPASSWORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "oldPassword":"?",
   "newPassword":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

setThemeForUser GET Interface

Method: GET

Relative URL: userservice/set-theme-for-user/theme

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCartItemCount GET Interface

Service to get the count of items in the cart

Method: GET

Relative URL: userservice/get-cart-item-count

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCustomerId GET Interface

Service to get customerId

Method: GET

Relative URL: userservice/get-customer-id/email-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1005688362,
   "response":"?"
}

getAzureADUserProperties GET Interface

Service to get customerId

Method: GET

Relative URL: userservice/get-azure-ad-user-properties/is-azure-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveAzureADConfig POST Interface

Method: POST

Relative URL: userservice/save-azure-ad

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
userinfo	AzureAdConfiguration

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEAZUREADCONFIG 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "clientId":"?",
   "secretKey":"?",
   "tenantId":"?",
   "propertyMap":"?",
   "archive":?,
   "uniqueId":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "authType":"?",
   "certificate":"?",
   "privateKey":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveAzureADPropertyMapping POST Interface

Method: POST

Relative URL: userservice/save-azure-ad-property-mapping

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyMapping	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEAZUREADPROPERTYMAPPING 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

importAzureADUsers GET Interface

Method: GET

Relative URL: userservice/import-azure-ad-users/config-id/notify-user/is-schedule/activate-user/reflect-account-status

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAzureAdImportScheduleDetails GET Interface

Method: GET

Relative URL: userservice/get-azure-ad-import-schedule/azure-ad-config

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
azureAdImportSchedule	AzureAdImportSchedule

Example Request:

Example Response:

{
   "id":2147483647,
   "azureAdConfig":?,
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "cronExpression":"?",
   "timeZone":"?",
   "isEnabled":?,
   "reflectAccountStatus":?,
   "isEnabledSendNotification":?,
   "isAccess":?
}

editAzureAdImportScheduleDetails POST Interface

Method: POST

Relative URL: userservice/edit-azure-ad-import-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
azureAdImportSchedule	AzureAdImportSchedule

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITAZUREADIMPORTSCHEDULEDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "azureAdConfig":?,
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "cronExpression":"?",
   "timeZone":"?",
   "isEnabled":?,
   "reflectAccountStatus":?,
   "isEnabledSendNotification":?,
   "isAccess":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllGroup GET Interface

Method: GET

Relative URL: userservice/getallgroup

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
groupList	ValueList

Example Request:

Example Response:

{
   "id":122598632,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":981846873,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllGroupsIncludingInactiveUser GET Interface

Method: GET

Relative URL: userservice/getallgroup-includinginactiveuser

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
groupList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":1183789295,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":1036161532,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllDepartment GET Interface

Method: GET

Relative URL: userservice/getalldepartment

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
departmentList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":734759161,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2000198041,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

generateAPIKeyForUser GET Interface

Method: GET

Relative URL: userservice/generate-api-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
apiKeyObject	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAdImportScheduleDetails GET Interface

Method: GET

Relative URL: userservice/get-ad-import-schedule/ad-config

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
adImportSchedule	ADImportSchedule

Example Request:

Example Response:

{
   "id":2147483647,
   "adConfig":?,
   "typeOfImport":"?",
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "timeZone":"?",
   "cronExpression":"?",
   "isEnabled":?,
   "reflectAccountStatus":?,
   "isEnabledSendNotification":?,
   "isAccess":?
}

editAdImportScheduleDetails POST Interface

Method: POST

Relative URL: userservice/edit-ad-import-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
adImportSchedule	ADImportSchedule

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITADIMPORTSCHEDULEDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "adConfig":?,
   "typeOfImport":"?",
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "timeZone":"?",
   "cronExpression":"?",
   "isEnabled":?,
   "reflectAccountStatus":?,
   "isEnabledSendNotification":?,
   "isAccess":?
}

Example Response:

{
   "id":1078565058,
   "response":"?"
}

getDefaultLandingPage GET Interface

Method: GET

Relative URL: userservice/get-default-landing-page

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
defaultLandingPage	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllPropertiesForWorkflow GET Interface

Method: GET

Relative URL: userservice/getallpropertiesforworkflow/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	ValueList

Example Request:

Example Response:

{
   "id":191644181,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":186467190,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":577389661,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

updateBulkEdit POST Interface

Method: POST

Relative URL: userservice/update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
record	MultiMapForCIChangeAttributes

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATEBULKEDIT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "checkExists":?,
   "workFlowId":?,
   "map":[
      {
         "key":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "idList":[
      {
         "flag":?
      }   ]
}

Example Response:

{
   "id":220122013,
   "response":"?"
}