iGRPIGRP 3.0Documentation

Sessões

Sessão do utilizador e administração de sessões (terminar, forçar nova autenticação).

Sessão atual

GET
/api/session

Sessão ativa do utilizador autenticado.

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

Session found

*/*
  1. response
sessionId?string
Formatouuid
status?string
Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
startedAt?string
Formatodate-time
lastSeenAt?string
Formatodate-time
expiresAt?string
Formatodate-time
endedAt?string
Formatodate-time
closedReason?string
closedBy?string
clientIp?string
deviceId?string
userProfile?
currentActiveRole?
roles?array<>
departments?array<>
active?boolean
expired?boolean
remainingSeconds?integer
Formatoint64
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/session'
{  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",  "status": "ACTIVE",  "startedAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "closedReason": "string",  "closedBy": "string",  "clientIp": "string",  "deviceId": "string",  "userProfile": {    "id": "string",    "name": "string",    "username": "string",    "email": "user@example.com",    "status": "ACTIVE",    "picture": "string",    "signature": "string",    "nic": "string",    "phoneNumber": "string",    "emailVerified": true,    "metadata": {      "property1": null,      "property2": null    }  },  "currentActiveRole": {    "roleCode": "string",    "departmentCode": "string"  },  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ],  "departments": [    {      "code": "string",      "description": "string"    }  ],  "active": true,  "expired": true,  "remainingSeconds": 0}

Validar a sessão

GET
/api/session/check

Estado combinado do JWT e da sessão no servidor. Responde mesmo a um token de sessão revogada, com valid=false e o motivo, em vez de 401.

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

Session check result

*/*
  1. response
valid?boolean
sid?string
Formatouuid
sub?string
expiresAt?string
Formatodate-time
lastSeenAt?string
Formatodate-time
idleTimeoutAt?string
Formatodate-time
absoluteExpiryAt?string
Formatodate-time
reason?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/session/check'
{  "valid": true,  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",  "sub": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "idleTimeoutAt": "2019-08-24T14:15:22Z",  "absoluteExpiryAt": "2019-08-24T14:15:22Z",  "reason": "string"}

Prolongar a sessão

POST
/api/session/refresh

Estende a expiração da sessão ativa.

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 do pedido

application/json
  1. body
extensionSeconds?integer
Formatoint32
Intervalo60 <= value <= 7200

Corpo da resposta

Session refreshed successfully

*/*
  1. response
sessionId?string
Formatouuid
status?string
Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
startedAt?string
Formatodate-time
lastSeenAt?string
Formatodate-time
expiresAt?string
Formatodate-time
endedAt?string
Formatodate-time
closedReason?string
closedBy?string
clientIp?string
deviceId?string
userProfile?
currentActiveRole?
roles?array<>
departments?array<>
active?boolean
expired?boolean
remainingSeconds?integer
Formatoint64
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/session/refresh' \  -H 'Content-Type: application/json' \  -d '{}'
{  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",  "status": "ACTIVE",  "startedAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "closedReason": "string",  "closedBy": "string",  "clientIp": "string",  "deviceId": "string",  "userProfile": {    "id": "string",    "name": "string",    "username": "string",    "email": "user@example.com",    "status": "ACTIVE",    "picture": "string",    "signature": "string",    "nic": "string",    "phoneNumber": "string",    "emailVerified": true,    "metadata": {      "property1": null,      "property2": null    }  },  "currentActiveRole": {    "roleCode": "string",    "departmentCode": "string"  },  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ],  "departments": [    {      "code": "string",      "description": "string"    }  ],  "active": true,  "expired": true,  "remainingSeconds": 0}

Rodar a sessão

POST
/api/session/rotate

Fecha a sessão atual e cria outra (proteção contra session fixation).

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 do pedido

application/json
  1. body
clientIp?string
Comprimento0 <= length <= 45
deviceId?string
Comprimento0 <= length <= 128
userAgent?string
Comprimento0 <= length <= 512

Corpo da resposta

Session rotated successfully

*/*
  1. response
sessionId?string
Formatouuid
status?string
Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
startedAt?string
Formatodate-time
lastSeenAt?string
Formatodate-time
expiresAt?string
Formatodate-time
endedAt?string
Formatodate-time
closedReason?string
closedBy?string
clientIp?string
deviceId?string
userProfile?
currentActiveRole?
roles?array<>
departments?array<>
active?boolean
expired?boolean
remainingSeconds?integer
Formatoint64
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/session/rotate' \  -H 'Content-Type: application/json' \  -d '{}'
{  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",  "status": "ACTIVE",  "startedAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "closedReason": "string",  "closedBy": "string",  "clientIp": "string",  "deviceId": "string",  "userProfile": {    "id": "string",    "name": "string",    "username": "string",    "email": "user@example.com",    "status": "ACTIVE",    "picture": "string",    "signature": "string",    "nic": "string",    "phoneNumber": "string",    "emailVerified": true,    "metadata": {      "property1": null,      "property2": null    }  },  "currentActiveRole": {    "roleCode": "string",    "departmentCode": "string"  },  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ],  "departments": [    {      "code": "string",      "description": "string"    }  ],  "active": true,  "expired": true,  "remainingSeconds": 0}

