audit

2.0info: 1.0.0 audit description: Serviço x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: audit contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /audit/queries/listAuditableServices: post: description: Lista os serviços auditáveis com base no nome do domínio ou do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainOrServiceName properties: domainOrServiceName: type: string description: Filtro aplicado ao nome do domínio ou do serviço responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/auditableServiceDTO minimum: 1 description: Lista de serviços auditáveis encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os serviços auditáveis com base no nome do domínio ou do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainOrServiceName description: Filtro aplicado ao nome do domínio ou do serviço in: query required: true type: string responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/auditableServiceDTO minimum: 1 description: Lista de serviços auditáveis encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit/queries/listAuditableEntities: post: description: Lista as entidades auditáveis de um serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço responses: 200: description: Ok schema: type: object required: – entityAuditable properties: entityAuditable: type: array items: type: object allOf: – #/definitions/entityAuditableDTO minimum: 1 description: Lista de entidades auditáveis vinculadas ao serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as entidades auditáveis de um serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do domínio in: query required: true type: string – name: serviceName description: Nome do serviço in: query required: true type: string responses: 200: description: Ok schema: type: object required: – entityAuditable properties: entityAuditable: type: array items: type: object allOf: – #/definitions/entityAuditableDTO minimum: 1 description: Lista de entidades auditáveis vinculadas ao serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit/queries/listAuditLogs: post: description: Lista os logs de auditoria conforme os filtros informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: primary: type: string description: ID do registro auditado entityName: type: string description: Nome da entidade domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço op: type: string description: Tipo de operação term: type: string description: Termo de busca startDate: type: string description: Data inicial finalDate: type: string description: Data final page: type: integer format: int64 description: Número da página solicitada pageSize: type: integer format: int64 description: Número de registros por página responses: 200: description: Ok schema: type: object required: – logs – listInformation properties: logs: type: array items: type: object allOf: – #/definitions/auditLogDTO minimum: 1 description: Lista de registros de auditoria listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os logs de auditoria conforme os filtros informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: primary description: ID do registro auditado in: query type: string – name: entityName description: Nome da entidade in: query type: string – name: domainName description: Nome do domínio in: query type: string – name: serviceName description: Nome do serviço in: query type: string – name: op description: Tipo de operação in: query type: string – name: term description: Termo de busca in: query type: string – name: startDate description: Data inicial in: query type: string – name: finalDate description: Data final in: query type: string – name: page description: Número da página solicitada in: query type: integer format: int64 – name: pageSize description: Número de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – logs – listInformation properties: logs: type: array items: type: object allOf: – #/definitions/auditLogDTO minimum: 1 description: Lista de registros de auditoria listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Disponível * `DOWN` – Indisponível userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text auditableServiceDTO: description: type: object required: – id – domainName – serviceName – flex – entityAuditable properties: id: type: string description: ID do serviço auditável domainName: type: string description: Nome do domínio domainLabel: type: string description: Rótulo do domínio serviceName: type: string description: Nome do serviço serviceLabel: type: string description: Rótulo do serviço flex: type: boolean description: Indica se o serviço é da Flex entityAuditable: type: array items: type: object allOf: – #/definitions/entityAuditableDTO minimum: 1 description: Entidades auditáveis associadas ao serviço entityAuditableDTO: description: type: object required: – id – entityName properties: id: type: string description: ID da entidade auditável entityName: type: string description: Nome da entidade entityLabel: type: string description: Rótulo da entidade auditLogDTO: description: type: object required: – primary – entityName – domainName – serviceName – op – data – timestamp – user – expireAt properties: primary: type: string description: ID do registro auditado entityName: type: string description: Nome da entidade domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço op: type: string description: Tipo de operação data: type: string description: Conteúdo auditado timestamp: type: string description: Data da auditoria user: type: string description: Usuário responsável pela operação expireAt: type: string description: Data de expiração do log listInformation: description: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número total de elementos encontrados totalPages: type: integer format: int64 description: Número total de páginas disponíveis checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage