iGRPIGRP 3.0Documentation

Perfis

Perfis de cada departamento, a árvore de perfis e as permissões de cada perfil.

Perfis do departamento

GET
/api/departments/{code}/roles

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

roleCode?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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "departmentCode": "string",  "parentCode": "string",  "status": "ACTIVE",  "icon": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "permissions": [    "string"  ]}

Criar perfil

POST
/api/departments/{code}/roles

Permissão: igrp.departments.manage. O código é único dentro do departamento; o de um perfil filho leva o do pai como prefixo.

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_.-]+$
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>

Corpo da resposta

Created

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/departments/string/roles' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "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"  ]}

Eliminar perfil

DELETE
/api/departments/{departmentCode}/roles/{roleCode}

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

Corpo da resposta

No Content

response?booleanapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles/string'
true

Atualizar perfil

PUT
/api/departments/{departmentCode}/roles/{roleCode}

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

Corpo do pedido

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

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 PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles/string' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "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"  ]}

Perfis pai

GET
/api/departments/{departmentCode}/roles/{roleCode}/parents

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

Parâmetros de query

level?integer
Formatoint32

Corpo da resposta

OK

application/json
  1. response
roleCode?string
departmentCode?string
parents?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles/string/parents'
{  "roleCode": "string",  "departmentCode": "string",  "parents": [    {}  ]}

Perfis filho

GET
/api/departments/{departmentCode}/roles/{roleCode}/children

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

Parâmetros de query

level?integer
Formatoint32

Corpo da resposta

OK

application/json
  1. response
roleCode?string
departmentCode?string
children?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles/string/children'
{  "roleCode": "string",  "departmentCode": "string",  "children": [    {}  ]}

Permissões do perfil

GET
/api/departments/{departmentCode}/roles/{roleCode}/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

departmentCode*string
roleCode*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/roles/string/permissions'
{  "id": 0,  "name": "string",  "description": "string",  "status": "ACTIVE",  "departments": [    "string"  ]}

Dar permissões ao perfil

POST
/api/departments/{departmentCode}/roles/{roleCode}/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

departmentCode*string
roleCode*string

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/departments/string/roles/string/permissions' \  -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"  ]}

Retirar permissões ao perfil

DELETE
/api/departments/{departmentCode}/roles/{roleCode}/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

departmentCode*string
roleCode*string

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 DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/departments/string/roles/string/permissions' \  -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"  ]}
GET
/api/departments/{departmentCode}/roles/{roleCode}/permissions/available

Permissão: igrp.departments.manage. Só as que o perfil pai já tem e que estão disponíveis no departamento ou acima.

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
roleCode*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/roles/string/permissions/available'
{  "id": 0,  "name": "string",  "description": "string",  "status": "ACTIVE",  "departments": [    "string"  ]}

Obter perfil por id

GET
/api/roles/{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

Parâmetros de query

departmentCode*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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/roles/0?departmentCode=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"  ]}

Obter perfis por código

GET
/api/roles/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

Parâmetros de query

departmentCode*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 GET 'http://localhost:2575/gateway-api/igrp-access-management/api/roles/by-code/string?departmentCode=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: