iGRPIGRP 3.0Documentation

Clientes OAuth

Clientes OAuth e contas de serviço para chamadas entre serviços.

Listar clientes OAuth

GET
/api/clients

Permissão: igrp.client.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.

Corpo da resposta

OK

*/*
  1. response
[index: integer]?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/clients'
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "clientId": "string",    "clientSecret": "string",    "clientName": "string",    "description": "string",    "active": true,    "requirePkce": true,    "applicationId": 0,    "applicationCode": "string",    "accessTokenTtl": 0,    "refreshTokenTtl": 0,    "authorizationCodeTtl": 0,    "scopes": [      "string"    ],    "redirectUris": [      "string"    ],    "postLogoutRedirectUris": [      "string"    ],    "grantTypes": [      "string"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Criar cliente OAuth

POST
/api/clients

Permissão: igrp.client.create. O segredo do cliente só aparece nesta resposta: guarda-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 do pedido

application/json
  1. body
clientId*string
Comprimento1 <= length
clientName*string
Comprimento1 <= length
description?string
active?boolean
requirePkce?boolean
applicationId?integer
Formatoint32
accessTokenTtl?integer
Formatoint32
Intervalo60 <= value
refreshTokenTtl?integer
Formatoint32
Intervalo60 <= value
authorizationCodeTtl?integer
Formatoint32
Intervalo30 <= value
scopes*array<string>
Itens1 <= items
redirectUris?array<string>
postLogoutRedirectUris?array<string>
grantTypes*array<string>
Itens1 <= items

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
clientId?string
clientSecret?string
clientName?string
description?string
active?boolean
requirePkce?boolean
applicationId?integer
Formatoint32
applicationCode?string
accessTokenTtl?integer
Formatoint32
refreshTokenTtl?integer
Formatoint32
authorizationCodeTtl?integer
Formatoint32
scopes?array<string>
redirectUris?array<string>
postLogoutRedirectUris?array<string>
grantTypes?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/clients' \  -H 'Content-Type: application/json' \  -d '{  "clientId": "string",  "clientName": "string",  "scopes": [    "string"  ],  "grantTypes": [    "string"  ]}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "clientId": "string",  "clientSecret": "string",  "clientName": "string",  "description": "string",  "active": true,  "requirePkce": true,  "applicationId": 0,  "applicationCode": "string",  "accessTokenTtl": 0,  "refreshTokenTtl": 0,  "authorizationCodeTtl": 0,  "scopes": [    "string"  ],  "redirectUris": [    "string"  ],  "postLogoutRedirectUris": [    "string"  ],  "grantTypes": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Obter cliente OAuth

GET
/api/clients/{id}

Permissão: igrp.client.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*string
Formatouuid

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
clientId?string
clientSecret?string
clientName?string
description?string
active?boolean
requirePkce?boolean
applicationId?integer
Formatoint32
applicationCode?string
accessTokenTtl?integer
Formatoint32
refreshTokenTtl?integer
Formatoint32
authorizationCodeTtl?integer
Formatoint32
scopes?array<string>
redirectUris?array<string>
postLogoutRedirectUris?array<string>
grantTypes?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "clientId": "string",  "clientSecret": "string",  "clientName": "string",  "description": "string",  "active": true,  "requirePkce": true,  "applicationId": 0,  "applicationCode": "string",  "accessTokenTtl": 0,  "refreshTokenTtl": 0,  "authorizationCodeTtl": 0,  "scopes": [    "string"  ],  "redirectUris": [    "string"  ],  "postLogoutRedirectUris": [    "string"  ],  "grantTypes": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Eliminar cliente OAuth

DELETE
/api/clients/{id}

Permissão: igrp.client.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

id*string
Formatouuid

Corpo da resposta

OK

curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Vazio

Atualizar cliente OAuth

PUT
/api/clients/{id}

Permissão: igrp.client.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

id*string
Formatouuid

Corpo do pedido

application/json
  1. body
clientId*string
Comprimento1 <= length
clientName*string
Comprimento1 <= length
description?string
active?boolean
requirePkce?boolean
applicationId?integer
Formatoint32
accessTokenTtl?integer
Formatoint32
Intervalo60 <= value
refreshTokenTtl?integer
Formatoint32
Intervalo60 <= value
authorizationCodeTtl?integer
Formatoint32
Intervalo30 <= value
scopes*array<string>
Itens1 <= items
redirectUris?array<string>
postLogoutRedirectUris?array<string>
grantTypes*array<string>
Itens1 <= items

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
clientId?string
clientSecret?string
clientName?string
description?string
active?boolean
requirePkce?boolean
applicationId?integer
Formatoint32
applicationCode?string
accessTokenTtl?integer
Formatoint32
refreshTokenTtl?integer
Formatoint32
authorizationCodeTtl?integer
Formatoint32
scopes?array<string>
redirectUris?array<string>
postLogoutRedirectUris?array<string>
grantTypes?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "clientId": "string",  "clientName": "string",  "scopes": [    "string"  ],  "grantTypes": [    "string"  ]}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "clientId": "string",  "clientSecret": "string",  "clientName": "string",  "description": "string",  "active": true,  "requirePkce": true,  "applicationId": 0,  "applicationCode": "string",  "accessTokenTtl": 0,  "refreshTokenTtl": 0,  "authorizationCodeTtl": 0,  "scopes": [    "string"  ],  "redirectUris": [    "string"  ],  "postLogoutRedirectUris": [    "string"  ],  "grantTypes": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Listar contas de serviço

GET
/api/service-accounts

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

*/*
  1. response
