Agent REST Service

This API has been deprecated, and is replaced by Ceptor Agent REST API which has an OpenAPI spec available describing it, and more functionality available.

Once agent REST services are enabled and properly configured they can be accessed as shown below

The agent REST services reflect the java agent methods with the same name - and the detailed documentation can be found here: Ceptor Agent for Java

These are the available REST agent methods:

URL	http://host:port/restservices/agent/newSession/<clientIP>
Example URL	http://localhost:5300/restservices/agent/newSession/127.0.0.1
Output example	{"sessionID": "PPID_AAkBMTI3LjAuMC4xACwCAAABXPARPk0AAAAQcVbaskQvx5EA1InzEzgvGiRVJE99Cxq+onONe8SvWYAAAQMB"}

URL	http;://host:port/restservices/agent/changePassword/<sessionId>/<oldPassword>/<newPassword>
Example URL	http://localhost:5300/restservices/agent/changePassword/<sessionId>/zaq12wsx/ZsAx"1Wq
Output example	{"status": "ok"}

URL	http://host:port/restservices/agent/checkPermission/<sessionId>/<acl>
Example URL	http://localhost:5300/restservices/agent/checkPermission/webapp1.access
Output example	{"status": "true"}

URL

http://host:port/agent/getAvailableACLs/<sessionId>

Example URL

http://localhost:5300/agent/getAvailableACLs/<sessionid>

Output example

{
"permissions": [
{
"name": "create",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
},
{
"name": "read",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
},
{
"name": "write",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
}
],
"dataPolicies": null,
"name": "user",
"dotNetTypeName": "PortalProtect.Authorization.ACLEntry"
},

........

}

URL

http://host:port/restservices/agent/getACL/<acl.name>/<identifier>

(Identifier can be omitted)

Example URL

http://localhost:5300/restservices/agent/getACL/user/

Output example

{
"permissions": [
{
"name": "create",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
},
{
"name": "read",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
},
{
"name": "write",
"members": ["UserAdmUsers"],
"dotNetTypeName": "PortalProtect.Authorization.PermissionEntry"
}
],
"dataPolicies": null,
"name": "user",
"dotNetTypeName": "PortalProtect.Authorization.ACLEntry"
}

URL

http://host:port/agent/getAvailableGroups/<sessionId>

Example URL

http://localhost:5300/agent/getAvailableGrops/<sessionid>

Output example

[
{
"shortName": "Administrators",
"description": "Administrators",
"members": [],
"name": "Administrators",
"dotNetTypeName": "PortalProtect.Authorization.GroupEntry"
},
{
"shortName": "UserAdmUsers",
"description": "UserAdmUsers",
"members": [],
"name": "UserAdmUsers",
"dotNetTypeName": "PortalProtect.Authorization.GroupEntry"
},
.......

}

]

URL

http://host:port/restservices/agent/getGroup/<group name>/<identifier>

(Identifier can be omitted)

Example URL

http://localhost:5300/restservices/agent/getACL/Administratos/

Output example

{
"shortName": "Administrators",
"description": "Administrators",
"members": [],
"name": "Administrators",
"dotNetTypeName": "PortalProtect.Authorization.GroupEntry"
}

URL	http://host:port/restservices/agent/logon/userid/password
Example URL	http://localhost:5300/restservices/agent/logon/corpuser1/9ftyPass
Output example	{ "status": "ok" }

URL	http://host:port/restservices/agent/logonAuthType/authtype/userid/credentials
Example URL	http://localhost:5300/restservices/agent/logonAuthType/1/corpuser1/9ftyPass
Output example	{ "status": "ok" }
Description:	First argument is the Authentication type (return in the getAuthenticationType method in the Authentication plugin) Second argument is the userid Third is the credentials that are passed to the plugin (can be any string) Note: this method is implemented in Ceptor version 5.70.4

URL	http://host:port/restservices/agent/getChannelType/<sessionId>
Example URL	http://localhost:5300/restservices/agent/getChannelType/<sessionId>
Output example	{ "response": "ssl" }
Other methods	The following methods works the exact same way: http://host:port/restservices/agent/getCICSUser/<sessionId> http://host:port/restservices/agent/getCICSPassword/<sessionId> http://host:port/restservices/agent/getCustomerID/<sessionId> http://host:port/restservices/agent/getAgreementID/<sessionId> http://host:port/restservices/agent/getUser/<sessionId> http://host:port/restservices/agent/getUserIP/<sessionId> http://host:port/restservices/agent/getUserName/<sessionId> http://host:port/restservices/agent/isInternalUser/<sessionId> http://host:port/restservices/agent/isLoggedOn/<sessionId> http://host:port/restservices/agent/isValid/<sessionId> http://host:port/restservices/agent/isDelayedLogoff/<sessionid> http://host:port/restservices/agent/getAuthenticationLevel/<sessionId> http://host:port/restservices/agent/getAuthenticationMethod/sessionId> http://host:port/restservices/agent/getStateVariable/<sessionId>/<key> http://host:port/restservices/agent/getName

URL	http://host:port/restservices/agent/logoff/<sessionid>
Example URL	http://localhost:5300/restservices/agent/logoff/<sessionid>
Output example	{ "status": "ok" }
Other methods	The following methods works the exact same way: http://host:port/restservices/agent/delayedLogoff/<sessionid> http://host:port/restservices/agent/cancelDelayedLogoff/<sessionid>

URL	http://host:port/restservices/agent/getChannelType/<sessionId>
Example URL	http://host:port/restservices/agent/getChannelType/<sessionId>
Output example	{"response": "04"}

URL	http://host:port/restservices/agent/getAuthenticationMethod/<sessionId>
Example URL	http://host:port/restservices/agent/getAuthenticationMethod/<sessionId>
Output example	{"response": "26"}