Árvore de páginas

Versões comparadas

Chave

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

Índice

Índice
outlinetrue
exclude.*ndice
stylenone


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
historyfalse
idambiente
Card
defaulttrue
labelPasso 1

  • Abra o aplicativo SoapUI.
  • Faça o download do projeto teste CloudPass-Rest-soapui-project.xml.


Card
labelPasso 2


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


Card
labelPasso 3


  • Clique em FileImport Project.

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


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
historyfalse
idcliente_soap
Card
defaulttrue
labelAbrir requisição


  • Navegue para Users → Create User → Post e clique em Request 1 conforme a imagem abaixo:
  1. É o nome da API e seu caminho relativo
  2. É o método HTTP da API
  3. É o link da janela de requisição. Dê um duplo clique para abrir a janela de detalhes da API.


Card
labelÁrea de requisição


  • Na imagem abaixo:
  1. Contém a área para parâmetros de URL.
  2. Contém a área do corpo da requisição HTTP.
  3. Contém o botão Send request.



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


Criar um novo usuário

Deck of Cards
historyfalse
idcreate_user
Card
defaulttrue
labelPasso 1

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


Card
labelPasso 2


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

Card
labelPasso 3


  • Verifique o retorno clicando na aba JSON.


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

Deck of Cards
historyfalse
idget_user
Card
defaulttrue
labelPasso 1


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

Card
labelPasso 2


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

Card
labelPasso 3


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


Atualizar usuário

Deck of Cards
historyfalse
idupdate_user
Card
defaulttrue
labelPasso 1


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

Card
labelPasso 2


  • Mude o campo displayName para "jacob-update".

Card
labelPasso 3


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


Remover usuário pelo userId

Deck of Cards
historyfalse
iddelete_user_by_id
Card
labelPasso 1


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

Card
labelPasso 2


  • Insira o userId.

Card
labelPasso 3


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


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).


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
historyfalse
idcreate_resource
Card
defaulttrue
labelPasso 1


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


Card
labelPasso 2


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

Card
labelPasso 3


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



Obter o recurso menu1 pelo ID

Deck of Cards
historyfalse
idget_resource
Card
labelPasso 1


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


Card
labelPasso 2


  • Insira o ID do menu1.


Card
labelPasso 3


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


Obter todos os recursos de aplicações

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

Deck of Cards
historyfalse
idget_all_resources
Card
defaulttrue
labelPasso 1


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


Card
labelPasso 2


  • Insira o applicationId.


Card
labelPasso 3


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


Remover o recurso menu1 pelo ID

Deck of Cards
historyfalse
iddelete_by_id
Card
labelPasso 1


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

Card
labelPasso 2


  • Insira o ID do recurso menu1.


Card
labelPasso 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.

...

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

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

Deck of Cards
historyfalse
idcreate_roles
Card
labelPasso 1


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


Card
labelPasso 2


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

Card
labelPasso 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.

...

  • 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
historyfalse
idcreate_user_jacob
Card
defaulttrue
labelPasso 1


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


Card
labelPasso 2


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


Card
labelPasso 3


  • Aguarde os resultados e verifique os mesmos.


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

Deck of Cards
historyfalse
idcreate_resources_jacob
Card
labelPasso 1


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

Card
labelPasso 2


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

Card
labelPasso 3


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


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

Deck of Cards
historyfalse
idget_resources_of_user
Card
labelPasso 1


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


Card
labelPasso 2


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

Card
labelPasso 3


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


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

Deck of Cards
idunassign_all_resources
Card
labelPasso 1


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


Card
labelPasso 2


  • Insira o userId.


Card
labelPasso 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.

...

  • 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
historyfalse
idadd_favorites_to_user
Card
labelPasso 1


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



Card
labelPasso 2


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

Card
labelPasso 3


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


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

Deck of Cards
historyfalse
idget_user_favorites
Card
labelPasso 1


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

Card
labelPasso 2


  • Insira o userId.


Card
labelPasso 3


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



Remover os favoritos do usuário "Jacob"

Deck of Cards
historyfalse
iddelete_user_favorites
Card
labelPasso 1


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


Card
labelPasso 2


  • Insira o userId.


Card
labelPasso 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>