iGRPIGRP 3.0Documentation

Convites

Convidar utilizadores e validar o convite (email e OTP).

Listar convites

GET
/api/users/invite

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

identifierValue?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Convidar utilizador

POST
/api/users/invite

Permissão: igrp.users.create. O convite é enviado por email através do Notification Service.

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
email*string
Formatoemail
Comprimento1 <= length
departmentCode?string
roles?array<string>

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Obter convite

GET
/api/users/invite/{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*integer
Formatoint32

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/0'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Cancelar convite

DELETE
/api/users/invite/{id}

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

id*integer
Formatoint32

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/0'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Reenviar convite

PUT
/api/users/invite/{id}

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

id*integer
Formatoint32

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X PUT 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/0'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Obter convite pelo token

GET
/api/users/invite/by-token/{token}

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

token*string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X GET 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/by-token/string'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}

Validar email e enviar OTP

POST
/api/users/invite/validate-email

Valida o email do convidado e envia-lhe um código OTP.

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
token*string
Comprimento1 <= length
email*string
Comprimento1 <= length

Corpo da resposta

OK

application/json
  1. response
token?string
message?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/validate-email' \  -H 'Content-Type: application/json' \  -d '{  "token": "string",  "email": "string"}'
{  "token": "string",  "message": "string"}

Validar código OTP

POST
/api/users/invite/validate-otp

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
token*string
Comprimento1 <= length
otpCode*string
Comprimento1 <= length

Corpo da resposta

OK

application/json
  1. response
token?string
message?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/validate-otp' \  -H 'Content-Type: application/json' \  -d '{  "token": "string",  "otpCode": "string"}'
{  "token": "string",  "message": "string"}

Responder ao convite

POST
/api/users/invite/response

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

token*string

Corpo do pedido

application/json
  1. body
accept*boolean
observation?string

Corpo da resposta

OK

application/json
  1. response
id?integer
Formatoint32
identifierType?string
identifierValue?string
status?string
Valor em"PENDING""ACCEPTED""REJECTED""CANCELED"
expiry?string
Formatodate-time
invitationDate?string
Formatodate-time
invitedBy?string
comments?string
invitationUrl?string
roles?array<>
department?
curl -X POST 'http://localhost:2575/gateway-api/igrp-access-management/api/users/invite/response?token=string' \  -H 'Content-Type: application/json' \  -d '{  "accept": true}'
{  "id": 0,  "identifierType": "string",  "identifierValue": "string",  "status": "PENDING",  "expiry": "2019-08-24T14:15:22Z",  "invitationDate": "2019-08-24T14:15:22Z",  "invitedBy": "string",  "comments": "string",  "invitationUrl": "string",  "roles": [    {      "code": "string",      "description": "string"    }  ],  "department": {    "code": "string",    "description": "string"  }}
How is this guide?

Última atualização: