Login Profile API
This API performs actions such as updating login profile, updating viewid, getting Login profile, duplicating Login profile, adding Login Profile, searching for a Login profile and deleting a Login Profile.
Update
POST /api/v1/loginprofile/update
This API is essential for updating the login profile.
Request Body
{
"id": 0,
"title": "string",
"description": "string",
"ipRange": "string",
"typeId": 0,
"userCount": 0,
"viewId": "string",
"username": "string",
"password": "string",
"lang": "string",
"startupMessage": "string",
"configuration": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
Login profile Id |
|
title |
no |
title |
|
description |
no |
– |
|
ipRange |
no |
ipRange |
|
typeId |
no |
id type |
|
userCount |
no |
– |
|
viewId |
no |
– |
|
username |
no |
user name |
|
password |
no |
password |
|
lang |
no |
language |
|
startupmessage |
no |
– |
|
configuration |
no |
– |
Response Success
Code – 200
{
"timestamp": "2024-08-19T17:43:22.258Z",
"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 ViewId API
POST /api/v1/loginprofile/updateViewId
This API updates the Login Profile ViewId.
Request Body
{
"id": 0,
"viewId": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
– |
|
viewId |
no |
– |
Response Success
Code – 200
{
"timestamp": "2024-08-19T18:00:13.428Z",
"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.
Get
POST /api/v1/loginprofile/get
This API fetches detail of the Login Profile based on the id.
Request Body
{
"id": 0
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
id of the Login Profile |
Response Success
Code – 200
{
"id": 0,
"title": "string",
"tid": 0,
"description": "string",
"ipRange": "string",
"typeId": 0,
"typeString": "string",
"shareCount": 0,
"userCount": 0,
"viewId": "string",
"viewUrl": "string",
"username": "string",
"password": "string",
"lang": "string",
"startupMessage": "string",
"configuration": "string",
"createdOwner": "string",
"updatedOwner": "string",
"createDateTime": "2024-08-19T18:07:17.048Z",
"updateDateTime": "2024-08-19T18:07:17.048Z"
}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.
Duplicate
POST /api/v1/loginprofile/duplicate
This API creates a duplicate Login Profile.
Request Body
{
"id": 0,
"title": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
– |
|
title |
no |
title of duplicate login profile |
Response Success
Code – 200
{
"timestamp": "2024-08-19T18:15:03.837Z",
"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 the following link.
Add
POST /api/v1/loginprofile/add
This API is necessary to add a Login Profile.
Request Body
{
"title": "string",
"description": "string",
"ipRange": "string",
"typeId": 0,
"userCount": 0,
"username": "string",
"password": "string",
"lang": "string",
"startupMessage": "string",
"configuration": "string"
}
| Property | Mandatory | Description |
|---|---|---|
|
title |
no |
title of the login profile |
|
description |
no |
– |
|
ipRange |
no |
ipRange |
|
typeId |
no |
id type |
|
userCount |
no |
– |
|
username |
no |
user name |
|
username |
no |
user name |
|
password |
no |
password |
|
lang |
no |
language |
|
startupmessage |
no |
– |
|
configuration |
no |
– |
Response Success
Code – 200
{
"timestamp": "2024-08-19T18:21:35.216Z",
"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/loginprofile/delete
This API is useful in deleting a Login Profile.
Request Body
{
"id": 0
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
– |
Response Success
Code – 200
{
"timestamp": "2024-08-19T18:34:37.601Z",
"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/loginprofile/search
This API searches the Login Profile data.
Request Parameter
| Parameter | Mandatory | Description | |
|---|---|---|---|
|
searchWord |
no |
keyword to search |
|
|
typeId |
no |
Authentication Type 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 |
|
|
details |
no |
(true/false) select permission |
Response Success
Code – 200
{
"list": [
{
"id": 0,
"title": "string",
"tid": 0,
"description": "string",
"ipRange": "string",
"typeId": 0,
"typeString": "string",
"shareCount": 0,
"userCount": 0,
"viewId": "string",
"viewUrl": "string",
"username": "string",
"password": "string",
"lang": "string",
"startupMessage": "string",
"configuration": "string",
"createdOwner": "string",
"updatedOwner": "string",
"createDateTime": "2024-09-12T06:20:32.593Z",
"updateDateTime": "2024-09-12T06:20:32.593Z"
}
],
"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.