Linha RM

Atalhos

Páginas filhas
  • API de Usuários

Versões comparadas

Versão antiga 69

changes.mady.by.user Fábio Augusto Amaral Melo Nunes

Gravado em

comparado com

Nova versão 70

changes.mady.by.user Fábio Augusto Amaral Melo Nunes

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
iconfalse
title1.5.1 Patch
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: Teste_01

Url Utilizada: http://localhost:8051/api/framework/v1/users/Teste_01

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"name":
	{
            "givenName": {{givenName_formatted}}
    },
    "emails": [
        {
            "value": {{email_formatted}},
            "primary": true
        }
    ],
    "active": {{active}}
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "Teste_01",
    "meta": {
        "resourceType": "User",
        "created": "2018-12-05T15:03:07.28",
        "lastModified": "2018-12-05T15:03:08.5546578"
    },
    "externalId": "IDTeste_01External",
    "name": {
        "formatted": "NOME SOCIAL DO TESTE_01",
        "givenName": "Igor",
        "familyName": "Automatizado"
    },
    "userName": "Teste_01",
    "emails": [
        {
            "value": "[email protected]",
            "primary": true
        }
    ],
    "active": true
}


Referências (Links)

...

Roles (Manipulação de Perfis) A partir da versão 12.1.2306

...

Informações
titleAssociação de Perfis (Roles)
Para adicionar/remover perfis á um usuário é necessário realizar as operações de Post/Delete nas rotas de perfis conforme abaixo

Post
Informaçõesexpand
titleAdicionar Perfil (sPost) ao usuário

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


Expandir
titleExemplo Sucesso
Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

User: Teste_01

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

FABIONUNES

apiteste/roles

Expandir
titleExemplo Sucesso
Request Sucess

VariávelDescriçãoValor
domínioendereço do serviço de webservicelocalhost
portaporta do serviço8051
usercódigo do usuárioapiteste
Informações
title
Informações
iconfalse
titleRequest Body
Bloco de código
languagejs
titleJson
linenumberstrue
{
	"roles": [
		{
			"company": "0",
			"value": "DBA_G"
		}
	]
}
Informações
iconfalse
titleResponse

HttpStatus: 200

Bloco de código
languagejs
titleJson
linenumberstrue
{
    "id": "
APITESTE
apiteste",
    "roles": [
        {
            "company": "1",
            "value": "DBA_G"
        },
        {
            "company": "6",
            "value": "DBA_G"
        },
        {
            "company": "7",
            "value": "DBA_G"
        }
    ]
}
Aviso
titleAtenção

Ao enviar o codigo da coligada (Company) como 0 o sistema irá adicionar o perfil para todas as coligadas que o usuário possuir permissão.

Como no exemplo da resposta, o perfil DBA_G foi associado para as coligadas 1,6 e 7.

Expandir
titleExemplo de Retorno (Response Error)
Bloco de código
languagejs
titleJson
linenumberstrue
"roles": 
[
		{
			"company": "1",
			"value": "PERFIL-1"
		},       
        {
			"company": "1",
			"value": "PERFIL-2"
		},       
        {
			"company": "2",
			"value": "PERFIL-2"
		}  
]
Informaçõesexpand
titleRemover perfil do usuário (Delete)
Máscara de Url:  http://{domínio}:{porta}/api/framework/v1/users/{user}/roles/company/{company}/role/{role}


Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

User: Teste_01

Url Utilizada:   http://localhost:8051/api/framework/v1/users/Teste_01/rolesapiteste/roles/company/0/role/DBA_S

VariávelDescriçãoValor
domínioendereço do serviço de webservicelocalhost
portaporta do serviço8051
usercódigo do usuárioapiteste
companycódigo da coligada que será utilizada0
roleIdentificador(IDPERFIL) do perfil que será atribuído

DBA_S

Informações
iconfalse
titleResponse (Sucesso ou Erro)

HttpStatus: 204

Response Body: Vazio 

Aviso
titleAtenção

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.