iGRPIGRP 3.0Documentation

Auditoria

Eventos de segurança e relatórios de acessos, auditoria e configuração.

Listar eventos de auditoria

GET
/api/auth/audit

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

userId?string
username?string
eventType?string
category?string
ipAddress?string
startDate?string
Formatodate-time
endDate?string
Formatodate-time
pageable*

Corpo da resposta

OK

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<>
number?integer
Formatoint32
first?boolean
last?boolean
sort?
pageable?
numberOfElements?integer
Formatoint32
empty?boolean
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/audit?page=0&size=1&sort=string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    {      "id": "string",      "sequenceNumber": 0,      "previousHash": "string",      "currentHash": "string",      "userId": "string",      "username": "string",      "sessionId": "string",      "ipAddress": "string",      "userAgent": "string",      "correlationId": "string",      "requestPath": "string",      "decisionReason": "string",      "eventType": "string",      "category": "string",      "contextData": "string",      "timestamp": "string"    }  ],  "number": 0,  "first": true,  "last": true,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "pageable": {    "offset": 0,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "paged": true,    "pageNumber": 0,    "pageSize": 0,    "unpaged": true  },  "numberOfElements": 0,  "empty": true}

Validar a cadeia de auditoria

POST
/api/auth/audit/validate

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Corpo da resposta

OK

*/*
  1. response
[key: string]?unknown
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/audit/validate'
{  "property1": null,  "property2": null}

Apagar eventos de auditoria antigos

DELETE
/api/auth/audit/purge

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Corpo da resposta

OK

*/*
  1. response
[key: string]?unknown
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/audit/purge'
{  "property1": null,  "property2": null}

Relatório de acessos

GET
/api/auth/reports/access

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
role?string
module?string
action?string
status?string
pageable*

Corpo da resposta

OK

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<>
number?integer
Formatoint32
first?boolean
last?boolean
sort?
pageable?
numberOfElements?integer
Formatoint32
empty?boolean
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/access?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&page=0&size=1&sort=string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    {      "timestamp": "2019-08-24T14:15:22Z",      "username": "string",      "role": "string",      "module": "string",      "action": "string",      "ipAddress": "string",      "status": "SUCCESS"    }  ],  "number": 0,  "first": true,  "last": true,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "pageable": {    "offset": 0,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "paged": true,    "pageNumber": 0,    "pageSize": 0,    "unpaged": true  },  "numberOfElements": 0,  "empty": true}

Relatório de acessos (CSV)

GET
/api/auth/reports/access.csv

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
role?string
module?string
action?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/access.csv?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de acessos (PDF)

GET
/api/auth/reports/access.pdf

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
role?string
module?string
action?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/access.pdf?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de acessos (XLSX)

GET
/api/auth/reports/access.xlsx

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
role?string
module?string
action?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/access.xlsx?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Arquivar relatório de acessos

POST
/api/auth/reports/access/archive

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

format*string
Valor em"PDF""XLSX""CSV"
startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
role?string
module?string
action?string
status?string

Corpo da resposta

OK

*/*
  1. response
id?string
reportType?string
Valor em"AUDIT""ACCESS""SETTINGS"
format?string
Valor em"PDF""XLSX""CSV"
filePath?string
fileName?string
contentType?string
sizeBytes?integer
Formatoint64
rowCount?integer
Formatoint64
filters?string
periodStart?string
Formatodate-time
periodEnd?string
Formatodate-time
generatedBy?string
generatedAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/access/archive?format=PDF&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
{  "id": "string",  "reportType": "AUDIT",  "format": "PDF",  "filePath": "string",  "fileName": "string",  "contentType": "string",  "sizeBytes": 0,  "rowCount": 0,  "filters": "string",  "periodStart": "2019-08-24T14:15:22Z",  "periodEnd": "2019-08-24T14:15:22Z",  "generatedBy": "string",  "generatedAt": "2019-08-24T14:15:22Z"}

Relatório de auditoria

GET
/api/auth/reports/audit

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
module?string
accessRole?string
operationState?string
authorizedBy?string
status?string
pageable*

Corpo da resposta

OK

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<>
number?integer
Formatoint32
first?boolean
last?boolean
sort?
pageable?
numberOfElements?integer
Formatoint32
empty?boolean
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/audit?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&page=0&size=1&sort=string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    {      "id": "string",      "startDate": "2019-08-24T14:15:22Z",      "endDate": "2019-08-24T14:15:22Z",      "username": "string",      "module": "string",      "accessRole": "string",      "operationState": "string",      "ipAddress": "string",      "device": "string",      "authorizedBy": "string",      "status": "SUCCESS"    }  ],  "number": 0,  "first": true,  "last": true,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "pageable": {    "offset": 0,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "paged": true,    "pageNumber": 0,    "pageSize": 0,    "unpaged": true  },  "numberOfElements": 0,  "empty": true}

Relatório de auditoria (CSV)

GET
/api/auth/reports/audit.csv

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
module?string
accessRole?string
operationState?string
authorizedBy?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/audit.csv?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de auditoria (PDF)

GET
/api/auth/reports/audit.pdf

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
module?string
accessRole?string
operationState?string
authorizedBy?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/audit.pdf?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de auditoria (XLSX)

GET
/api/auth/reports/audit.xlsx

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
module?string
accessRole?string
operationState?string
authorizedBy?string
status?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/audit.xlsx?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Arquivar relatório de auditoria

POST
/api/auth/reports/audit/archive

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

format*string
Valor em"PDF""XLSX""CSV"
startDate*string
Formatodate-time
endDate*string
Formatodate-time
username?string
module?string
accessRole?string
operationState?string
authorizedBy?string
status?string

Corpo da resposta

OK

*/*
  1. response
