Índice

outline	true
exclude	.*ndice
style	none

APIs para User Experience

...

Este tutorial explica como utilizar as APIs fluig Identity para as funcionalidades de User Experience baseadas em SCIM. APIs baseadas em SCIM são um subconjunto de APIs REST do fluig Identity, que estão documentadas neste artigo.

Localização das APIs: https://app.fluigidentity.com/rest/swagger-ui/index.html

Prepare o Ambiente

Este tutorial utiliza um cliente SOAP para acessar as APIs REST do fluig Identity. Este conjunto de instruções demonstra a configuração do cliente.

Deck of Cards

history	false
id	ambiente

Card

default	true
label	Passo 1

Faça o download do aplicativo SoapUI em http://www.soapui.org/.

Abra o aplicativo SoapUI.

Faça o download do projeto teste CloudPass-Rest-soapui-project.xml.

Card

label	Passo 2

Importe o projeto teste CloudPass-Rest-soapui-project.xml

Card

label	Passo 3

Clique em File → Import Project.

Image Added

Selecione o arquivo CloudPass-Rest-soapui-project.xml.

Image Added

Cliente SOAP para Windows

O projeto importado possui exemplos de dados e chamadas das APIs. Para entender a estrutura da API, podemos observar a chamada Create User.

Lembre-se de definir o endpoint para o sandbox de desenvolvedores.

Deck of Cards

history	false
id	cliente_soap

Card

default	true
label	Abrir requisição

Navegue para Users → Create User → Post e clique em Request 1 conforme a imagem abaixo:

É o nome da API e seu caminho relativo
É o método HTTP da API
É o link da janela de requisição. Dê um duplo clique para abrir a janela de detalhes da API.

Image Added

Card

label	Área de requisição

Na imagem abaixo:

Contém a área para parâmetros de URL.
Contém a área do corpo da requisição HTTP.
Contém o botão Send request.

Image Added

APIs de Usuário

...

As APIs de Usuário possuem quatro funções: Create, Get, Update e Delete. Esta sessão irá utilizar cinco passos para demonstrar essas funções.

Criar um novo usuário
Obter os dados de um usuário pelo ID
Atualizar usuário
Remover um usuário pelo ID
Ao tentar obter o usuário removido, a chamada retorna um erro

Image Added

Criar um novo usuário

Deck of Cards

history	false
id	create_user

Card

default	true
label	Passo 1

Navegue para Users → Create User → POST e clique em Request 1.

Image Added

Card

label	Passo 2

Insira os dados do novo usuário, e clique no botão Send.

Image Added

Card

label	Passo 3

Verifique o retorno clicando na aba JSON.

Image Added

Obter dados do usuário pelo ID
Âncora
getuser
getuser

Deck of Cards

history	false
id	get_user

Card

default	true
label	Passo 1

Navegue para Users → Get User by Id → GET e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o valor do userId na área de parâmetros de URL.

Image Added

Card

label	Passo 3

Clique no botão Send request, aguarde o resultado e verifique o mesmo.

Image Added

Atualizar usuário

Deck of Cards

history	false
id	update_user

Card

default	true
label	Passo 1

Navegue para Users → Update User → PUT e clique em Request 1.

Image Added

Card

label	Passo 2

Mude o campo displayName para "jacob-update".

Image Added

Card

label	Passo 3

Clique no botão Send request, aguarde o resultado e então verifique o mesmo.

Image Added

Remover usuário pelo userId

Deck of Cards

history	false
id	delete_user_by_id

Card

label	Passo 1

Navegue para Users → Delete User → DELETE e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o userId.

Image Added

Card

label	Passo 3

Clique no botão Send request, aguarde o resultado e verifique o mesmo.

Image Added

Ao tentar obter um usuário removido, a chamada retorna erro

Use a chamada GET para o ID do usuário que acabou de ser removido (veja acima).

Image Added

API de Recursos

...

Recursos são implementados para serem utilizados como opções de menu, mas podem ser estendidos para outras aplicações. Nesta seção nós iremos aprender como criar, listar e deletar um recurso.

Este cenário de teste segue os seguintes casos de teste.

Criar recursos
Obter o recurso menu1 pelo ID
Obter todos os recursos de aplicações
Remover o recurso menu1 pelo ID

Criar recursos

Irá criar três recursos: menu1, menu2 e menu3 para aplicação

Deck of Cards

history	false
id	create_resource

Card

default	true
label	Passo 1

Navegue para Resources → Create Resource → POST e clique em Request 1.

Image Added

Card

label	Passo 2

Insira os dados dos recursos menu1, menu2, menu3 e o applicationId.

Image Added

Card

label	Passo 3

Clique no botão Send request, aguarde o resultado e verifique o mesmo.

Image Added

Obter o recurso menu1 pelo ID

Deck of Cards

history	false
id	get_resource

Card

label	Passo 1

Navegue para Resources → Get Resource → GET e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o ID do menu1.

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

Image Added

Obter todos os recursos de aplicações

Irá obter três recursos: menu1, menu2, menu3.

Deck of Cards

history	false
id	get_all_resources

Card

default	true
label	Passo 1

Navegue para Resources → Get All Resources → GET e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o applicationId.

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

Image Added

Remover o recurso menu1 pelo ID

Deck of Cards

history	false
id	delete_by_id

Card

label	Passo 1

Navegue para Resources → Delete by Id → DELETE e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o ID do recurso menu1.

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

APIs de Papéis

...

Papéis são conexões entre usuários e direitos.

Este cenário de testes inclui o seguinte teste de caso:

Criar dois papéis: "user" e "admin" para a empresa

Criar dois papéis: "user" e "admin" para a empresa

Deck of Cards

history	false
id	create_roles

Card

label	Passo 1

Navegue para Roles → Create Roles → POST e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o valor companyId e os dados para os papéis "user" e "admin".

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelos resultados e verifique o retorno.

APIs de Direitos

...

Direitos são como os recursos são atribuídos aos usuários.

Este cenário de testes contém os seguintes casos de teste:

Criar o usuário "Jacob"
Criar os recursos "menu1", "menu2", "menu3"
Atribuir os recursos "menu1", "menu2" para o usuário "Jacob"
Deletar todos os recursos com direitos do usuário "Jacob"

Criar o usuário "Jacob"

Deck of Cards

history	false
id	create_user_jacob

Card

default	true
label	Passo 1

Navegue para Users → Create User → POST e clique em Request 1.

Image Added

Card

label	Passo 2

Insira os dados do novo usuário e clique no botão Send.

Image Added

Card

label	Passo 3

Aguarde os resultados e verifique os mesmos.

Image Added

Criar os recursos "menu1", "menu2", "menu3"

Deck of Cards

history	false
id	create_resources_jacob

Card

label	Passo 1

Navegue para Resources → Get All Resources of Application → GET e clique em Request 1.

Image Added

Card

label	Passo 2

Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId.

Image Added

Card

label	Passo 3

Clique no botão Send request, espere os resultados e verifique o mesmo.

Image Added

Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"

Deck of Cards

history	false
id	get_resources_of_user

Card

label	Passo 1

Navegue para Entitlements → Assign Resources to User → POST e clique em Request 1.

Card

label	Passo 2

Insira o userId e o valor do ID dos recursos "menu1" e "menu2".

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

Image Added

Deletar todos os recursos com direitos do usuário "Jacob"

Deck of Cards

id	unassign_all_resources

Card

label	Passo 1

Navegue para Entitlements → Unassign all Resources to User → DELETE e clique em Request 1.

Card

label	Passo 2

Insira o userId.

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique se o mesmo não possui nenhum direito.

APIs de Favoritos

...

Marcações de favoritos adicionadas a recursos para o usuário.

Este cenário de teste incluí os seguintes casos de teste:

Adicionar o recurso "menu2" como favorito do usuário "Jacob"
Obter os favoritos do usuário "Jacob" , irá retornar "menu2"
Remover os favoritos do usuário "Jacob"

Adicionar o recurso "menu2" como favorito do usuário "Jacob"

Deck of Cards

history	false
id	add_favorites_to_user

Card

label	Passo 1

Navegue para Favorites → Add Favorites to User → POST e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o userId e o ID do recurso "menu2" como favorito.

Image Added

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

Image Added

Obter os favoritos do usuário "Jacob", irá retornar "menu2"

Deck of Cards

history	false
id	get_user_favorites

Card

label	Passo 1

Navegue para Favorites → Get user's Favorites → GET e clique em Request 1.

Image Added

Card

label	Passo 2

Insira o userId.

Card

label	Passo 3

Clique no botão Send request, espere pelo resultado e verifique o mesmo.

Remover os favoritos do usuário "Jacob"

Deck of Cards

history	false
id	delete_user_favorites

Card

label	Passo 1

Navegue para Favorites → Delete user's Favorites → DELETE e clique em Request 1.

Card

label	Passo 2

Insira o userId.

Card

label	Passo 3

Clique no botão Send request, espere o resultado e verifique o mesmo. Nenhum dado de favoritos irá aparecer.

HTML

<!-- Hotjar Tracking Code for http://tdn.totvs.com/display/fb -->
<script>
    (function(h,o,t,j,a,r){
        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
        h._hjSettings={hjid:1280165,hjsv:6};
        a=o.getElementsByTagName('head')[0];
        r=o.createElement('script');r.async=1;
        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
        a.appendChild(r);
    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 26

Nova versão Atual

Chave

Índice

APIs para User Experience

Prepare o Ambiente

Cliente SOAP para Windows

APIs de Usuário

Criar um novo usuário

Obter dados do usuário pelo ID
Âncora
getuser
getuser

Atualizar usuário

Remover usuário pelo userId

Ao tentar obter um usuário removido, a chamada retorna erro

API de Recursos

Criar recursos

Obter o recurso menu1 pelo ID

Obter todos os recursos de aplicações

Remover o recurso menu1 pelo ID

APIs de Papéis

Criar dois papéis: "user" e "admin" para a empresa

APIs de Direitos

Criar o usuário "Jacob"

Criar os recursos "menu1", "menu2", "menu3"

Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"

Deletar todos os recursos com direitos do usuário "Jacob"

APIs de Favoritos

Adicionar o recurso "menu2" como favorito do usuário "Jacob"

Obter os favoritos do usuário "Jacob", irá retornar "menu2"

Remover os favoritos do usuário "Jacob"

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 26

Nova versão Atual

Chave

Índice

APIs para User Experience

Prepare o Ambiente

Cliente SOAP para Windows

APIs de Usuário

Criar um novo usuário

Obter dados do usuário pelo ID Âncoragetusergetuser

Atualizar usuário

Remover usuário pelo userId

Ao tentar obter um usuário removido, a chamada retorna erro

API de Recursos

Criar recursos

Obter o recurso menu1 pelo ID

Obter todos os recursos de aplicações

Remover o recurso menu1 pelo ID

APIs de Papéis

Criar dois papéis: "user" e "admin" para a empresa

APIs de Direitos

Criar o usuário "Jacob"

Criar os recursos "menu1", "menu2", "menu3"

Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"

Deletar todos os recursos com direitos do usuário "Jacob"

APIs de Favoritos

Adicionar o recurso "menu2" como favorito do usuário "Jacob"

Obter os favoritos do usuário "Jacob", irá retornar "menu2"

Remover os favoritos do usuário "Jacob"

Obter dados do usuário pelo ID
Âncora
getuser
getuser