iGRPIGRP 3.0Documentation

Utilizador autenticado

Dados, perfis, permissões e aplicações do próprio utilizador (`/me`).

Obter o utilizador autenticado

GET
/api/users/me

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

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?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me'
{  "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  }}

Atualizar os próprios dados

PUT
/api/users/me

Só altera os dados do próprio utilizador.

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?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?

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?
curl -X PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
{  "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  }}

Os meus departamentos

GET
/api/users/me/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

departmentCode?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/users/me/departments'
{  "id": 0,  "code": "string",  "name": "string",  "description": "string",  "status": "ACTIVE",  "icon": "string",  "parentCode": "string"}

Os meus perfis

GET
/api/users/me/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

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/users/me/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"  ]}

Os meus perfis num departamento

GET
/api/users/me/departments/{departmentCode}/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 caminho

departmentCode*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/users/me/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"  ]}

O meu perfil ativo

GET
/api/users/me/roles/active

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

application/json
  1. response
roleCode?string
departmentCode?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me/roles/active'
{  "roleCode": "string",  "departmentCode": "string"}

Mudar o meu perfil ativo

POST
/api/users/me/roles/active

Corpo { roleCode, departmentCode }. Revoga as sessões: o token seguinte traz as permissões do novo 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.

Corpo do pedido

application/json
  1. body
roleCode?string
departmentCode?string

Corpo da resposta

OK

application/json
  1. response
roleCode?string
departmentCode?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me/roles/active' \  -H 'Content-Type: application/json' \  -d '{}'
{  "roleCode": "string",  "departmentCode": "string"}

As minhas permissões

GET
/api/users/me/permissions

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

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

As minhas aplicações

GET
/api/users/me/applications

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

applicationCode?string
applicationName?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/users/me/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"  ]}

Os meus menus numa aplicação

GET
/api/users/me/applications/{applicationCode}/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

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/users/me/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"    }  ]}

Aplicações favoritas

GET
/api/users/me/applications/favorites

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

applicationCode?string
applicationName?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/users/me/applications/favorites'
{  "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"  ]}

Marcar aplicação como favorita

POST
/api/users/me/applications/favorites/{applicationCode}

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

applicationCode*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me/applications/favorites/string'
"string"

Retirar aplicação dos favoritos

DELETE
/api/users/me/applications/favorites/{applicationCode}

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

applicationCode*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me/applications/favorites/string'
"string"

Aplicações recentes

GET
/api/users/me/applications/recent

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

applicationCode?string
applicationName?string
max?integer
Formatoint32

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/users/me/applications/recent'
{  "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"  ]}

Registar acesso a uma aplicação

POST
/api/users/me/applications/recent/{applicationCode}

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

applicationCode*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/me/applications/recent/string'
"string"
How is this guide?

Última atualização: