Índice
| Índice |
|---|
| outline | true |
|---|
| exclude | .*ndice |
|---|
| style | none |
|---|
|
APIs para User Experience
...
...
Este tutorial explica como utilizar as APIs
...
Identity para as funcionalidades de User Experience baseadas em SCIM. APIs baseadas em SCIM são um subconjunto de APIs REST do
...
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
...
Identity. Este conjunto de instruções demonstra a configuração do cliente.
| Deck of Cards |
|---|
|
| Card |
|---|
|
- Faça o download do aplicativo SoapUI
|
|
...
- Abra o aplicativo SoapUI.
- Faça o download do projeto
|
|
...
- teste CloudPass-Rest-soapui-project.xml.
|
|
...
- teste CloudPass-Rest-soapui-project.xml
 Image Modified
|
|
...
 Image Modified
- Selecione o arquivo CloudPass-Rest-soapui-project.xml.
 Image Modified
|
|
...
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.
...
1) Navegue para Users > Create User > Post e clique em Request 1
Na imagem abaixo:
Image Removed
...
| 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 link da janela de requisição. Dê um duplo clique para abrir a janela de detalhes da API.
|
|
...
Image Added
|
|
...
...
...
- Contém a área para parâmetros de URL.
|
|
...
- Contém a área do corpo da requisição HTTP.
|
|
...
...
 Image Added
|
|
APIs de Usuário
...
...
As APIs de Usuário possuem
...
quatro funções:
...
Create, Get, Update e Delete.
...
Image Removed
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 |
|---|
|
- Navegue para Users → Create User → POST e clique em Request 1.
 Image Added
|
| Card |
|---|
|
- Insira os dados do novo usuário, e clique no botão Send.
 Image Modified
|
| Card |
|---|
|
- Verifique o retorno clicando na
|
|
...
 Image Modified
|
|
Obter dados do usuário pelo ID
...
| Card |
|---|
|
- Navegue para Users → Get User by Id
|
|
...
...
...
 Image Modified
|
|
...
- do userId na área de parâmetros de URL.
 Image Modified
|
|
...
- botão Send request, aguarde o resultado e verifique o mesmo.
 Image Modified
|
|
...
Atualizar usuário
| Deck of Cards |
|---|
| history | false |
|---|
| id | update_user |
|---|
|
|
...
|
- Navegue para Users → Update User → PUT e clique em Request 1.
 Image Added
|
| Card |
|---|
|
- Mude o campo displayName para
|
|
...
 Image Modified
|
|
...
- botão Send request, aguarde o resultado e então verifique o mesmo.
 Image Modified
|
|
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.
 Image Added
|
| Card |
|---|
|
 Image Added
|
| Card |
|---|
|
- Clique no botão Send request, aguarde o
|
|
...
- resultado e verifique o mesmo.
 Image Modified
|
|
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 Modified
...
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.
...
...
- Obter o recurso menu1 pelo
...
- ID
- Obter todos os recursos de aplicações
...
- Remover o recurso menu1 pelo
...
Criar recursos
Irá criar três recursos: menu1, menu2
...
e menu3 para aplicação
| Deck of Cards |
|---|
| history | false |
|---|
| id | create_resource |
|---|
|
|
...
...
...
...
...
 Image Modified
|
| Card |
|---|
|
- Insira os dados dos recursos menu1, menu2, menu3 e
|
|
...
 Image Modified
|
|
...
...
- aguarde o resultado e verifique o mesmo.
 Image Modified
|
|
...
...
| Deck of Cards |
|---|
| history | false |
|---|
| id | get_resource |
|---|
|
|
...
...
...
...
...
 Image Modified
|
|
...
 Image Modified
|
|
...
- Send request, espere pelo resultado e verifique o mesmo.
 Image Modified
|
|
...
Obter todos os recursos de aplicações
...
Irá obter três recursos: menu1, menu2, menu3.
| Deck of Cards |
|---|
| history | false |
|---|
| id | get_all_resources |
|---|
|
|
...
...
...
...
...
 Image Modified
|
|
...
| Card |
|---|
|
 Image Added
|
|
...
- botão Send request, espere pelo resultado e verifique o mesmo.
 Image Modified
|
|
...
| Deck of Cards |
|---|
| history | false |
|---|
| id | delete_by_id |
|---|
|
...
| Card |
|---|
|
- Navegue para Resources → Delete by Id
|
|
...
...
...
 Image Modified
|
|
...
 Image Modified
|
|
...
- 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"
...
Criar dois papéis: "user" e "admin" para a empresa
para a empresa
| Deck of Cards |
|---|
| history | false |
|---|
| id | create_roles |
|---|
|
| Card |
|---|
|
- Navegue para Roles → Create Roles → POST e clique em Request 1.
 Image Added
|
| Card |
|---|
|
- Insira o valor companyId e
|
|
...
- os dados para os papéis "user" e "admin".
 Image Modified
|
|
...
- 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 |
|---|
|
|
...
...
...
...
...
 Image Modified
|
| Card |
|---|
|
- Insira os dados do novo usuário
|
|
...
...
 Image Modified
|
| Card |
|---|
|
- Aguarde os resultados e verifique os mesmos.
 Image Modified
|
|
...
...
...
| Deck of Cards |
|---|
| history | false |
|---|
| id | create_resources_jacob |
|---|
|
| Card |
|---|
|
- Navegue para Resources → Get All Resources of Application → GET e clique em Request 1.
 Image Added
|
|
...
|
- Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId.
 Image Modified
|
|
...
- botão Send request, espere os resultados e verifique o mesmo.
 Image Modified
|
|
...
| Deck of Cards |
|---|
| history | false |
|---|
| id | get_resources_of_user |
|---|
|
|
...
...
- → Assign Resources to User
|
|
...
...
...
...
...
...
...
...
- ID dos recursos "menu1" e "menu2".
 Image Modified
|
|
...
...
...
...
- request, espere pelo resultado e verifique o mesmo.
|
|
...
 Image Added
|
|
Deletar todos os recursos com direitos do usuário "Jacob"
...
| Card |
|---|
|
- Navegue para Entitlements → Unassign all Resources to User
|
|
...
...
...
...
...
...
...
...
- botão Send request, espere pelo resultado e verifique se o mesmo não possui nenhum direito.
|
|
...
Obter todos os recursos que possuam direitos para o usuário "Jacob", irá retornar um erro
...
...
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:
...
...
- menu2" como favorito do usuário "Jacob"
- Obter os favoritos do usuário "Jacob" , irá retornar "menu2"
- Remover os favoritos do usuário "Jacob"
...
Navegue para Users > Create User > POST e clique em Request 1
Image Removed
...
...
| 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
|
|
...
...
Adicionando os recursos "menu1" e "menu2" para o usuário "Jacob"
- Navegue para Entitlements > Assign Resources to User > POST e clique em Request 1
Image Removed - Insira o userId e o id dos recursos "menu1" e "menu2"
Image Removed - Clique no botão send request, espere pelo resultado e verifique o mesmo
Image Removed
...
- recurso "menu2" como favorito
|
|
...
 Image Added
|
|
...
- 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 |
|---|
|
|
...
...
...
...
...
...
 Image Added
|
|
...
...
...
- botão Send request, espere pelo resultado e verifique o mesmo.
|
|
Remover os favoritos do usuário "Jacob"
...
Remover os favoritos do usuário "Jacob"
...
| Deck of Cards |
|---|
| history | false |
|---|
| id | delete_user_favorites |
|---|
|
| Card |
|---|
|
- Navegue para Favorites → Delete user's Favorites
|
|
...
...
...
...
...
...
...
- botão Send request, espere o resultado e verifique o mesmo. Nenhum dado de favoritos irá aparecer.
|
|
Image Removed
| 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> |