Access User API
Update
POST /api/v1/accessuser/update
This API updates an Access User.
Request Body
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"authId": 0,
"active": true
}| Property | Mandatory | Description |
|---|---|---|
|
id |
yes |
Access user id |
|
firstname |
no |
first name of the access user |
|
lastname |
no |
last name |
|
email |
no |
email id |
|
authId |
yes |
Login profile id |
|
active |
no |
(true/false) enable or disable the user |
Response Success
Code – 200
{
"timestamp": "2024-08-14T14:05:47.625Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Update User Password
POST /api/v1/accessuser/updateUserPassword
This API updates the password of the Access User.
Request Body
{
"username": "string",
"userPassword": "string",
"confirmPassword": "string",
"authId": 0,
"currentPassword": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
username |
yes |
user name |
|
userPassword |
yes |
New password |
|
confirmPassword |
yes |
New password |
|
authId |
no |
Login profile id |
|
currentPassword |
no |
current password |
Response Success
Code – 200
{
"timestamp": "2024-08-14T14:48:24.830Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Add a New Access User
POST /api/v1/accessuser/add
This API adds a new Access User.
Request Body
{
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"authId": 0,
"active": true
}| Property | Mandatory | Description |
|---|---|---|
|
username |
yes |
user name |
|
firstname |
no |
first name |
|
lastname |
no |
last name |
|
email |
no |
email id |
|
authId |
no |
Login profile id |
|
active |
yes |
(true/false) enable or disable the user. |
Response Success
Code – 200
{
"timestamp": "2024-08-14T14:48:24.835Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Delete
DELETE /api/v1/accessuser/delete
This API is for deleting an access user.
Request Body
{
"id": 0
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
id of the access user. |
Response Success
Code – 200
{
"timestamp": "2024-08-19T17:10:30.186Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Delete by Username
DELETE /api/v1/accessuser/deleteByUsername
This API is for deleting an access user identified by Username.
Request Body
{
"username": "string",
"loginProfileId": 0
}| Property | Mandatory | Description |
|---|---|---|
|
username |
yes |
user name |
|
loginProfileId |
yes |
login profile Id |
Response Success
Code – 200
{
"timestamp": "2024-08-19T17:27:58.528Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Search
GET /api/v1/accessuser/search
This API search the AccessUser data.
Request Parameter
| Parameter | Mandatory | Description | |
|---|---|---|---|
|
searchWord |
no |
keyword to search |
|
|
authId |
no |
Login profile id |
|
|
startIndex |
no |
start index of the result set |
|
|
pageSize |
no |
No of records per page |
- |
|
fromDate |
no |
createDateTime |
|
|
toDate
|
no |
updateDateTime |
|
|
sortField |
no |
The field name to consider while sorting the search result |
|
|
sortOrder
|
no |
(ace/dsc) ascending or descending order of the search result |
Response Success
Code – 200
{
"list": [
{
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"authId": 0,
"createdOwner": "string",
"updatedOwner": "string",
"createDateTime": "2024-09-12T06:22:39.255Z",
"updateDateTime": "2024-09-12T06:22:39.255Z",
"loginProfileName": "string",
"authTypeId": 0,
"authTypeStr": "string",
"active": true
}
],
"startIndex": 0,
"pageSize": 0,
"resultCount": 0,
"totalCount": 0,
"containerType": "string",
"searchType": "string",
"startupMessage": "string",
"maxFileSize": 0,
"canDelete": true,
"canUpload": true,
"canDownload": true,
"canDownloadFolder": true,
"canRename": true,
"canCreateFolder": true,
"copyProtect": true
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.