iGRPIGRP 3.0Documentation

Departamentos

Árvore de departamentos e as aplicações, menus, recursos e permissões disponíveis em cada um.

Listar departamentos

GET
/api/departments

Permissão: igrp.departments.list.

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

name?string
status?string
code?string
parentCode?string

Corpo da resposta

List of Departments

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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Criar departamento

POST
/api/departments

Permissão: igrp.departments.create.

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
Comprimento1 <= length
description?string
status?string
Valor em"ACTIVE""INACTIVE""DELETED"
icon?string
parentCode?string

Corpo da resposta

Created

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/departments' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "string"}'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Obter departamento por id

GET
/api/departments/{id}

Permissão: igrp.departments.view.

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

id*integer
Formatoint32

Corpo da resposta

Department Data

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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/0'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Obter departamento por código

GET
/api/departments/by-code/{code}

Permissão: igrp.departments.view.

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

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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/by-code/string'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Eliminar departamento

DELETE
/api/departments/{code}

Permissão: igrp.departments.delete.

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

Corpo da resposta

No Content

response?string*/*
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string'
"string"

Atualizar departamento

PUT
/api/departments/{code}

Permissão: igrp.departments.update.

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

Corpo do pedido

application/json
  1. body
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

Corpo da resposta

Updated Department

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 PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "string"}'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Aplicações do departamento

GET
/api/departments/{code}/applications

Permissão: igrp.departments.view.

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

applicationCode?string

Corpo da resposta

OK

application/json
  1. response
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>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "type": "EXTERNAL",  "owner": "string",  "picture": "string",  "url": "http://example.com",  "slug": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "lastAccess": "2019-08-24T14:15:22Z",  "departments": [    "string"  ]}
POST
/api/departments/{code}/applications

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

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

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
"string"
GET
/api/departments/{code}/applications/available

Permissão: igrp.departments.manage.

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

Corpo da resposta

OK

application/json
  1. response
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>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications/available'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "type": "EXTERNAL",  "owner": "string",  "picture": "string",  "url": "http://example.com",  "slug": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "lastAccess": "2019-08-24T14:15:22Z",  "departments": [    "string"  ]}
GET
/api/departments/{departmentCode}/applications/{applicationCode}/menus

Permissão: igrp.departments.view.

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
applicationCode*string

Parâmetros de query

menuCode?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
code?string
name*string
Comprimento0 <= length <= 255
type?string
Valor em"SYSTEM_PAGE""MENU_PAGE""EXTERNAL_PAGE""FOLDER""GROUP"
position?integer
Formatoint32
icon?string
Comprimento0 <= length <= 255
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
target?string
Comprimento0 <= length <= 50
url?string
Comprimento0 <= length <= 255
pageSlug?string
parentCode?string
applicationCode?string
createdBy?string
createdDate?string
lastModifiedBy?string
lastModifiedDate?string
roles?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications/string/menus'
{  "id": 0,  "code": "string",  "name": "string",  "type": "SYSTEM_PAGE",  "position": 0,  "icon": "string",  "status": "ACTIVE",  "target": "string",  "url": "string",  "pageSlug": "string",  "parentCode": "string",  "applicationCode": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ]}

Associar menus ao departamento

POST
/api/departments/{departmentCode}/applications/{applicationCode}/menus

Permissão: igrp.departments.manage.

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
applicationCode*string

Corpo do pedido

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

Corpo da resposta

No Content

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

Desassociar menus do departamento

DELETE
/api/departments/{departmentCode}/applications/{applicationCode}/menus

Permissão: igrp.departments.manage.

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
applicationCode*string

Corpo do pedido

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

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications/string/menus' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
"string"
GET
/api/departments/{departmentCode}/applications/{applicationCode}/menus/available

Permissão: igrp.departments.manage.

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
applicationCode*string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
code?string
name*string
Comprimento0 <= length <= 255
type?string
Valor em"SYSTEM_PAGE""MENU_PAGE""EXTERNAL_PAGE""FOLDER""GROUP"
position?integer
Formatoint32
icon?string
Comprimento0 <= length <= 255
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
target?string
Comprimento0 <= length <= 50
url?string
Comprimento0 <= length <= 255
pageSlug?string
parentCode?string
applicationCode?string
createdBy?string
createdDate?string
lastModifiedBy?string
lastModifiedDate?string
roles?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/applications/string/menus/available'
{  "id": 0,  "code": "string",  "name": "string",  "type": "SYSTEM_PAGE",  "position": 0,  "icon": "string",  "status": "ACTIVE",  "target": "string",  "url": "string",  "pageSlug": "string",  "parentCode": "string",  "applicationCode": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "roles": [    {      "roleCode": "string",      "departmentCode": "string"    }  ]}

Recursos do departamento

GET
/api/departments/{code}/resources

Permissão: igrp.departments.view.

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

resourceName?string

Corpo da resposta

OK

application/json
  1. response
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>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/resources'
{  "id": 0,  "name": "string",  "description": "string",  "type": "API",  "status": "ACTIVE",  "applications": [    "string"  ],  "items": [    {      "id": 0,      "name": "string",      "description": "string",      "url": "string",      "resourceName": "string",      "permissions": [        "string"      ],      "createdBy": "string",      "createdDate": "string",      "lastModifiedBy": "string",      "lastModifiedDate": "string"    }  ],  "externalId": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "permissions": [    "string"  ]}
GET
/api/departments/{code}/resources/available

Permissão: igrp.departments.manage.

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

Corpo da resposta

OK

application/json
  1. response
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>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/resources/available'
{  "id": 0,  "name": "string",  "description": "string",  "type": "API",  "status": "ACTIVE",  "applications": [    "string"  ],  "items": [    {      "id": 0,      "name": "string",      "description": "string",      "url": "string",      "resourceName": "string",      "permissions": [        "string"      ],      "createdBy": "string",      "createdDate": "string",      "lastModifiedBy": "string",      "lastModifiedDate": "string"    }  ],  "externalId": "string",  "createdBy": "string",  "createdDate": "string",  "lastModifiedBy": "string",  "lastModifiedDate": "string",  "permissions": [    "string"  ]}

Associar recursos ao departamento

POST
/api/departments/{departmentCode}/resources

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/resources' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
"string"
DELETE
/api/departments/{departmentCode}/resources

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/resources' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
"string"
GET
/api/departments/{code}/permissions

Permissão: igrp.departments.view.

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

permissionName?string
resourceName?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
name*string
Padrão^[A-Za-z0-9._-]+$
Comprimento0 <= length <= 255
description?string
Comprimento0 <= length <= 255
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
departments?array<string>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/permissions'
{  "id": 0,  "name": "string",  "description": "string",  "status": "ACTIVE",  "departments": [    "string"  ]}
POST
/api/departments/{code}/permissions

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

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

Permissão: igrp.departments.manage.

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

Corpo do pedido

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

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/permissions' \  -H 'Content-Type: application/json' \  -d '[  "string"]'
"string"
GET
/api/departments/{departmentCode}/permissions/available

Permissão: igrp.departments.manage.

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

Parâmetros de query

resourceName?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
name*string
Padrão^[A-Za-z0-9._-]+$
Comprimento0 <= length <= 255
description?string
Comprimento0 <= length <= 255
status?string
Valor em"ACTIVE""TEMPORARY""INACTIVE""DELETED"
departments?array<string>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/permissions/available'
{  "id": 0,  "name": "string",  "description": "string",  "status": "ACTIVE",  "departments": [    "string"  ]}
How is this guide?

Última atualização: