diff --git a/definitions/openapi_latest.json b/definitions/openapi_latest.json index fdefb5e..a49fc1d 100644 --- a/definitions/openapi_latest.json +++ b/definitions/openapi_latest.json @@ -12,7 +12,7 @@ "name" : "BlueConic", "url" : "https://github.com/blueconic/openapi/blob/main/LICENSE.MD" }, - "version" : "89.0" + "version" : "90.0" }, "servers" : [ { "url" : "https://{blueconicHostname}/rest/v2", @@ -26,7 +26,7 @@ } ], "tags" : [ { "name" : "Audit Events", - "description" : "The Audit Event API allows users to connect BlueConic to a SIEM system. We recommend using this API to periodically receive security-related activities based on a rolling window. The API has a 30-day retention period.\n\nThe API logs the following audit events:\n\n| Object | Events |\n| :---------------------------------------- |:-----------------------------------------------------------------------------------------------|\n| BlueConic hostname | Create, Update, Delete |\n| BlueConic Support Access | Update (for each change) |\n| Channel | Create, Update, Delete |\n| Clean up rule | Create, Update, Delete |\n| Connection | Create, Update, Delete, Manual run, Scheduled run |\n| Dashboard | Create, Update, Delete |\n| Dialogue | Create, Update, Delete |\n| Domain Group | Create, Update, Delete |\n| Group | Read, Update, Delete |\n| Group type | Create, Update, Delete |\n| Ip range | Create, Update, Delete |\n| Language | Create, Update, Delete |\n| Lifecycle | Create, Update, Delete |\n| Merge rule | Create, Update, Delete |\n| Notebook | Create, Update, Delete, Manual run, Scheduled run, Editor run |\n| OAuth application | Create, Update, Delete |\n| OAuth token | Create, Update, Delete |\n| Objective | Create, Update, Delete |\n| Plugin | Create, Update, Delete |\n| Privacy setting | Update (for each change) |\n| Profile | Read, Update, Delete |\n| Profile property | Create, Update, Delete |\n| Role | Create, Update, Delete |\n| Segment | Create, Update, Delete |\n| Single Sign On Setting | Update (for each change) |\n| Supported Legislation Zone | Create, Delete, Update |\n| Tracker | Create, Update, Delete |\n| User | Login, Login failed, Logout, Create, Update, Delete, Password reset requested, Password change |\n\n\nOnly Profile and Group viewed, updated, or deleted by a user from the Profile and Groups tab are logged.\n\nThe following events are not considered as human actions, and therefore not covered in the Platform\nAudit Event API:\n\n- Connections that import or export profiles.\n- Profile and group creation (Profiles can only be created by a visitor or an import connection).\n\n**Event data**\n\nThe following event data is available:\n\n| Field | Description | Example values |\n| :--- | :--- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|date|Datetime in UTC when the event occurred. The date is in the https://www.ietf.org/rfc/rfc3339.txt format.| 2023-04-15T11:24:01.183Z |\n|username|(BlueConic) Identifier (email address) of the user who did the action.

Value is empty for failed login attempts.| test@blueconic.com |\n|objectType|Object of the action.| |\n|objectId|| |\n|objectName|

Human readable name of the object.

For Profiles, the name is determined by the first value that is not empty:

  1. fullname
  2. email
  3. BlueConic ID (UUID)

For Users, the name is determined by the first value that is not empty:

  1. fullname
  2. email

For groups, the name is the group id.

For PRIVACY_SETTING and SINGLE_SIGN_ON_SETTING, the objectName is the name(s) of the changed setting. E.g. Status, Identity_Provider_Issuer_URL_Entity_ID.

For BLUECONIC_SUPPORT_ACCESS_SETTING the objectName contains the new settings.

|