OpenLiberty / docs

See Open Liberty documentation on https://openliberty.io/docs/
https://openliberty.io/docs/
Other
13 stars 47 forks source link

Remove 3.0 from "Servlet 3.0 APIs" in the audit event description #7629

Open una-tapa opened 5 days ago

una-tapa commented 5 days ago

In the following documentation, https://openliberty.io/docs/latest/audit-log-events-list-cadf.html#_security_api_authn https://openliberty.io/docs/latest/json-log-events-list.html#_supported_audit_events_and_their_audit_data

Please remove 3.0 from "Servlet 3.0 APIs" to make it clear that the audit events applies to all servlet releases after 3.0 (4.0+)

Current Description:

You can use the SECURITY_API_AUTHN event to capture the audit information from the login and authentication for servlet 3.0 APIs. The following table provides the fields for the SECURITY_API_AUTHN event and a description of each field.

When this issue is addressed, I would like to see..

You can use the SECURITY_API_AUTHN event to capture the audit information from the login and authentication for servlet APIs. The following table provides the fields for the SECURITY_API_AUTHN event and a description of each field.

I got @volosied and @jhanders34 's assistance (private link) to confirm that the audit tests cover the EE 6 through 10 features to verify that the audits are correctly processed and E11 will also be added soon.

ramkumar-k-9286 commented 1 day ago

Hi @una-tapa

Suggested corrections have been made.

Draft links:

https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/audit-log-events-list-cadf.html#_security_api_authn

https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/json-log-events-list.html#_supported_audit_events_and_their_audit_data

Please review the same and add the Developer Reviewed label if you are satisfied with the changes.

Regards, Ramkumar.

CC @dmuelle