Listar sessões

GET
/api/admin/sessions

Filtro opcional por estado e paginação.

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

status?string

Session status filter

Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
page?integer

Page number (0-based)

Formatoint32
Predefinido0
size?integer

Page size

Formatoint32
Predefinido20

Corpo da resposta

Sessions retrieved successfully

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<unknown>
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/admin/sessions'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    null  ],  "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}

Estatísticas de sessões

GET
/api/admin/sessions/statistics

Sessões atuais e operações de invalidação.

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

Statistics retrieved successfully

*/*
  1. response
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/sessions/statistics'
{}

Sessão ativa de um utilizador

GET
/api/admin/sessions/users/{userId}

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 caminho

userId*string

User id

Corpo da resposta

Session found

*/*
  1. response
sessionId?string
Formatouuid
status?string
Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
startedAt?string
Formatodate-time
lastSeenAt?string
Formatodate-time
expiresAt?string
Formatodate-time
endedAt?string
Formatodate-time
closedReason?string
closedBy?string
clientIp?string
deviceId?string
userProfile?
currentActiveRole?
roles?array<>
departments?array<>
active?boolean
expired?boolean
remainingSeconds?integer
Formatoint64
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/sessions/users/string'
{  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",  "status": "ACTIVE",  "startedAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "closedReason": "string",  "closedBy": "string",  "clientIp": "string",  "deviceId": "string",  "userProfile": {    "id": "string",    "name": "string",    "username": "string",    "email": "user@example.com",    "status": "ACTIVE",    "picture": "string",    "signature": "string",    "nic": "string",    "phoneNumber": "string",    "emailVerified": true,    "metadata": {      "property1": null,      "property2": null    }  },  "currentActiveRole": {    "roleCode": "string",    "departmentCode": "string"  },  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ],  "departments": [    {      "code": "string",      "description": "string"    }  ],  "active": true,  "expired": true,  "remainingSeconds": 0}

Sessões de um perfil

GET
/api/admin/sessions/roles/{roleCode}

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 caminho

roleCode*string

Role code

Parâmetros de query

departmentCode?string

Department code (optional)

status?string

Session status filter

Valor em"ACTIVE""CLOSED""EXPIRED""REVOKED"
page?integer

Page number (0-based)

Formatoint32
Predefinido0
size?integer

Page size

Formatoint32
Predefinido20

Corpo da resposta

Sessions retrieved successfully

*/*
  1. response
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
size?integer
Formatoint32
content?array<unknown>
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/admin/sessions/roles/string'
{  "totalElements": 0,  "totalPages": 0,  "size": 0,  "content": [    null  ],  "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}

Terminar sessão

POST
/api/admin/sessions/{sessionId}/kill

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 caminho

sessionId*string

Session ID

Formatouuid

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Session killed successfully

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/kill' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio

Terminar sessões de um perfil

POST
/api/admin/sessions/roles/{roleCode}/kill

Termina as sessões ativas dos utilizadores com esse perfil.

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 caminho

roleCode*string

Role code

Parâmetros de query

departmentCode?string

Department code (role codes are department-scoped)

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Sessions killed successfully

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/sessions/roles/string/kill' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio
POST
/api/admin/sessions/departments/{departmentCode}/kill

Termina as sessões ativas dos utilizadores desse departamento.

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 caminho

departmentCode*string

Department code

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Sessions killed successfully

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/sessions/departments/string/kill' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio
POST
/api/admin/users/{userExternalId}/sessions/{sessionId}/kill

Só termina a sessão se pertencer ao utilizador; caso contrário responde 404.

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 caminho

userExternalId*string

User external id

sessionId*string

Session id (UUID)

Formatouuid

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Session killed

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/users/string/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/kill' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio
POST
/api/admin/users/{userExternalId}/logout-all

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 caminho

userExternalId*string

User external id

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Sessions revoked

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/users/string/logout-all' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio

Forçar nova autenticação

POST
/api/admin/users/{userExternalId}/force-reauth

Invalida todos os tokens emitidos até agora (incluindo os que estão em uso) e revoga as sessões ativas. Para usar, por exemplo, depois de uma reposição de palavra-passe.

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 caminho

userExternalId*string

User external id

Corpo do pedido

application/json
  1. body
reason*string
Comprimento0 <= length <= 255
killedBy?string
Comprimento0 <= length <= 100

Corpo da resposta

Re-auth enforced

curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/admin/users/string/force-reauth' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Vazio
How is this guide?

Última atualização: