iGRPIGRP 3.0Documentation

M2M

Sincronização no arranque dos backends e consultas entre serviços.

Sincronizar aplicações

POST
/api/m2m/sync/applications

Chamado pelos backends no arranque (token client_credentials).

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
id?integer
Formatoint32
code*string
Padrão^[A-Za-z0-9_-]+$
Comprimento1 <= length
name*string
Comprimento0 <= length <= 255
description?string
Comprimento0 <= length <= 255
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
type*string
Valor em"EXTERNAL""INTERNAL""SYSTEM"
owner?string
Comprimento0 <= length <= 255
picture?string
Comprimento0 <= length <= 255
url?string
Formatouri
slug?string
Comprimento0 <= length <= 255
createdBy?string
createdDate?string
lastModifiedBy?string
lastModifiedDate?string
lastAccess?string
Formatodate-time
departments?array<string>

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/sync/applications' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "string",  "type": "EXTERNAL"}'
"string"
POST
/api/m2m/sync/applications/{code}/menus

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

code*string

Parâmetros de query

syncRoles?boolean
Predefinidotrue

Corpo do pedido

application/json
  1. body
[index: integer]?

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/sync/applications/string/menus' \  -H 'Content-Type: application/json' \  -d '[  {    "name": "string"  }]'
"string"

Sincronizar recursos

POST
/api/m2m/sync/resources

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
id?integer
Formatoint32
name*string
Comprimento0 <= length <= 255
description?string
type*string
Valor em"API""UI""PROCESS"
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
applications?array<string>
items?array<>
externalId?string
Comprimento0 <= length <= 255
createdBy?string
createdDate?string
lastModifiedBy?string
lastModifiedDate?string
permissions?array<string>

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/sync/resources' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "type": "API"}'
"string"

Sincronizar permissões

POST
/api/m2m/sync/permissions

Publica as permissões declaradas com @IgrpPermission.

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
[index: integer]?

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/sync/permissions' \  -H 'Content-Type: application/json' \  -d '[  {    "name": "string"  }]'
"string"

Consultar utilizadores

POST
/api/m2m/users

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

activeOnly?boolean
applicationCode?string
departmentCode?string
roleCode?string
permissionName?string
includeChildrenDepartments?boolean
includeChildrenRoles?boolean

Corpo do pedido

application/json
  1. body
[index: integer]?string

Corpo da resposta

OK

application/json
  1. response
id?string
name?string
username?string
email*string
Formatoemail
Comprimento1 <= length
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
picture?string
signature?string
nic?string
Comprimento0 <= length <= 13
phoneNumber?string
Padrão^\+[1-9]\d{1,14}$
emailVerified?boolean
metadata?
externalId?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/users' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
{  "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  },  "externalId": "string"}

Consultar departamentos

POST
/api/m2m/departments

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

activeOnly?boolean
parentCode?string
includeChildrenDepartments?boolean

Corpo do pedido

application/json
  1. body
[index: integer]?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
code*string
Padrão^[A-Za-z0-9_-]+$
Comprimento1 <= length
name*string
Comprimento1 <= length
description?string
status?string
Valor em"ACTIVE""INACTIVE""DELETED"
icon?string
parentCode?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/departments' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Consultar perfis

POST
/api/m2m/roles

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

activeOnly?boolean
parentCode?string
includeChildrenRoles?boolean

Corpo do pedido

application/json
  1. body
[index: integer]?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
code*string
Padrão^[A-Za-z0-9_.-]+$
Comprimento0 <= length <= 255
name*string
Comprimento1 <= length
description?string
Comprimento0 <= length <= 255
departmentCode?string
parentCode?string
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
icon?string
expiresAt?string
Formatodate-time
permissions?array<string>
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/m2m/roles' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "departmentCode": "string",  "parentCode": "string",  "status": "ACTIVE",  "icon": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "permissions": [    "string"  ]}
How is this guide?

Última atualização: