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.

  1. Faça o download do aplicativo SoapUI em http://sourceforge.net/projects/soapui/files/
  2. Abra o aplicativo SoapUI
  3. Faça o download do projeto teste CloudPass-Rest-soapui-project.xml
  4. Importe o projeto teste CloudPass-Rest-soapui-project.xml
  5. Clique em File->Import Project
  6. Selecione o arquivo CloudPass-Rest-soapui-project.xml

 

 

Cliente SOAP para Windows

 

O projeto importado possuí exemplo de dados e chamadas das APIs. Para entender a estrutura da API, nós podemos olhar 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:

1 é o nome da API e seu caminho relativo

2 é o método HTTP da API

3 é o link da janela de requisição, de um duplo-clique para abrir a janela de detalhes da API.

 

 

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 4 funções: Create, get, update and delete.

 

 

Esta sessão irá utilizar 6 passos para demonstrar essas funções.

 

Criar um novo Usuário

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

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

  3. Verifique o retorno clicando na aba JSON

Obter dados do usuário pelo id

  1. Navegue para Users > Create User > GET e clique em Request 1

  2. Insira o valor do userId na área de parâmetros de url
  3. Clique no botão send request, espere pelo resultado e verifique o mesmo.

 

 

Atualizar usuário

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

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

  3. Clique no botão send request, espere pelo resultado e então verifique o mesmo.

 

Remover usuário pelo userId

  1. Navegue para Users > Update User > DELETE e clique em Request 1

  2. Insira o userId

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

 

 

Obter um usuário removido retorna um erro

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

 

APIs de Recursos

 

 

APIs de Recursos

Recursos são implementados para serem utilizados como opções de menu, mas podem ser extendidos 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 três recursos: menu1, menu2, menu3 para aplicação
    • Obter o recurso menu1 pelo id
    • Obter todos os recursos de aplicações, irá obter três recursos: menu1, menu2, menu3
    • Remover o recurso menu1 pelo id
    • Obter o recurso menu1 pelo id, irá retornar uma mensagem de erro
    • Obter todos os recursos de aplicações, irá obter dois recursos: menu2, menu3
    • Remover todos os recursos de aplicações
    • Obter todos os recursos de aplicações, não irá obter nenhum recurso

 

Criar três recursos: menu1, menu2, menu3 para aplicação

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

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

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

 

 

Obter o recurso menu1 pelo id

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

  2. Insira o id do menu1
  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

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

  2. Insira o applicationId

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

 

Remova o recurso menu1 pelo id

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

  2. Insira o id do recurso menu1
  3. Clique no botão send request, espere pelo resultado e verifique o mesmo.
    • Obter o recurso menu1 pelo id, irá retornar uma mensagem de erro
    • Obter todos os recursos de aplicações, irá obter dois recursos: menu2, menu3
    • Remover todos os recursos de aplicações
    • Obter todos os recursos de aplicações, não irá obter nenhum recurso

 

 

 

APIs de Papéis

 

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

Este cenário de testes inclui os seguintes testes de caso:

    • Criar dois papéis: "user" e "admin" para a empresa
    • Obter o papel user pelo id
    • Obter todos os papéis da empresa, irá retornar dois papéis: "user", "admin"
    • Remover o papel "user" pelo id
    • Obter o papel "user" pelo id, irá retornar uma mensagem de erro
    • Obter todos os papéis da empresa, irá retornar um papel: "admin"
    • Remover todos os papéis de uma empresa
    • Obter todos os papéis da empresa, irá retornar um erro

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

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

  2. Insira o valor companyId e os dados para os papéis "user" e "admin"
  3. Clique no botão send request, espere pelos resultados e verifique o retorno.
    • Obter o papel user pelo id
    • Obter todos os papéis da empresa, irá retornar dois papéis: "user", "admin"
    • Remover o papel "user" pelo id
    • Obter o papel "user" pelo id, irá retornar uma mensagem de erro
    • Obter todos os papéis da empresa, irá retornar um papel: "admin"
    • Remover todos os papéis de uma empresa
    • Obter todos os papéis da empresa, irá retornar um erro

 

APIs de Direitos

Direitos é 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"
  • Get all resources which entitled to user "Jacob", will get "menu1", "menu2"
  • Delete all entitled resources from user "Jacob"
  • Get all resources which entitled to user "Jacob", will get error

Create user "Jacob"

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

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

  3. Aguarde os resultados e verifique os mesmos

 

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

  1. Navegue para Resources > Create Resource > GET e clique em Request 1

  2. Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId
  3. Clique no botão send request, espere os resultados e verifique o mesmo.

 

 

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

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

  2. Insira o userId e o valor do id dos recursos "menu1" e "menu2"
  3. Clique no botão send request, espere pelo resultado e verifique o mesmo

 

Adicione para o usuário "Jacob" o recurso "menu2" como favorito

  1. Navegue para Entitlements > Get Resources of User > GET e clique em Request 1

  2. Insira o userId

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

 

 

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

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

  2. Insira o userId

  3. Clique no 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

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

  2. Insira o userId

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

 

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:


  • Criar o usuário "Jacob"
  • Criar os recursos "menu1", "menu2" e "menu3"
  • Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"
  • Adicionar o recurso "menu" como favorito do usuário "Jacob"
  • Obter os favoritos do usuário "Jacob" , irá retornar "menu2"
  • Remover os favoritos do usuário "Jacob"
  • Obter os favoritos do usuário "Jacob", irá retornar uma mensagem de erro

Navegue para Users > Create User > POST e clique em Request 1


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

Passo 1) Navegue para Favorites > Get user's Favorites > GET e clique em Request 1

 

 

 

Passo 2) Insira os dados do novo usuário, e clique no botão send

 

Passo 3) Espere o resultado e verifique o mesmo.

 

 

 

Crie os recursos "menu1", "menu2" e "menu3"

Passo 1) Navegue para Resources > Get All Resources of Application > GET e clique em Request 1

 

 

 

Passo 2) Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

Passo 1) Navegue para Entitlements > Assign Resources to User > POST e clique em Request 1

 

 

 

Passo 2) Insira o userId e o id dos recursos "menu1" e "menu2"

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

Passo 1) Navegue para Favorites > Add Favorites to User > POST e clique em Request 1

 

 

 

Passo 2) Insira o userId e o id recurso "menu2" como favorito

 

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

Passo 1) Navegue para Favorites > Get user's Favorites > GET e clique em Request 1

 

 

 

Passo 2) Insira o userId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

Remover os favoritos do usuário "Jacob"

Passo 1) Navegue para Favorites > Delete user's Favorites > DELETE e clique em Request 1

 

 

 

Passo 2) Insira o userId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

Remover os favoritos do usuário "Jacob"

 

Passo 1) Navegue para Favorites > Delete user's Favorites > DELETE e clique em Request 1

 

 

Passo 2) Insira o userId

 

 

 

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

 

 

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