"openapi: 3.1.0\ninfo:\n title: Audit\n description: >\n Audit log records are detailed information about actions and events, which can be provided by any service. For some pre-defined events services always create audit records and the Audit Service\n always saves them. Audit records have a lifespan of 30 days, after which they will be discarded.\n\n\n **Base path change and deprecation notice**\n\n\n The base path for the Audit APIs is changing (from `/api/audit-service` to `/api/audit`). The `/api/audit-service/` base path will continue to function until `Tue, 24 Mar 2026 05:00:00 GMT`.\n\n\n Additionally, several endpoints are being deprecated. Endpoints that are being deprecated include additional properties in response headers:\n\n\n ```\n\n \"Deprecation\": \"Tue, 31 Dec 2024 23:59:59 GMT\",\n\n \"Link\": \"New version of API link; rel=\\\"alternate\\\"\",\n\n \"Sunset\": \"Tue, 24 Mar 2026 05:00:00 GMT\"\n\n ```\n\n\n * `Deprecation`: The date and time when a resource will be deprecated. After this date, the resource may be removed from future versions of the API.\n\n * `Link`: A link to a supported endpoint that replicates the functionality of a deprecated one.\n\n * `Sunset`: The date and time when a resource will be removed, and no longer be available.\n\n\n * `Note`: Media type names used in Polaris APIs were renamed and no longer include “synopsys”.\n Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until March 24, 2026 05:00:00 GMT.\n Please update your scripts to use the new media types.\n contact:\n name: Black Duck Software, Inc.\n url: https://polaris.blackduck.com\n version: 1.0.0\nservers:\n - url: https://polaris.blackduck.com\ntags:\n - name: Records\n description: Contains APIs to get or export audit log records.\n - name: Event Types\n description: Contains API to get information about supported event types.\n - name: Logs\n description: Contains APIs to get or export audit log records.\n - name: Categories\n description: Contains API to get information about supported audit categories.\nsecurity:\n - ApiKeyAuth: []\npaths:\n /api/audit-service/records:\n get:\n tags:\n - Records\n summary: Get audit log records.\n description: >-\n Audit log records can be filtered by the optional parameters in the following section. If filter parameters are not specified, all the records are returned. Otherwise, records matching all the\n filter criteria are returned.\n operationId: getRecordsDeprecated\n parameters:\n - name: eventType\n in: query\n description: |\n Filters records by audit event type. The **eventType** query parameter value is case sensitive. \\\n If the **eventType** does not match any event type, the API will return an empty list. \\\n Example event-types are `Entitlement Offer`, and `Subscription` etc. \\\n Refer `Event Types (/event-types)` API to discover the available event types.\n schema:\n type: string\n example: User Events\n - name: event\n in: query\n description: |\n Filters records by audit event name. The **event** query parameter is case sensitive. \\\n If the **event** name does not match any event, the API will return an empty list. \\\n Example event names are `Logged in`, `Subscription created`, and `Assessment created`.\n schema:\n type: string\n example: Logged In\n - name: startDate\n in: query\n description: >-\n Filters records by the time when an event occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd\n HH:mm:ss.SSSSSS`, `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `startDate` is specified,\n records for events that occurred on or after the `startDate` will be returned. If not specified, all the records will be returned. Examples are `2022-01-01 01:01:01.1`, `2022-01-01`, and\n `2022-01-01 01:01:01.123456`.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: endDate\n in: query\n description: >-\n Filters records by the time when events occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd HH:mm:ss.SSSSSS`,\n `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `endDate` is specified, records for events\n that occurred on or before the `endDate` will be returned. If not specified, all the records will be returned.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: user\n in: query\n description: Filters records by the user who performed the action. There is no default value for this field. If not specified, records for all users can be returned.\n schema:\n type: string\n example: testuser\n - name: search\n in: query\n description: |\n Filters audit logs based on the contents of their message. \n It allows for case-insensitive partial matching against the messages of audit logs. \\\n Returns the audit logs that contain the provided **search** string in the audit log message.\n If no match is found, it will return an empty list. \\\n The search filter ignores the common english words like `a`, `and`, `the` etc, and special characters like `&` and `|` etc and searches for the remaining words in the message.\n\n **E.g:** If the message is `User logged in`, and the search query is `search=logged`, the audit log will be returned.\n schema:\n type: string\n example: Logged In\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/6'\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/7'\n responses:\n '200':\n description: Success. A paged list of records will be returned.\n content:\n application/vnd.audit-service.records-1+json:\n schema:\n $ref: '#/components/schemas/Records'\n example:\n _items:\n - _type: record\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/records/f6b4944e-87ce-11ec-a8a3-0242ac120002\n rel: self\n method: GET\n id: f6b4944e-87ce-11ec-a8a3-0242ac120002\n actionName: Logged in\n categoryName: User Events\n message: User logged in successfully\n user: user@example.com\n actionAt: '2022-08-10 12:45:27.245'\n clientIP: 192.168.1.1\n organizationId: 60db54c9-d6bd-47d7-94ca-4cf90521311d\n organizationName: ExampleOrg\n - _type: record\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/records/g7c5055f-98df-22fd-b9b4-1353bd231113\n rel: self\n method: GET\n id: a7c5055f-98df-22fd-b9b4-1353bd231113\n actionName: Assessment created\n categoryName: Assessment Audit\n message: 'New assessment created. Assessment name: TestAssessment'\n user: admin@example.com\n actionAt: '2022-08-10 13:30:15.678'\n clientIP: 10.0.0.5\n organizationId: 60db54c9-d6bd-47d7-94ca-4cf90521311d\n organizationName: ExampleOrg\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/records?_offset=0&_limit=25\n rel: self\n method: GET\n - href: https://polaris.blackduck.com/api/audit-service/records?_offset=0&_limit=25\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/audit-service/records?_offset=25&_limit=25\n rel: next\n method: GET\n _collection:\n itemCount: 100\n currentPage: 1\n pageCount: 4\n type: records\n '400':\n description: Bad request\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1categories/get/responses/400/content/*~1*/examples/standard'\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/examples/standard'\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/403/content/*~1*/examples/standard'\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/404/content/*~1*/examples/standard'\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/405/content/*~1*/examples/standard'\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/500/content/*~1*/examples/standard'\n deprecated: true\n /api/audit/logs:\n get:\n tags:\n - Logs\n summary: Get audit log records.\n description: >-\n Audit log records can be filtered by the optional parameters in the following section. If filter parameters are not specified, all the records are returned. Otherwise, records matching all the\n filter criteria are returned.\n operationId: getLogRecords\n parameters:\n - name: category\n in: query\n description: |\n Filters records by audit activity category. The **category** query parameter value is case sensitive. \\\n If the **category** does not match any audit activity category, the API will return an empty list. \\\n Example categories are `Entitlement Offer`, and `Subscription` etc. \\\n Refer **Categories (/categories)** API to discover the available audit activity categories.\n schema:\n type: string\n example: User Events\n - name: event\n in: query\n description: |\n Filters records by audit event name. The **event** query parameter is case sensitive. \\\n If the **event** name does not match any event, the API will return an empty list. \\\n Example event names are `Logged in`, `Subscription created`, and `Assessment created`.\n schema:\n type: string\n example: Logged In\n - name: startDate\n in: query\n description: >-\n Filters records by the time when an event occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd\n HH:mm:ss.SSSSSS`, `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `startDate` is specified,\n records for events that occurred on or after the `startDate` will be returned. If not specified, all the records will be returned. Examples are `2022-01-01 01:01:01.1`, `2022-01-01`, and\n `2022-01-01 01:01:01.123456`.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: endDate\n in: query\n description: >-\n Filters records by the time when events occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd HH:mm:ss.SSSSSS`,\n `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `endDate` is specified, records for events\n that occurred on or before the `endDate` will be returned. If not specified, all the records will be returned.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: user\n in: query\n description: Filters records by the user who performed the action. There is no default value for this field. If not specified, records for all users can be returned.\n schema:\n type: string\n example: testuser\n - name: search\n in: query\n description: |\n Filters audit logs based on the contents of their message. \n It allows for case-insensitive partial matching against the messages of audit logs. \\\n Returns the audit logs that contain the provided **search** string in the audit log message.\n If no match is found, it will return an empty list. \\\n The search filter ignores the common english words like `a`, `and`, `the` etc, and special characters like `&` and `|` etc and searches for the remaining words in the message.\n\n **E.g:** If the message is `User logged in`, and the search query is `search=logged`, the audit log will be returned.\n schema:\n type: string\n example: Logged In\n - name: _offset\n in: query\n description: Return results starting from a given numerical (0-based) offset\n schema:\n type: integer\n default: 0\n example: 0\n - name: _limit\n in: query\n description: Restrict the number of results to an upper bound\n schema:\n type: integer\n default: 25\n example: 25\n responses:\n '200':\n description: Success. A paged list of log records will be returned.\n content:\n application/vnd.polaris.audit.logs-1+json:\n schema:\n $ref: '#/components/schemas/LogRecords'\n examples:\n standard:\n summary: Paginated list of audit log records\n value:\n _items:\n - _type: logRecord\n _links:\n - href: https://polaris.blackduck.com/api/audit/logs/f6b4944e-87ce-11ec-a8a3-0242ac120002\n rel: self\n method: GET\n id: f6b4944e-87ce-11ec-a8a3-0242ac120002\n actionName: Logged in\n categoryName: User Events\n message: User logged in successfully\n user: user@example.com\n actionAt: '2022-08-10 12:45:27.245'\n clientIP: 192.168.1.1\n organizationId: 60db54c9-d6bd-47d7-94ca-4cf90521311d\n organizationName: ExampleOrg\n - _type: logRecord\n _links:\n - href: https://polaris.blackduck.com/api/audit/logs/g7c5055f-98df-22fd-b9b4-1353bd231113\n rel: self\n method: GET\n id: a7c5055f-98df-22fd-b9b4-1353bd231113\n actionName: Assessment created\n categoryName: Assessment Audit\n message: 'New assessment created. Assessment name: TestAssessment'\n user: admin@example.com\n actionAt: '2022-08-10 13:30:15.678'\n clientIP: 10.0.0.5\n organizationId: 60db54c9-d6bd-47d7-94ca-4cf90521311d\n organizationName: ExampleOrg\n _links:\n - href: https://polaris.blackduck.com/api/audit/logs?_offset=0&_limit=25\n rel: self\n method: GET\n - href: https://polaris.blackduck.com/api/audit/logs?_offset=0&_limit=25\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/audit/logs?_offset=25&_limit=25\n rel: next\n method: GET\n _collection:\n itemCount: 100\n currentPage: 1\n pageCount: 4\n type: logs\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1categories/get/responses/400/content/*~1*/examples/standard'\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n type: object\n properties:\n status:\n type: integer\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem type, except for purposes of localization.\n errors:\n type: array\n description: Collection of error items that contains detailed information about failures.\n items:\n type: object\n properties:\n details:\n type: string\n description: A localized, human-readable explanation specific to this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n examples:\n standard:\n summary: User is not authorized to access this resource\n value:\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n summary: Access to the resource is forbidden\n value:\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n summary: The specified resource was not found\n value:\n title: Not found\n status: 404\n detail: Requested resource is not found\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n summary: HTTP method is not allowed for this endpoint\n value:\n title: Method Not Allowed\n status: 405\n detail: Request method is not supported\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n summary: Internal server error\n value:\n title: Internal Server Error\n status: 500\n detail: Internal Server Error\n /api/audit-service/records/export:\n get:\n tags:\n - Records\n summary: Export audit log records as CSV.\n description: >-\n Exports audit records to a CSV file. Records can be filtered by the optional parameters in the following section. If no filtering parameters are specified, all the records are returned.\n Otherwise records matching all the criteria are returned.\n operationId: exportRecordsDeprecated\n parameters:\n - name: eventType\n in: query\n description: Filters records by event type. Example event-types are `Entitlement Offer`, and `Subscription`. You can use the *Event Types API* to discover the available types.\n schema:\n type: string\n example: User Events\n - name: event\n in: query\n description: Filters records by action name. Example actions are `Logged in`, `Subscription created`, and `Assessment created`.\n schema:\n type: string\n example: Logged In\n - name: startDate\n in: query\n description: >-\n Filters records by the time when an event occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd\n HH:mm:ss.SSSSSS`, `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `startDate` is specified,\n records for events that occurred on or after the `startDate` will be returned. If not specified, all the records will be returned. Examples are `2022-01-01 01:01:01.1`, `2022-01-01`, and\n `2022-01-01 01:01:01.123456`.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: endDate\n in: query\n description: >-\n Filters records by the time when events occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd HH:mm:ss.SSSSSS`,\n `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `endDate` is specified, records for events\n that occurred on or before the `endDate` will be returned. If not specified, all the records will be returned.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: user\n in: query\n description: Filters records by the user who performed the action. There is no default value for this field. If not specified, records of all users can be returned.\n schema:\n type: string\n example: testuser\n - name: search\n in: query\n description: Filters records by the message strings they contain.\n schema:\n type: string\n example: Logged In\n responses:\n '200':\n description: Success. A CSV file containing audit records will be returned.\n content:\n text/csv:\n schema:\n type: string\n example: >\n id,actionName,categoryName,message,user,actionAt,clientIP,organizationId,organizationName\n\n f6b4944e-87ce-11ec-a8a3-0242ac120002,Logged in,User Events,User logged in successfully,user@example.com,2022-08-10\n 12:45:27.245,192.168.1.1,60db54c9-d6bd-47d7-94ca-4cf90521311d,ExampleOrg\n\n g7c5055f-98df-22fd-b9b4-1353bd231113,Assessment created,Assessment Audit,New assessment created. Assessment name: TestAssessment,admin@example.com,2022-08-10\n 13:30:15.678,10.0.0.5,60db54c9-d6bd-47d7-94ca-4cf90521311d,ExampleOrg\n '400':\n description: Bad request\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1categories/get/responses/400/content/*~1*/examples/standard'\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/examples/standard'\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/403/content/*~1*/examples/standard'\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/404/content/*~1*/examples/standard'\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/405/content/*~1*/examples/standard'\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/500/content/*~1*/examples/standard'\n deprecated: true\n /api/audit/logs/export:\n get:\n tags:\n - Logs\n summary: Export audit log records as CSV.\n description: >-\n Exports audit log records to a CSV file. Log records can be filtered by the optional parameters in the following section. If no filtering parameters are specified, all the records are\n returned. Otherwise records matching all the criteria are returned.\n operationId: exportLogRecords\n parameters:\n - name: category\n in: query\n description: >-\n Filters log records by audit activity category. Example audit categories are `Entitlement Offer`, and `Subscription`. You can use the **Categories (/categories)** API to discover the\n available categories.\n schema:\n type: string\n example: User Events\n - name: event\n in: query\n description: Filters records by action name. Example actions are 'Logged in', `Subscription created`, and `Assessment created`.\n schema:\n type: string\n example: Logged In\n - name: startDate\n in: query\n description: >-\n Filters records by the time when an event occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd\n HH:mm:ss.SSSSSS`, `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `startDate` is specified,\n records for events that occurred on or after the `startDate` will be returned. If not specified, all the records will be returned. Examples are `2022-01-01 01:01:01.1`, `2022-01-01`, and\n `2022-01-01 01:01:01.123456`.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: endDate\n in: query\n description: >-\n Filters records by the time when events occurred. You can filter events by only the date or by the date and also the time. Accepted formats are `yyyy-MM-dd`, `yyyy-MM-dd HH:mm:ss.SSSSSS`,\n `yyyy-MM-dd HH:mm:ss.SSSSS`, `yyyy-MM-dd HH:mm:ss.SSSS`, `yyyy-MM-dd HH:mm:ss.SSS`, `yyyy-MM-dd HH:mm:ss.SS`, and `yyyy-MM-dd HH:mm:ss.S`. If `endDate` is specified, records for events\n that occurred on or before the `endDate` will be returned. If not specified, all the records will be returned.\n schema:\n type: string\n example: '2022-01-01 01:01:01.123456'\n - name: user\n in: query\n description: Filters records by the user who performed the action. There is no default value for this field. If not specified, records of all users can be returned.\n schema:\n type: string\n example: testuser\n - name: search\n in: query\n description: Filters log records by the message strings they contain.\n schema:\n type: string\n example: Logged In\n responses:\n '200':\n description: Success. A CSV file containing audit log records will be returned.\n content:\n text/csv:\n schema:\n type: string\n example: >\n id,actionName,categoryName,message,user,actionAt,clientIP,organizationId,organizationName\n\n f6b4944e-87ce-11ec-a8a3-0242ac120002,Logged in,User Events,User logged in successfully,user@example.com,2022-08-10\n 12:45:27.245,192.168.1.1,60db54c9-d6bd-47d7-94ca-4cf90521311d,ExampleOrg\n\n g7c5055f-98df-22fd-b9b4-1353bd231113,Assessment created,Assessment Audit,New assessment created. Assessment name: TestAssessment,admin@example.com,2022-08-10\n 13:30:15.678,10.0.0.5,60db54c9-d6bd-47d7-94ca-4cf90521311d,ExampleOrg\n '400':\n description: Bad request\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1categories/get/responses/400/content/*~1*/examples/standard'\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/examples/standard'\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/403/content/*~1*/examples/standard'\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/404/content/*~1*/examples/standard'\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/405/content/*~1*/examples/standard'\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/500/content/*~1*/examples/standard'\n /api/audit-service/event-types:\n get:\n description: Event types that can be audited. This API returns the list of available event types.\n tags:\n - Event Types\n summary: Get available event types.\n operationId: getEventTypesDeprecated\n parameters:\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/6'\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/7'\n responses:\n '200':\n description: Success. A paged list of records will be returned.\n content:\n application/vnd.audit-service.event-types-1+json:\n schema:\n $ref: '#/components/schemas/eventTypes'\n example:\n _items:\n - _type: eventType\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/event-types/9f1b397a-55fe-4980-a19e-9afea69ec98e\n rel: self\n method: GET\n id: 9f1b397a-55fe-4980-a19e-9afea69ec98e\n name: Assessment Audits\n description: Assessment Audit\n - _type: eventType\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/event-types/7e2c286b-44ed-3879-b08d-8bfdb58db87d\n rel: self\n method: GET\n id: 7e2c286b-44ed-3879-b08d-8bfdb58db87d\n name: User Events\n description: User authentication and account activities\n _links:\n - href: https://polaris.blackduck.com/api/audit-service/event-types?_offset=0&_limit=25\n rel: self\n method: GET\n - href: https://polaris.blackduck.com/api/audit-service/event-types?_offset=0&_limit=25\n rel: first\n method: GET\n _collection:\n itemCount: 2\n currentPage: 1\n pageCount: 1\n type: eventTypes\n '400':\n description: Bad request\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1categories/get/responses/400/content/*~1*/examples/standard'\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/examples/standard'\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/403/content/*~1*/examples/standard'\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/404/content/*~1*/examples/standard'\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/405/content/*~1*/examples/standard'\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/500/content/*~1*/examples/standard'\n deprecated: true\n /api/audit/categories:\n get:\n description: Categories of events that can be audited. This API returns the list of available categories.\n tags:\n - Categories\n summary: Get available event types.\n operationId: getAuditCategories\n parameters:\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/6'\n - $ref: '#/paths/~1api~1audit~1logs/get/parameters/7'\n responses:\n '200':\n description: Success. A paged list of categories will be returned.\n content:\n application/vnd.polaris.audit.categories-1+json:\n schema:\n $ref: '#/components/schemas/Categories'\n example:\n _items:\n - _type: category\n _links:\n - href: https://polaris.blackduck.com/api/audit/categories/9f1b397a-55fe-4980-a19e-9afea69ec98e\n rel: self\n method: GET\n id: 9f1b397a-55fe-4980-a19e-9afea69ec98e\n name: Assessment Audit\n description: Assessment Audit\n - _type: category\n _links:\n - href: https://polaris.blackduck.com/api/audit/categories/7e2c286b-44ed-3879-b08d-8bfdb58db87d\n rel: self\n method: GET\n id: 7e2c286b-44ed-3879-b08d-8bfdb58db87d\n name: User Events\n description: User authentication and account activities\n _links:\n - href: https://polaris.blackduck.com/api/audit/categories?_offset=0&_limit=25\n rel: self\n method: GET\n - href: https://polaris.blackduck.com/api/audit/categories?_offset=0&_limit=25\n rel: first\n method: GET\n _collection:\n itemCount: 2\n currentPage: 1\n pageCount: 1\n type: categories\n '400':\n description: Bad request\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n summary: Request validation failed\n value:\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed queryParameter is not recognised\n '401':\n description: User is not authorized\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/examples/standard'\n '403':\n description: Forbidden\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/403/content/*~1*/examples/standard'\n '404':\n description: Not found\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/404/content/*~1*/examples/standard'\n '405':\n description: Method Not Allowed\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/405/content/*~1*/examples/standard'\n '500':\n description: Internal Server Error\n content:\n '*/*':\n schema:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/401/content/*~1*/schema'\n examples:\n standard:\n $ref: '#/paths/~1api~1audit~1logs/get/responses/500/content/*~1*/examples/standard'\ncomponents:\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: Api-Token\n schemas:\n eventTypes:\n type: object\n properties:\n _items:\n type: array\n description: Collection of event types.\n items:\n $ref: '#/components/schemas/eventTypeV1Resource'\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n _collection:\n $ref: '#/components/schemas/Records/properties/_collection'\n deprecated: true\n Records:\n type: object\n properties:\n _items:\n type: array\n description: Collection of audit records.\n items:\n $ref: '#/components/schemas/recordV1Resource'\n _links:\n type: array\n description: An array of links that can be followed for further information about this resource.\n items:\n type: object\n description: link that can be followed for further information about this resource.\n properties:\n href:\n type: string\n format: uri\n description: The URI to follow for this reference.\n rel:\n type: string\n format: rel\n description: The relation name. The relation names used for pagination are `self`, `first`, `last`, `previous`, and `next`.\n method:\n type: string\n description: The HTTP method to use while following this reference.\n _collection:\n type: object\n description: It contains information about the number of items in the response, total number of actual audit records, number of pages.\n properties:\n itemCount:\n type: integer\n description: The total length of the collection. An empty result has an itemCount of 0.\n currentPage:\n type: integer\n description: The current page number of the results (one-based), given the current offset and limit settings. An empty result does not have a current page.\n pageCount:\n type: integer\n description: The number of pages in the collection, given the current limit settings. An empty result has a pageCount of 0.\n type:\n type: string\n description: The type of the resource collection\n deprecated: true\n eventTypeV1Resource:\n allOf:\n - type: object\n properties:\n _type:\n type: string\n description: The type of a single resource\n - type: object\n properties:\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n - type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique ID of the event type.\n name:\n type: string\n description: Name of the event type.\n description:\n type: string\n description: Brief description of the event type.\n deprecated: true\n recordV1Resource:\n allOf:\n - type: object\n properties:\n _type:\n type: string\n description: The type of a single resource\n - type: object\n properties:\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n - type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique ID of the audit record.\n actionName:\n type: string\n description: Name of the action performed by the user.\n categoryName:\n type: string\n description: Name of the category the action belongs to.\n message:\n type: string\n description: Detailed information about the events.\n user:\n type: string\n description: Username of the user by whom the action was triggered.\n actionAt:\n type: string\n description: Date and Time of the event.\n clientIP:\n type: string\n description: IP of the client machine where the event occurred.\n organizationId:\n type: string\n format: uuid\n description: The ID of the organization from where the event came from\n organizationName:\n type: string\n description: The name of the organization from where the event came from\n deprecated: true\n Categories:\n type: object\n properties:\n _items:\n type: array\n description: Collection of audit categories.\n items:\n $ref: '#/components/schemas/categoryV1Resource'\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n _collection:\n $ref: '#/components/schemas/Records/properties/_collection'\n LogRecords:\n type: object\n properties:\n _items:\n type: array\n description: Collection of audit log records.\n items:\n $ref: '#/components/schemas/logRecordV1Resource'\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n _collection:\n $ref: '#/components/schemas/Records/properties/_collection'\n logRecordV1Resource:\n allOf:\n - type: object\n properties:\n _type:\n type: string\n description: The type of a single resource\n - type: object\n properties:\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n - type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique ID of the audit log record.\n actionName:\n type: string\n description: Name of the action performed by the user.\n categoryName:\n type: string\n description: Name of the category the action belongs to.\n message:\n type: string\n description: Detailed information about the events.\n user:\n type: string\n description: Username of the user by whom the action was triggered.\n actionAt:\n type: string\n description: Date and Time of the event.\n clientIP:\n type: string\n description: IP of the client machine where the event occurred.\n organizationId:\n type: string\n format: uuid\n description: The ID of the organization from where the event came from\n organizationName:\n type: string\n description: The name of the organization from where the event came from\n categoryV1Resource:\n allOf:\n - type: object\n properties:\n _type:\n type: string\n description: The type of a single resource\n - type: object\n properties:\n _links:\n $ref: '#/components/schemas/Records/properties/_links'\n - type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique ID of the category.\n name:\n type: string\n description: Name of the category.\n description:\n type: string\n description: Brief description of the category.\n"

{}