[index: integer]?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/service-accounts'
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "active": true,    "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab",    "clientId": "string",    "applicationId": 0,    "applicationCode": "string",    "roleIds": [      0    ],    "roleCodes": [      "string"    ],    "permissionIds": [      0    ],    "permissionNames": [      "string"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Criar conta de serviço

POST
/api/service-accounts

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
name*string
Comprimento1 <= length
description?string
active?boolean
oauthClientId*string
Formatouuid
applicationId?integer
Formatoint32
roleIds?array<>
permissionIds?array<>

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
description?string
active?boolean
oauthClientId?string
Formatouuid
clientId?string
applicationId?integer
Formatoint32
applicationCode?string
roleIds?array<>
roleCodes?array<string>
permissionIds?array<>
permissionNames?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/service-accounts' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "active": true,  "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab",  "clientId": "string",  "applicationId": 0,  "applicationCode": "string",  "roleIds": [    0  ],  "roleCodes": [    "string"  ],  "permissionIds": [    0  ],  "permissionNames": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Obter conta de serviço

GET
/api/service-accounts/{id}

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

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
description?string
active?boolean
oauthClientId?string
Formatouuid
clientId?string
applicationId?integer
Formatoint32
applicationCode?string
roleIds?array<>
roleCodes?array<string>
permissionIds?array<>
permissionNames?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "active": true,  "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab",  "clientId": "string",  "applicationId": 0,  "applicationCode": "string",  "roleIds": [    0  ],  "roleCodes": [    "string"  ],  "permissionIds": [    0  ],  "permissionNames": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Eliminar conta de serviço

DELETE
/api/service-accounts/{id}

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

Corpo da resposta

OK

curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Vazio

Atualizar conta de serviço

PUT
/api/service-accounts/{id}

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

Corpo do pedido

application/json
  1. body
name*string
Comprimento1 <= length
description?string
active?boolean
oauthClientId*string
Formatouuid
applicationId?integer
Formatoint32
roleIds?array<>
permissionIds?array<>

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
description?string
active?boolean
oauthClientId?string
Formatouuid
clientId?string
applicationId?integer
Formatoint32
applicationCode?string
roleIds?array<>
roleCodes?array<string>
permissionIds?array<>
permissionNames?array<string>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
curl -X PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "active": true,  "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab",  "clientId": "string",  "applicationId": 0,  "applicationCode": "string",  "roleIds": [    0  ],  "roleCodes": [    "string"  ],  "permissionIds": [    0  ],  "permissionNames": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
How is this guide?

Última atualização: