Índice
Í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 |
---|
|
Card |
---|
|
- Abra o aplicativo SoapUI.
- Faça o download do projeto teste CloudPass-Rest-soapui-project.xml.
|
Card |
---|
|
- Importe o projeto teste CloudPass-Rest-soapui-project.xml
![](/download/attachments/221554568/scim_1.jpeg?version=2&modificationDate=1519405008000&api=v2)
|
Card |
---|
|
- Clique em File → Import Project.
![](/download/attachments/221554568/scim_3.jpeg?version=2&modificationDate=1519407005000&api=v2)
- Selecione o arquivo CloudPass-Rest-soapui-project.xml.
![](/download/attachments/221554568/scim_4.jpeg?version=2&modificationDate=1519407040000&api=v2)
|
|
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.
![](/download/attachments/221554568/scim_5.jpeg?version=2&modificationDate=1519407248000&api=v2)
|
Card |
---|
|
- 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.
![](/download/attachments/221554568/scim_6.jpeg?version=2&modificationDate=1519407747000&api=v2)
|
|
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
![](/download/attachments/221554568/scim_7.jpeg?version=2&modificationDate=1519409469000&api=v2)
Criar um novo usuário
Deck of Cards |
---|
history | false |
---|
id | create_user |
---|
|
Card |
---|
|
- Navegue para Users → Create User → POST e clique em Request 1.
![](/download/attachments/221554568/scim_8.jpeg?version=2&modificationDate=1519409790000&api=v2)
|
Card |
---|
|
- Insira os dados do novo usuário, e clique no botão Send.
![](/download/attachments/221554568/scim_9.jpeg?version=2&modificationDate=1519410067000&api=v2)
|
Card |
---|
|
- Verifique o retorno clicando na aba JSON.
![](/download/attachments/221554568/scim_10.jpeg?version=2&modificationDate=1519410109000&api=v2)
|
|
Obter dados do usuário pelo ID
Deck of Cards |
---|
|
Card |
---|
|
- Navegue para Users → Get User by Id → GET e clique em Request 1.
![](/download/attachments/221554568/scim_12.jpeg?version=2&modificationDate=1519410495000&api=v2)
|
Card |
---|
|
- Insira o valor do userId na área de parâmetros de URL.
![](/download/attachments/221554568/scim_13.jpeg?version=2&modificationDate=1519410584000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, aguarde o resultado e verifique o mesmo.
![](/download/attachments/221554568/scim_14.jpeg?version=2&modificationDate=1519410645000&api=v2)
|
|
Atualizar usuário
Deck of Cards |
---|
history | false |
---|
id | update_user |
---|
|
Card |
---|
|
- Navegue para Users → Update User → PUT e clique em Request 1.
![](/download/attachments/221554568/scim_15.jpeg?version=2&modificationDate=1519410747000&api=v2)
|
Card |
---|
|
- Mude o campo displayName para "jacob-update".
![](/download/attachments/221554568/scim_16.jpeg?version=2&modificationDate=1519410821000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, aguarde o resultado e então verifique o mesmo.
![](/download/attachments/221554568/scim_17.jpeg?version=2&modificationDate=1519410866000&api=v2)
|
|
Remover usuário pelo userId
Deck of Cards |
---|
history | false |
---|
id | delete_user_by_id |
---|
|
Card |
---|
|
- Navegue para Users → Delete User → DELETE e clique em Request 1.
![](/download/attachments/221554568/scim_17a.jpeg?version=3&modificationDate=1519416658000&api=v2)
|
Card |
---|
|
![](/download/attachments/221554568/scim_18.jpeg?version=2&modificationDate=1519414127000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, aguarde o resultado e verifique o mesmo.
![](/download/attachments/221554568/scim_19.jpeg?version=2&modificationDate=1519414198000&api=v2)
|
|
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).
![](/download/attachments/221554568/scim_20.jpeg?version=2&modificationDate=1519414338000&api=v2)
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.
...
- 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 |
---|
|
- Navegue para Resources → Create Resource → POST e clique em Request 1.
![](/download/attachments/221554568/ScimResources_1.jpeg?version=2&modificationDate=1519414711000&api=v2)
|
Card |
---|
|
- Insira os dados dos recursos menu1, menu2, menu3 e o applicationId.
![](/download/attachments/221554568/ScimResources_2.jpeg?version=2&modificationDate=1519414755000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, aguarde o resultado e verifique o mesmo.
![](/download/attachments/221554568/ScimResources_3.jpeg?version=2&modificationDate=1519414799000&api=v2)
|
|
Deck of Cards |
---|
history | false |
---|
id | get_resource |
---|
|
Card |
---|
|
- Navegue para Resources → Get Resource → GET e clique em Request 1.
![](/download/attachments/221554568/ScimResources_4.jpeg?version=2&modificationDate=1519414889000&api=v2)
|
Card |
---|
|
![](/download/attachments/221554568/ScimResources_5.jpeg?version=2&modificationDate=1519414948000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, espere pelo resultado e verifique o mesmo.
![](/download/attachments/221554568/ScimResources_6.jpeg?version=2&modificationDate=1519414992000&api=v2)
|
|
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 |
---|
|
- Navegue para Resources → Get All Resources → GET e clique em Request 1.
![](/download/attachments/221554568/ScimResources_7.jpeg?version=2&modificationDate=1519416774000&api=v2)
|
Card |
---|
|
![](/download/attachments/221554568/ScimResources_8.jpeg?version=2&modificationDate=1519416813000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, espere pelo resultado e verifique o mesmo.
![](/download/attachments/221554568/ScimResources_9.jpeg?version=2&modificationDate=1519416876000&api=v2)
|
|
Deck of Cards |
---|
history | false |
---|
id | delete_by_id |
---|
|
Card |
---|
|
- Navegue para Resources → Delete by Id → DELETE e clique em Request 1.
![](/download/attachments/221554568/ScimResources_10.jpeg?version=3&modificationDate=1519417461000&api=v2)
|
Card |
---|
|
- Insira o ID do recurso menu1.
![](/download/attachments/221554568/ScimResources_11.jpeg?version=2&modificationDate=1519417499000&api=v2)
|
Card |
---|
|
- 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.
...
- 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 |
---|
|
- Navegue para Roles → Create Roles → POST e clique em Request 1.
![](/download/attachments/221554568/Roles_1.jpeg?version=2&modificationDate=1519646070000&api=v2)
|
Card |
---|
|
- Insira o valor companyId e os dados para os papéis "user" e "admin".
![](/download/attachments/221554568/Roles_2.jpeg?version=2&modificationDate=1519646137000&api=v2)
|
Card |
---|
|
- 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.
...
- 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 |
---|
|
- Navegue para Users → Create User → POST e clique em Request 1.
![](/download/attachments/221554568/Entitlements_1.jpeg?version=3&modificationDate=1519646306000&api=v2)
|
Card |
---|
|
- Insira os dados do novo usuário e clique no botão Send.
![](/download/attachments/221554568/Entitlements_2.jpeg?version=2&modificationDate=1519646348000&api=v2)
|
Card |
---|
|
- Aguarde os resultados e verifique os mesmos.
![](/download/attachments/221554568/Entitlements_3.jpeg?version=2&modificationDate=1519646400000&api=v2)
|
|
Deck of Cards |
---|
history | false |
---|
id | create_resources_jacob |
---|
|
Card |
---|
|
- Navegue para Resources → Get All Resources of Application → GET e clique em Request 1.
![](/download/attachments/221554568/Entitlements_4.jpeg?version=2&modificationDate=1519647530000&api=v2)
|
Card |
---|
|
- Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId.
![](/download/attachments/221554568/Entitlements_5.jpeg?version=2&modificationDate=1519647487000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, espere os resultados e verifique o mesmo.
![](/download/attachments/221554568/Entitlements_6.jpeg?version=2&modificationDate=1519647604000&api=v2)
|
|
Deck of Cards |
---|
history | false |
---|
id | get_resources_of_user |
---|
|
Card |
---|
|
- Navegue para Entitlements → Assign Resources to User → POST e clique em Request 1.
|
Card |
---|
|
- Insira o userId e o valor do ID dos recursos "menu1" e "menu2".
![](/download/attachments/221554568/Entitlements_11.jpeg?version=2&modificationDate=1519647876000&api=v2)
|
Card |
---|
|
- Clique no botão Send request, espere pelo resultado e verifique o mesmo.
![](/download/attachments/221554568/Entitlements_12.jpeg?version=2&modificationDate=1519648335000&api=v2)
|
|
Deletar todos os recursos com direitos do usuário "Jacob"
Deck of Cards |
---|
|
Card |
---|
|
- Navegue para Entitlements → Unassign all Resources to User → DELETE e clique em Request 1.
|
Card |
---|
|
- 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.
...
- 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"
Deck of Cards |
---|
history | false |
---|
id | add_favorites_to_user |
---|
|
Card |
---|
|
- Navegue para Favorites → Add Favorites to User → POST e clique em Request 1.
Image Added
|
Card |
---|
|
- Insira o userId e o ID do recurso "menu2" como favorito.
Image Added
|
Card |
---|
|
- 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 |
---|
|
- Navegue para Favorites → Get user's Favorites → GET e clique em Request 1.
Image Added
|
Card |
---|
|
- 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 |
---|
|
- Navegue para Favorites → Delete user's Favorites → DELETE e clique em Request 1.
|
Card |
---|
|
- 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> |