id?string
reportType?string
Valor em"AUDIT""ACCESS""SETTINGS"
format?string
Valor em"PDF""XLSX""CSV"
filePath?string
fileName?string
contentType?string
sizeBytes?integer
Formatoint64
rowCount?integer
Formatoint64
filters?string
periodStart?string
Formatodate-time
periodEnd?string
Formatodate-time
generatedBy?string
generatedAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/audit/archive?format=PDF&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
{  "id": "string",  "reportType": "AUDIT",  "format": "PDF",  "filePath": "string",  "fileName": "string",  "contentType": "string",  "sizeBytes": 0,  "rowCount": 0,  "filters": "string",  "periodStart": "2019-08-24T14:15:22Z",  "periodEnd": "2019-08-24T14:15:22Z",  "generatedBy": "string",  "generatedAt": "2019-08-24T14:15:22Z"}

Relatório de configuração

GET
/api/auth/reports/settings

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
performedBy?string
area?string
entityType?string
operation?string
entityName?string
pageable*

Corpo da resposta

OK

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<>
number?integer
Formatoint32
first?boolean
last?boolean
sort?
pageable?
numberOfElements?integer
Formatoint32
empty?boolean
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/settings?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&page=0&size=1&sort=string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    {      "timestamp": "2019-08-24T14:15:22Z",      "performedBy": "string",      "area": "APPLICATIONS",      "entityType": "APPLICATION",      "operation": "CREATE",      "entityName": "string",      "relatedEntity": "string",      "previousValue": "string",      "newValue": "string",      "ipAddress": "string",      "status": "SUCCESS"    }  ],  "number": 0,  "first": true,  "last": true,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "pageable": {    "offset": 0,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "paged": true,    "pageNumber": 0,    "pageSize": 0,    "unpaged": true  },  "numberOfElements": 0,  "empty": true}

Relatório de configuração (CSV)

GET
/api/auth/reports/settings.csv

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
performedBy?string
area?string
entityType?string
operation?string
entityName?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/settings.csv?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de configuração (PDF)

GET
/api/auth/reports/settings.pdf

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
performedBy?string
area?string
entityType?string
operation?string
entityName?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/settings.pdf?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Relatório de configuração (XLSX)

GET
/api/auth/reports/settings.xlsx

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

startDate*string
Formatodate-time
endDate*string
Formatodate-time
performedBy?string
area?string
entityType?string
operation?string
entityName?string

Corpo da resposta

OK

response?StreamingResponseBody*/*
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/settings.xlsx?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
null

Arquivar relatório de configuração

POST
/api/auth/reports/settings/archive

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

format*string
Valor em"PDF""XLSX""CSV"
startDate*string
Formatodate-time
endDate*string
Formatodate-time
performedBy?string
area?string
entityType?string
operation?string
entityName?string

Corpo da resposta

OK

*/*
  1. response
id?string
reportType?string
Valor em"AUDIT""ACCESS""SETTINGS"
format?string
Valor em"PDF""XLSX""CSV"
filePath?string
fileName?string
contentType?string
sizeBytes?integer
Formatoint64
rowCount?integer
Formatoint64
filters?string
periodStart?string
Formatodate-time
periodEnd?string
Formatodate-time
generatedBy?string
generatedAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/settings/archive?format=PDF&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z'
{  "id": "string",  "reportType": "AUDIT",  "format": "PDF",  "filePath": "string",  "fileName": "string",  "contentType": "string",  "sizeBytes": 0,  "rowCount": 0,  "filters": "string",  "periodStart": "2019-08-24T14:15:22Z",  "periodEnd": "2019-08-24T14:15:22Z",  "generatedBy": "string",  "generatedAt": "2019-08-24T14:15:22Z"}

Listar relatórios arquivados

GET
/api/auth/reports/archives

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT emitido pelo Access Management. Leva as permissões do perfil ativo em permissions e o departamento dele em org — ver o modelo de controlo de acesso.

Parâmetros de query

reportType?string
format?string
generatedBy?string
pageable*

Corpo da resposta

OK

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<>
number?integer
Formatoint32
first?boolean
last?boolean
sort?
pageable?
numberOfElements?integer
Formatoint32
empty?boolean
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/auth/reports/archives?page=0&size=1&sort=string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    {      "id": "string",      "reportType": "AUDIT",      "format": "PDF",      "filePath": "string",      "fileName": "string",      "contentType": "string",      "sizeBytes": 0,      "rowCount": 0,      "filters": "string",      "periodStart": "2019-08-24T14:15:22Z",      "periodEnd": "2019-08-24T14:15:22Z",      "generatedBy": "string",      "generatedAt": "2019-08-24T14:15:22Z"    }  ],  "number": 0,  "first": true,  "last": true,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "pageable": {    "offset": 0,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "paged": true,    "pageNumber": 0,    "pageSize": 0,    "unpaged": true  },  "numberOfElements": 0,  "empty": true}
How is this guide?

Última atualização: