openapi: 3.2.0 info: title: Sign In Solutions VMS Audit Logs API version: 0.21.0 x-logo: url: https://signinenterprise.com/wp-content/uploads/tg-logo-light@2.png backgroundColor: '#FFFFFF' altText: Sign In Solutions href: https://signinsolutions.com/signinenterprise description: The Traction Guest API is currently under limited release to select customers as we gather and iterate on feedback. contact: name: API Support url: https://signinsolutions.com/signinenterprise email: support@tractionguest.com servers: - url: '{domain}' variables: domain: enum: - https://us.tractionguest.com/api/v3 - http://localhost:3000/api/v3 default: https://us.tractionguest.com/api/v3 security: - TractionGuestAuth: - all - openid - admin:webhooks - watchlists:* - watchlists:read - watchlists:write - users:* - users:read - users:write - visitors:* - visitors:read - visitors:write - parking:* - parking:read - parking:write - locations:* - locations:read - locations:write - hosts:* - hosts:read - hosts:write - email_templates:* - email_templates:read - email_templates:write tags: - name: Audit Logs description: All endpoints related to the AuditLog model. paths: /audit_logs: summary: Path used to manage the list of AuditLogs. description: The REST endpoint/path used to list zero or more `AuditLog` entities. This path contains a `GET` operation to perform the list task. get: tags: - Audit Logs parameters: - name: limit description: Limits the results to a specified number, defaults to 50 schema: type: integer in: query required: false - name: offset description: Offsets the results to a specified number, defaults to 0 schema: type: integer in: query required: false - name: sort_by description: Sorts by the field name and direction provided where the pattern is `FIELD_NAME_DIRECTION` schema: type: string in: query - name: auditable_id description: The unique ID of a model that has associated audit logs schema: type: integer in: query - name: auditable_type description: 'The name of the model that has associated audit logs. Valid values include: - `user` - `device_configuration` - `signin` - `invite` - `watchlist_record` - `account_preference` - `signout` - `host` - `invite_watchlist` - `location_preference` - `parking_lot` - `parking_stall` - `permission_bundle` - `person` - `physical_access_grant` - `physical_access_provider` - `physical_access_rule` - `security_badge_type` - `signin_watchlist` - `user_group_physical_access_rule` - `visitor` - `bulk_data_batch` ' schema: type: string in: query - name: action_type description: 'The action performed by the user. Valid values include: - `create` - `update` - `destroy` ' schema: type: string in: query - name: user_id description: The ID of the user who performed the database change schema: type: integer in: query responses: '200': content: application/json: schema: $ref: ./models/PaginatedAuditLogsList.v1.yaml examples: default: value: audit_logs: - id: 19 auditable_id: 85 auditable_type: some text user_id: 56 username: some text action: some text audited_changes: - field_name: result field_value_before: '{}' field_value_after: '{"external":[],"internal":[{"id":1,"email":"some@email.com","notes":null,"colour":"RED"}]}' format: json - field_name: user_id field_value_before: '1' field_value_after: '2' format: integer - field_name: flag_enabled field_value_after: 'true' format: boolean - field_name: email field_value_before: '' field_value_after: some@email.com format: string version: 64 comment: some text remote_address: some text request_uuid: some text created_at: some text - id: 4 auditable_id: 84 auditable_type: some text user_id: 78 username: some text action: some text audited_changes: - field_name: email field_value_before: '' field_value_after: another@email.com format: string version: 27 comment: some text remote_address: some text request_uuid: some text created_at: some text pagination: total_records: 44 current_offset: 71 next_offset: 27 description: Successful response - returns an array of `AuditLog` entities. '400': content: application/json: schema: $ref: ./models/ErrorsList.v1.yaml examples: default: value: errors: - domain: some text attribute: some text code: some text message: some text - domain: some text attribute: some text code: some text message: some text description: A generic error '401': description: You don't have permission to view this AuditLog '403': description: You do not have permission for this action operationId: getAuditLogs summary: List all AuditLogs description: Gets a list of all `AuditLog` entities. /audit_logs/{audit_log_id}: summary: Path used to manage a single AuditLog. description: The REST endpoint/path used to get single instances of an `AuditLog`. parameters: - schema: type: string name: audit_log_id in: path required: true get: tags: - Audit Logs responses: '200': content: application/json: schema: $ref: ./models/AuditLog.v1.yaml examples: default: value: id: 90 auditable_id: 49 auditable_type: some text user_id: 72 username: some text action: some text audited_changes: - field_name: result field_value_before: '{}' field_value_after: '{"external":[],"internal":[{"id":1,"email":"some@email.com","notes":null,"colour":"RED"}]}' format: json - field_name: user_id field_value_before: '1' field_value_after: '2' format: integer - field_name: flag_enabled field_value_after: 'true' format: boolean - field_name: email field_value_before: '' field_value_after: some@email.com format: string version: 66 comment: some text remote_address: some text request_uuid: some text created_at: some text description: Successful response - returns a single `AuditLog`. '400': description: A generic error content: application/json: schema: $ref: ./models/ErrorsList.v1.yaml '401': description: You don't have permission to view this AuditLog '403': description: You do not have permission for this action '404': description: The AuditLog does not exist operationId: getAuditLog summary: Get an AuditLog description: Gets the details of a single instance of an `AuditLog`. components: securitySchemes: TractionGuestAuth: openIdConnectUrl: https://us.tractionguest.com/.well-known/openid-configuration type: openIdConnect