Cross Segmentos - Backoffice RM - Integração - API - Consumo API Perfil do Usuário

 Tempo aproximado para leitura: 00:03:00 min

Dúvida
Como utilizar a API de Perfil do Usuário, para vincular ou remover um perfil de um usuário?

Ambiente
Cross Segmentos - Backoffice RM - Integração - A partir da versão 12.1.2306.

Solução

A partir da versão 12.1.2306, foi disponibilizado a API de Perfil do Usuário, para poder ser vinculado ou removido um, ou mais perfis do usuário do sistema.

Vincular Perfil ao Usuário

Método HTTP: Post
Máscara de Url:
http://{domínio}:{porta}/api/framework/v1/users/{user}/roles

Exemplo de Configuração

Url Utilizada: http://localhost:8051/api/framework/v1/users/teste/roles

Variável	Descrição	Valor
domínio	endereço do serviço de webservice	localhost
porta	porta do serviço	8051
user	código do usuário	teste

Request Body

company	Coligada, ao qual será vinculado o perfil. Ao enviar o código da coligada (Company) como 0 o sistema irá adicionar o perfil para todas as coligadas que o usuário possuir permissão.
value	Identificador do Perfil, ao qual será vinculado ao usuário.

O campo value da request body JSON, sendo o Identificador do Perfil, poderá ser verificado no próprio cadastro do Perfil:


Exemplo Json:

{
   "roles": [
   {
      "company": "1",
      "value": "DBA_G"
   }
   ]
}

Cadastro do Perfil, realizado via Postman:

Remover perfil do usuário

Método HTTP: Delete

Máscara de Url:  http://{domínio}:{porta}/api/framework/v1/users/{user}/roles/company/{company}/role/{role}

Exemplo de Configuração

Url Utilizada:
http://localhost:8051/api/framework/v1/users/teste/roles/company/0/role/DBA_G

Variável	Descrição	Valor
domínio	endereço do serviço de webservice	localhost
porta	porta do serviço	8051
user	código do usuário	teste
company	código da coligada que será utilizada É possível remover a associação de um mesmo perfil em todas as coligadas informando o valor Zero (0), na propriedade company.	1
role	Identificador(IDPERFIL) do perfil que será atribuído	DBA_G

Remoção do Perfil, realizado via Postman:

Por padrão, nas mensagens de DELETE, a resposta deve ser enviada com HTTP Code 204 (No content) e sem corpo no retorno, mesmo se não obtiver sucesso.

 

Saiba Mais
Para mais informações sobre a API de Perfil do Usuário, segue documentação abaixo:

API Perfil do Usuário