RPC API documentation v25.4.0

Creates new auditer consumer with last processed id which equals current auditer log max id.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/createAuditerConsumer

• see URL structure

Example params

{ "consumerName" : "NewConsumer" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Return list of names of all possible events

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/findAllPossibleEvents

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get all auditer consumers as a map with key=value pairs like String(name)=Integer(lastProcessedId).

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getAllAuditerConsumers

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get count of all messages stored in auditer logs.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getAuditerMessagesCount

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get ID of last (newest) message in auditer logs.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getLastMessageId

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns exact number of newest audit messages defined by 'count' param (disregarding message IDs). If there is less messages present, then all of them are returned.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getMessages

• see URL structure

Example params

{ "count" : 54 }

• see Passing params

Example response

[ { "id" : 249053 , "msg" : "Something happened." , "actor" : "actor@hostname.cz" , "createdAt" : "2015-03-16 16:00:40.449221" , "createdByUid" : "34" , "fullMessage" : "249053 \"2015-03-16 16:00:40.449221\" \"actor@hostname.cz\" Something happened." } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns 100 newest audit messages from audit log. If there is a less messages than 100, then all of them are returned.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getMessages

• see URL structure

Example response

[ { "id" : 249053 , "msg" : "Something happened." , "actor" : "actor@hostname.cz" , "createdAt" : "2015-03-16 16:00:40.449221" , "createdByUid" : "34" , "fullMessage" : "249053 \"2015-03-16 16:00:40.449221\" \"actor@hostname.cz\" Something happened." } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all messages with IDs within the range from max(ID) to (max(ID)-count), where number of returned messages is equal or less than 'count' param, because some IDs could be skipped in the sequence.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getMessagesByCount

• see URL structure

Example params

{ "count" : 82 }

• see Passing params

Example response

[ { "id" : 249053 , "msg" : "Something happened." , "actor" : "actor@hostname.cz" , "createdAt" : "2015-03-16 16:00:40.449221" , "createdByUid" : "34" , "fullMessage" : "249053 \"2015-03-16 16:00:40.449221\" \"actor@hostname.cz\" Something happened." } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns "count" number of messages that are more or equal than the given ID (ascending order), i.e. the method returns newer messages by provided ID.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getMessagesByIdAndCount

• see URL structure

Example params

{ "perunSession" : {...} , "id" : {...} , "count" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get page of audit messages. Query parameter specifies offset, page size and allows filtering by name of event. Total count is only estimated.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/getMessagesPage

• see URL structure

Example params

{ "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" } }

• see Passing params

Example response

{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "id" : 249053 , "msg" : "Something happened." , "actor" : "actor@hostname.cz" , "createdAt" : "2015-03-16 16:00:40.449221" , "createdByUid" : "34" , "fullMessage" : "249053 \"2015-03-16 16:00:40.449221\" \"actor@hostname.cz\" Something happened." } , {...} , {...} ]  }

• see Return values
• see HTTP return codes

Log arbitrary auditer message/event to the audit log.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/log

• see URL structure

Example params

{ "msg" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Returns list of AuditMessages from audit log with IDs > lastProcessedId for registered auditer consumer specified by consumerName param.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/pollConsumerMessages

• see URL structure

Example params

{ "consumerName" : "text" }

• see Passing params

Example response

[ { "id" : 249053 , "msg" : "Something happened." , "actor" : "actor@hostname.cz" , "createdAt" : "2015-03-16 16:00:40.449221" , "createdByUid" : "34" , "fullMessage" : "249053 \"2015-03-16 16:00:40.449221\" \"actor@hostname.cz\" Something happened." } , {...} , {...} ]

• see Return values
• see HTTP return codes

Set ID of last processed message for specified consumer.

Example URL

https://[hostname]/krb/rpc/json/auditMessagesManager/setLastProcessedId

• see URL structure

Example params

{ "consumerName" : "text" , "lastProcessedId" : 39 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes