Plataform (platform)

lgpd

86 views 06/01/2020 02/10/2020 integrador 0

2.0info: 3.7.1 lgpd description: Permite gerenciar os dados sensíveis dos usuários para a Lei Geral de Proteção de Dados x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: lgpd contact: name: Senior X Platform url: http://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: /lgpd/queries/getFields: post: description: Obtém os campos sensíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/sensitiveField minimum: 1 description: Campos sensíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os campos sensíveis tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/sensitiveField minimum: 1 description: Campos sensíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getAllRequests: post: description: Obtém todos os dossiês do usuário gerado no tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: status: type: string allOf: – #/definitions/processStatus description: Filtro searchTerm: type: object allOf: – #/definitions/searchTerm description: Termo de pesquisa para dmininuir a abragência na listagem dos dossiês pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação. Não definido retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – requests – listInformation properties: requests: type: array items: type: object allOf: – #/definitions/requestData minimum: 1 description: Dados da requisição: dossiê ou deleção de informações listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o resultado da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/listRequests: post: description: Lista as requisições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: requestType: type: string allOf: – #/definitions/requestType description: Tipo da requisição status: type: string allOf: – #/definitions/requestStatus description: Filtro por status da requisição searchTerm: type: object allOf: – #/definitions/searchTerm description: Termo de pesquisa para diminuir a abrangência na listagem dos dossiês pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação. Não definido retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – requests – listInformation properties: requests: type: array items: type: object allOf: – #/definitions/requestData minimum: 1 description: Dados da requisição: dossiê ou deleção de informações listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o resultado da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getDossier: post: description: Obtém o dossiê do usuário gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket de consulta do dossiê responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/consolidatedDossierData minimum: 1 description: Dados do Dossiê status: type: string allOf: – #/definitions/requestStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o dossiê do usuário gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket de consulta do dossiê in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/consolidatedDossierData minimum: 1 description: Dados do Dossiê status: type: string allOf: – #/definitions/requestStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getRequest: post: description: Obtém dados de uma requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket de consulta do dossiê responses: 200: description: Ok schema: type: object allOf: – #/definitions/completeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém dados de uma requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket de consulta do dossiê in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/completeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getRemovalStatus: post: description: Pesquisa pelo status do andamento da remoção dos dados sensíveis do dossiê tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket da solicitação de remoção responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/dossierData minimum: 1 description: Dados do Dossê status: type: string allOf: – #/definitions/processStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa pelo status do andamento da remoção dos dados sensíveis do dossiê tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket da solicitação de remoção in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/dossierData minimum: 1 description: Dados do Dossê status: type: string allOf: – #/definitions/processStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/exportDossier: post: description: Exportar Dossiê para PDF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Identificador da requisição responses: 200: description: Ok schema: type: object required: – pdf properties: pdf: type: string format: byte description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Exportar Dossiê para PDF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Identificador da requisição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – pdf properties: pdf: type: string format: byte description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/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 /lgpd/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /lgpd/actions/registerSensitiveData: post: description: Registra produto e os campos sensíveis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/sensitiveFieldData minimum: 1 description: Nome e descrição dos campos sensíveis. Ex.: (CONVICCAO_RELIGIOSA, Convicção Religiosa); (CPF, CPF); (BIOMETRIA, Biometria)… responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou não do registro dos dados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerSensitiveData__2: post: description: Registra produto e os campos sensíveis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/createSensitiveField minimum: 1 description: Nome e descrição dos campos sensíveis. Ex.: (CONVICCAO_RELIGIOSA, Convicção Religiosa); (CPF, CPF); (BIOMETRIA, Biometria)… service: type: object allOf: – #/definitions/serviceData description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/requestDossier: post: description: Solicita dossiê, lançando o evento dossierRequested com os dados do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – fields properties: filter: type: object allOf: – #/definitions/personData description: Filtro dos campos fields: type: array items: type: string minimum: 1 description: Campos sensíveis solicitados responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Retorna ticket para consulta do dossiê 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerDossier: post: description: Registra o dossiê do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket – dossier properties: ticket: type: string description: Identificador da requisição dossiê dossier: type: object allOf: – #/definitions/dossierData description: Dados do Dossiê responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou não do registro dos dados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/requestDeleteInformation: post: description: Solicita a remoção de informações, lançando o evento deleteInformationRequested com os dados a serem deletados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket – fields properties: ticket: type: string description: Identificador da requisição dossiê fields: type: array items: type: string minimum: 1 description: Campos sensíveis solicitados responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Retorna ticket da consulta de remoção de campos do dossiê 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerDeletedInformation: post: description: Registra as informações que foram deletas do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket – dossier properties: ticket: type: string description: Identificador da requisição dossier: type: object allOf: – #/definitions/dossierData description: Dados do Dossiê responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou não do registro de remoção dos dados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: requestType: description: Enum que identifica o Tipo de Requisição type: string enum: – DOSSIER – DELETE_INFORMATION processStatus: description: Enum que identifica o Status de Processamento type: string enum: – WAITING – PROCESSING – TIMEOUT – DONE – DONE_WITH_TIMEOUT – DONE_WITHOUT_INFORMATION requestStatus: description: Enum que identifica o status da requisição type: string enum: – PROCESSING – DONE – DONE_WITH_TIMEOUT deleteStatus: description: Enum que identifica o Status da Remoção de Informações type: string enum: – DELETED – NOT_FOUND userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT completeRequest: description: type: object required: – ticket – createdAt – requestType – status – filter – data properties: ticket: type: string description: Ticket createdAt: type: string format: date-time description: Data da requisição requestType: type: string allOf: – #/definitions/requestType description: Tipo da requisição status: type: string allOf: – #/definitions/requestStatus description: Status filter: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Filtro dos campos data: type: array items: type: object allOf: – #/definitions/requestField minimum: 1 description: Dados retornados da requisição child: type: array items: type: object allOf: – #/definitions/requestData description: Se o tipo for DOSSIER, então pode haver requisições de delação filhas requestField: description: type: object required: – field – fieldInformation properties: field: type: object allOf: – #/definitions/sensitiveFieldData description: Campo sensível fieldInformation: type: array items: type: object allOf: – #/definitions/requestFieldInformation minimum: 1 description: Informações encontradas/aplicadas sobre os campos requestFieldInformation: description: type: object required: – owner – value properties: owner: type: object allOf: – #/definitions/ownerService description: Produto que possui as informações sensíveis value: type: string description: Valor deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Identifica o status de exclusão do campo informado processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso where: type: string description: Onde é utilizado complement: type: string description: Porque esse campo é importante consolidatedDossierData: description: Dados que identifica o dossiê consolidado type: object required: – field – informations properties: field: type: object allOf: – #/definitions/sensitiveFieldData description: Campo sensível informations: type: array items: type: object allOf: – #/definitions/consolidatedInformationData minimum: 1 description: Informações coletadas por serviço consolidatedInformationData: description: Dados que identifica as informações por produto type: object required: – owner – value properties: owner: type: object allOf: – #/definitions/ownerService description: Produto que possui as informações sensíveis value: type: string description: Valor deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Identifica o status de exclusão do campo informado processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso dossierData: description: Dados que identifica a requisição type: object required: – owner properties: owner: type: object allOf: – #/definitions/serviceData description: Produto que possui as informações sensíveis informations: type: array items: type: object allOf: – #/definitions/informationData description: Informações sensíveis processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso informationData: description: Dado que identifica a informação sensível type: object required: – field – whereUsed properties: field: type: object allOf: – #/definitions/fieldData description: Campo. Por exemplo: CPF whereUsed: type: string description: Onde é utilizado complement: type: string description: Porque esse campo é importante deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Status de remoção serviceData: description: Dado que identifica o serviço type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio serviceName: type: string description: Nome do Serviço fieldData: description: Estrutura do campo utilizado no filtro de dados sensíveis type: object required: – name – value properties: name: type: string description: Nome do campo value: type: string description: Valor do campo requestData: description: Dado que identifica a requisição type: object required: – ticket – createdAt – requestType – status – filter properties: ticket: type: string description: Ticket createdAt: type: string format: date-time description: Data da requisição requestType: type: string allOf: – #/definitions/requestType description: Data da requisição status: type: string allOf: – #/definitions/requestStatus description: Status filter: type: object allOf: – #/definitions/personData description: Filtro dos campos filterData: description: Estrutura do campo utilizado no filtro de pesquisa do getAllDossiers type: object properties: status: type: string allOf: – #/definitions/processStatus description: Status personData: description: Campos usados na identificação da pessoa type: object properties: fields: type: array items: type: object allOf: – #/definitions/fieldData description: Campos que podem representar: CPF, RG, PIS, Passaporte, CRM e outros sensitiveFieldData: description: Dados que identifica um campo sensível type: object required: – name – description properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo createSensitiveField: description: type: object required: – name – description properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo fiscal: type: boolean description: Indica se o campo sensível faz parte de uma informação fiscal default: false sensitiveField: description: Dados para retonar um campo sensível com uma lista de serviços que classifica este campo como fiscal type: object required: – name – description – sensitiveFieldServices properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo sensitiveFieldServices: type: array items: type: object allOf: – #/definitions/ownerService minimum: 1 description: Serviços que utilizam o campo sensível registrado ownerService: description: Serviço proprietário do campo, com a definição se o campo sensível faz parte de uma obrigação legal (exemplo: informações fiscais que não podem ser apagadas) type: object required: – domainName – serviceName – fiscal properties: domainName: type: string description: Domínio do serviço serviceName: type: string description: Nome do serviço fiscal: type: boolean description: Define se campo faz parte de uma obrigação legal (informações fiscais) searchTerm: description: type: object required: – fieldNames – searchValue properties: fieldNames: type: array items: type: string minimum: 1 description: Nome do campo que será utilizado no filtro searchValue: type: string description: Valor do campo informado no filtro pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira pagina corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As infomações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de paginas encontradas 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment