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:



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






URLhttp://host:port/agent/getAvailableACLs/<sessionId>
Example URLhttp://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 URLhttp://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"
}


URLhttp://host:port/agent/getAvailableGroups/<sessionId>
Example URLhttp://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 URLhttp://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/logonAuthType/authtype/userid/credentials

Example URLhttp://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













© Ceptor ApS. All Rights Reserved.