Portal Functions
5 min
Get All Functions
GET
http://{{hostname}}/aioc-rest-web/rest/realms/getFunctions
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/getFunctions");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request GET 'http://{{hostname }}/aioc-rest-web/rest/realms/getFunctions'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/getFunctions",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
[
{
"dbId": 425,
"name": "sc.secret.data.vault.admin",
"groups": [
426
]
},
.
.
continue
]Get All Realms
GET
http://{{hostname}}/aioc-rest-web/rest/realms/getRealms
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/getRealms");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request GET 'http://{{hostname }}/aioc-rest-web/rest/realms/getRealms'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/getRealms",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
[
{
"dbId": 3524753,
"id": "9263fb6a-3d31-4166-9e15-4a31bffc9d79",
"name": "PGR_Enduser",
"description": null,
"functionGroups": [
{
"dbId": 200,
"name": "Device Management End User",
"description": "Genarated by system",
"functions": [
{
"dbId": 80,
"name": "single.connect.rdp.client.moduleVisibility",
"groups": [
200,
1708148
]
},
{
"dbId": 149,
"name": "netright.discovery.moduleVisibility",
"groups": [
200,
1708148
]
},
{
"dbId": 155,
"name": "aioc.discovery.discover.device",
"groups": [
200,
1708148
]
},
{
"dbId": 84,
"name": "single.connect.cli.moduleVisibility",
"groups": [
200
]
}
],
"realms": [
1624460,
3524753,
1677542
]
}
]
}
]Save Realm
POST
http://{{hostname}}/aioc-rest-web/rest/realms/saveRealm
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"Test realm\",\n \"description\": null,\n \"functionGroups\": [\n {\n \"dbId\": 263875\n }\n ],\n \"userGroups\": [\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_USERS\"\n }\n ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Test realm",
"description": null,
"functionGroups": [
{
"dbId": 263875
}
],
"userGroups": [
{
"id": "DEFAULT_GROUP_SYSYEM_USERS"
}
]
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"name":"Test realm","description":null,"functionGroups":[{"dbId":263875}],"userGroups":[{"id":"DEFAULT_GROUP_SYSYEM_USERS"}]}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
{
"dbId": 4164485,
"id": "9253c3b7-29df-4627-b266-ad030e3ae170",
"name": "Test realm",
"description": null,
"functionGroups": [
{
"dbId": 263875,
"name": "TFA Hardware Token Management",
"description": "Genarated by system",
"functions": [
{
"dbId": 263874,
"name": "single.connect.twofactor. hardwareToken.management",
"groups": [
263875
]
}
],
"realms": [
4164485
]
}
],
.
.
continue
}Save Function Group
POST
http://{{hostname}}/aioc-rest-web/rest/realms/saveFunctionGroup
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"Test Function Group\",\n \"description\": null,\n \"functions\": [\n {\n \"dbId\": 128,\n \"name\": \"aioc.users.approve.finalApproval\"\n },\n {\n \"dbId\": 127,\n \"name\": \"aioc.users.approve.all_user\"\n }\n ],\n \"realms\": [\n 4164485\n ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Test Function Group",
"description": null,
"functions": [
{
"dbId": 128,
"name": "aioc.users.approve.finalApproval"
},
{
"dbId": 127,
"name": "aioc.users.approve.all_user"
}
],
"realms": [
4164485
]
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"name":"Test Function Group","description":null,"functions":[{"dbId":128,"name":"aioc.users.approve.finalApproval"},{"dbId":127,"name":"aioc.users.approve.all_user"}],"realms":[4164485]}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
{
"dbId": 4164597,
"name": "Test Function Group",
"description": null,
"functions": [
{
"dbId": 128,
"name": "aioc.users.approve.finalApproval",
"groups": null
},
{
"dbId": 127,
"name": "aioc.users.approve.all_user",
"groups": null
}
],
"realms": [
4164485
]
}Update Function Group
POST
http://{{hostname}}/aioc-rest-web/rest/realms/saveFunctionGroup
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"dbId\": 4164597,\n \"name\": \"Test Function Group\",\n \"description\": null,\n \"functions\": [\n {\n \"dbId\": 127,\n \"name\": \"aioc.users.approve.all_user\"\n }\n ],\n \"realms\": [\n 4164485\n ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup' \
--header 'Content-Type: application/json' \
--data-raw '{
"dbId": 4164597,
"name": "Test Function Group",
"description": null,
"functions": [
{
"dbId": 127,
"name": "aioc.users.approve.all_user"
}
],
"realms": [
4164485
]
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/saveFunctionGroup",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"dbId":4164597,"name":"Test Function Group","description":null,"functions":[{"dbId":127,"name":"aioc.users.approve.all_user"}],"realms":[4164485]}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
{
"dbId": 4164597,
"name": "Test Function Group",
"description": null,
"functions": [
{
"dbId": 127,
"name": "aioc.users.approve.all_user",
"groups": null
}
],
"realms": [
4164485
]
}Delete Function Group
POST
http://{{hostname}}/aioc-rest-web/rest/realms/deleteFunctionGroup
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/deleteFunctionGroup");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"dbId\": 4164597\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/deleteFunctionGroup' \
--header 'Content-Type: application/json' \
--data-raw '{
"dbId": 4164597
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/deleteFunctionGroup",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"dbId":4164597}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
trueUpdate Realm
POST
http://{{hostname}}/aioc-rest-web/rest/realms/saveRealm
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"dbId\": 4164485,\n \"id\": \"068fd650-983f-4635-bf66-85ce75c3811c\",\n \"name\": \"Test realm\",\n \"description\": null,\n \"functionGroups\": [],\n \"userGroups\": [\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_USERS\"\n }\n ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm' \
--header 'Content-Type: application/json' \
--data-raw '{
"dbId": 4164485,
"id": "068fd650-983f-4635-bf66-85ce75c3811c",
"name": "Test realm",
"description": null,
"functionGroups": [],
"userGroups": [
{
"id": "DEFAULT_GROUP_SYSYEM_USERS"
}
]
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/saveRealm",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"dbId":4164485,"id":"068fd650-983f-4635-bf66-85ce75c3811c","name":"Test realm","description":null,"functionGroups":[],"userGroups":[{"id":"DEFAULT_GROUP_SYSYEM_USERS"}]}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
{
"dbId": 4164485,
"id": "068fd650-983f-4635-bf66-85ce75c3811c",
"name": "Test realm",
"description": null,
"functionGroups": [],
"userGroups": [
{
"id": "DEFAULT_GROUP_SYSYEM_USERS",
"eid": "System.users",
"description": "Single Connect default user group",
"users": [
{
"id": "ba4c2ea7-eb1a-4723-8ab3-c269aa8d8b55",
"eid": "[email protected]",
"personelId": null,
"name": null,
"passwordAlgorithm": null,
"password": null,
"email": null,
"surname": null,
"internal": false,
"properties": {
"ubaThreshold": "50",
"externalDirectorySource": "ldap"
},
"groups": [
"DEFAULT_GROUP_SYSYEM_USERS",
"NestedTest",
"test1"
],
"managerGroups": [],
"lastLogin": null,
"lastLoginIp": null,
"groupPropertyKey4Search": null,
"groupPropertyValue4Search": null,
"recordLimit4Search": null,
"passwordDirty": false,
"passwordAutoGenerated": false,
"filterFunctionName": null,
"filterMembershipUserId": null,
"filterManagerId": null,
"filterEidList": null,
"filterManagerOfUserId": null,
"unlockOnPasswordChanged": false,
"unlockTime": null,
"tempUserEndTime": null,
"tempUserStartTime": null,
"tempUser": false,
"externalDirectorySource": "ldap",
"userPropertyKey4Search": null,
"userPropertyValue4Search": null,
"phoneNumber": null,
"forceChangePasswordOnNextLogin": false,
"lockReason": null,
"locked": false
},
.
.
continue
}
}Delete Realm
POST
http://{{hostname}}/aioc-rest-web/rest/realms/deleteRealm
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/deleteRealm");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"dbId\": 4164485\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request POST 'http://{{hostname }}/aioc-rest-web/rest/realms/deleteRealm' \
--header 'Content-Type: application/json' \
--data-raw '{
"dbId": 4164485
}'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/deleteRealm",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": JSON.stringify({"dbId":4164485}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
trueGet Realm By Id
GET
http://{{hostname}}/aioc-rest-web/rest/realms/getRealmById/{realmUid}
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/getRealmById/1870d808-ce2d-4c85-a213-01ae39149945");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request GET 'http://{{hostname }}/aioc-rest-web/rest/realms/getRealmById/1870d808-ce2d-4c85-a213-01ae39149945'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/getRealmById/1870d808-ce2d-4c85-a213-01ae39149945",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
{
"dbId": 4164837,
"id": "1870d808-ce2d-4c85-a213-01ae39149945",
"name": "Test realm",
"description": null,
"functionGroups": [
{
"dbId": 263875,
"name": "TFA Hardware Token Management",
"description": "Genarated by system",
"functions": [
{
"dbId": 263874,
"name": "single.connect.twofactor. hardwareToken.management",
"groups": [
263875
]
}
],
"realms": [
4164837
]
}
],
.
.
continue
}Get All FunctionGroups
GET
http://{{hostname}}/aioc-rest-web/rest/realms/getFunctionGroups
csharp
var client = new RestClient("http://{{hostname }}/aioc-rest-web/rest/realms/getFunctionGroups");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl
curl --location -g --request GET 'http://{{hostname }}/aioc-rest-web/rest/realms/getFunctionGroups'javascript
var settings = {
"url": "http://{{hostname }}/aioc-rest-web/rest/realms/getFunctionGroups",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});200
[
{
"dbId": 192,
"name": "User Supervision",
"description": "Genarated by system",
"functions": [
{
"dbId": 128,
"name": "aioc.users.approve.finalApproval",
"groups": [
192
]
},
{
"dbId": 127,
"name": "aioc.users.approve.all_user",
"groups": [
192
]
}
],
"realms": []
},
.
.
continue
]