Domínios de Identidade do OCI com Postman

Para executar este tutorial, você deve ter o seguinte:

• Acesso a um domínio de identidades com a atribuição de administrador de domínios de identidades. Certifique-se de ter os seguintes valores:
  • O nome da tenancy, o nome do domínio de identidades e as credenciais (nome de usuário e senha) para acessar uma tenancy na Console do Oracle Cloud Infrastructure com um domínio de identidades.
  • O URL do domínio mostrado na página de detalhes do domínio de identidades após o acesso. Por exemplo, https://<idcs-letterandnumberstring>.identity.oraclecloud.com. Se precisar de ajuda para localizar o URL do domínio, consulte Localizando um URL do Domínio de Identidades na documentação. O URL do domínio de identidades é usado para construir uma solicitação REST.
• Familiaridade com o estilo de arquitetura REST
• O aplicativo para desktop Postman instalado.
  • A familiaridade com o Postman não é necessária.
  • Crie uma conta Postman. É necessária uma conta para usar variáveis de ambiente.
  • (Opcional) Criar um espaço de trabalho no Postman.

Para autenticar uma chamada de API REST em um domínio de identidades, registre um aplicativo cliente OAuth no domínio de identidades.

Esta tarefa é necessária para obter as credenciais (ID do cliente e segredo do cliente) que são usadas para autenticação. As credenciais são equivalentes às credenciais de serviço (ID e senha) que o cliente usa para se comunicar com um domínio de identidades. Essa tarefa também ajuda a determinar quais solicitações são autorizadas por meio da API REST.

1. Abra o menu de navegação e selecione Identidade e Segurança. Em Identidade, selecione Domínios.
2. Selecione o nome do domínio de identidades no qual você deseja trabalhar. Talvez você precise alterar o compartimento para localizar o domínio desejado.
3. Na página de detalhes do domínio, selecione Aplicativos integrados.
4. Selecione Adicionar aplicativo.
5. Na caixa de diálogo Adicionar aplicativo, selecione Aplicativo Confidencial e, em seguida, Iniciar workflow.
6. Na etapa Adicionar detalhes do aplicativo do workflow, informe um nome e uma descrição do aplicativo e selecione Próximo.
7. Na etapa Configurar OAuth, execute as seguintes ações:
   1. Na caixa Configuração do cliente, selecione Configurar este aplicativo como um cliente agora.

      A caixa se expande, mostrando mais opções.

   2. Em Autorização, selecione apenas Credenciais do Cliente como o tipo de concessão permitido.
   3. Role até o final da caixa. Selecione Adicionar atribuições de aplicativo e, em seguida, selecione Adicionar atribuições.
   4. No painel Adicionar atribuições de aplicativo, selecione Administrador de Domínio de Identidades e, em seguida, selecione Adicionar.
8. Na etapa Configurar OAuth, selecione Próximo e, em seguida, selecione Concluir.

   Você pode ignorar a etapa de configuração da política neste tutorial.

   Quando o aplicativo é criado, seu estado inicial é Inativo.

9. Na página Detalhes do aplicativo, selecione Ativar. Em seguida, selecione Ativar aplicativo para confirmar a ativação desse aplicativo.
10. Na página de detalhes do aplicativo, role para baixo até Informações Gerais e siga estas etapas para copiar o ID do cliente e os valores de segredo do cliente.
    1. Destaque o valor exibido ao lado de ID do Cliente e copie o valor para um arquivo de texto.
    2. Em Segredo do Cliente, selecione Mostrar segredo. Na caixa de diálogo exibida, selecione Copiar e, em seguida, Fechar. O valor é copiado para a área de transferência. Cole o valor em um arquivo de texto.
    3. Armazene o ID do cliente e os valores de segredo do cliente que você copiou em um local seguro.

Para executar este tutorial com sucesso no Postman, importe as amostras de variáveis REST idcs-rest-clients e defina os parâmetros do ambiente.

1. Abra o aplicativo de desktop Postman e faça login usando sua conta. Se você tiver um espaço de trabalho, selecione Espaço de Trabalho e o espaço de trabalho. Caso contrário, você poderá usar o espaço de trabalho padrão.
2. No espaço de trabalho, selecione Importar.
3. Na caixa de diálogo Importar, cole o seguinte URL de variáveis de ambiente GitHub no campo.

   https://github.com/oracle/idm-samples/raw/master/idcs-rest-clients/example_environment.json

   Postman começa a importar assim que você colar o URL. Quando a importação estiver concluída, selecione Descartar para fechar a caixa de mensagem.

4. Na barra lateral à esquerda, selecione Ambientes. Clique com o botão direito do mouse em Ambiente de Exemplo do Oracle Identity Cloud Service com Variáveis e selecione Duplicar.
5. Na lista de ambientes, clique com o botão direito do mouse em Ambiente de Exemplo do Oracle Identity Cloud Service com Cópia de Variáveis que aparece abaixo do ambiente original e selecione Renomear. No campo, digite Environment A for REST API Testing e pressione Enter.
6. Para atualizar as variáveis no ambiente renomeado, informe os seguintes valores nos campos Valor Inicial e Valor Atual.
   • HOST: O URL do domínio obtido na página de detalhes do domínio de identidades após o acesso à Console do Oracle Cloud Infrastructure. Por exemplo, https://<idcs-letterandnumber123string>.identity.oraclecloud.com. Se precisar de ajuda para localizar o URL do domínio, consulte Localizando um URL do Domínio de Identidades na documentação.
   • CLIENT_ID e CLIENT_SECRET: O ID do cliente e o segredo do cliente que você copiou em um arquivo de texto do aplicativo confiável do domínio de identidades, conforme descrito na tarefa do tutorial Registrar um Aplicativo Cliente.
   • USER_LOGIN e USER_PW: Seu nome de usuário e senha de log-in
     
     
     
     
7. Selecione Salvar.
8. Na lista de ambientes, selecione a marca de seleção no nome Environment A for REST API Testing para torná-lo o ambiente ativo.

   O ambiente ativo é mostrado no seletor de ambiente no canto superior direito do workbench.

Para executar este tutorial com sucesso no Postman, importe a coleção REST_API_for_Oracle_Identity_Cloud_Service, que contém solicitações de API de amostra que podem ser usadas para fazer chamadas.

1. No espaço de trabalho do Postman, selecione Importar.
2. Na caixa de diálogo Importar, cole o URL a seguir no campo para importar a coleção Postman da API REST de domínios de identidades.

   https://github.com/oracle/idm-samples/raw/master/idcs-rest-clients/REST_API_for_Oracle_Identity_Cloud_Service.postman_collection.json

   O Postman começa a importar assim que a coleção é colada. Quando a importação estiver concluída, você poderá selecionar Descartar para fechar a caixa de mensagem.

3. Na barra lateral à esquerda, selecione Coleções.
4. Selecione o nome REST_API_for_Oracle_Identity_Cloud_Service.

   As solicitações na coleção são organizadas em pastas.

   
   
   
   
   

Para fazer chamadas de API para um domínio de identidades, autentique o cliente no domínio de identidades e, em seguida, obtenha um token de acesso OAuth.

Esse token fornece uma sessão entre um cliente (neste tutorial, Postman) e o domínio de identidades.

1. Na barra lateral à esquerda, selecione Coleções. Expanda REST_API_for_Oracle_Identity_Cloud_Service, se não estiver expandido.
2. Expanda OAuth e depois Tokens.
3. Em Tokens, selecione POST - Obter access_token (credenciais do cliente).

   A guia POST da API é exibida no workbench. O painel de solicitações da API é separado do painel de respostas por uma linha. Você pode arrastar a linha separadora para mostrar mais ou menos de cada painel.

   No painel de solicitações, o campo URL mostra: POST {{HOST}}/oauth2/v1/token

   As variáveis para {{HOST}}, acesso e credenciais de autenticação já estão definidas quando você concluiu a tarefa do tutorial Definir os Parâmetros de Ambiente no Postman.

4. Selecione Enviar.

   No visualizador de resposta, confirme se o status 200 OK aparece e se o token de acesso é retornado no corpo da resposta. Um token de acesso é uma string muito longa de letras e números.

5. Para atribuir o valor do token de acesso a uma variável de ambiente, use as etapas a seguir.
   1. Na resposta, destaque o conteúdo do token de acesso que está entre as aspas e clique com o botão direito do mouse. No menu de atalho, selecione Definir: Ambiente A para Teste de API REST e, em seguida, selecione access_token no menu secundário para designar o conteúdo destacado como o valor do ambiente de token de acesso.
      
      
      
      
   2. No canto superior direito do workbench, selecione o ícone para abrir o painel de variáveis.

      O valor access_token designado é mostrado em Todas as variáveis.

      
      
      
      
      
6. Para fechar o painel de variáveis, selecione X no canto superior direito do painel ou selecione o ícone de variáveis.

Se você enviar a próxima chamada da API REST para o domínio de identidades antes de o token expirar, a chamada da API conterá o token de acesso e outras informações relacionadas à solicitação. As informações REST são enviadas por meio de um Identificador de Recurso Universal de solicitação, um cabeçalho, parâmetros ou código JSON e variam de acordo com a chamada e o método da API REST que você solicita.

Esta tarefa pressupõe que você solicitou um token de acesso na última hora.

Se necessário, solicite um novo token antes de criar um usuário.

1. Na barra lateral à esquerda, selecione Coleções. Expanda Usuários e, em seguida, Criar.
2. Em Criar, selecione Criar um usuário.

   A guia POST da API é exibida no workbench.

3. Selecione a guia Corpo.

   O exemplo usa o modo bruto e o formato JSON para os dados do corpo.

   
   
   
   
   
4. Selecione Enviar.

   • No visualizador de resposta, confirme se o status 201 Created aparece e se o corpo da resposta contém detalhes sobre o usuário que foi criado com sucesso no domínio de identidades.

   • Se o status 401 Unauthorized for exibido, com a mensagem de erro Proper authorization is required for this area, solicite um novo token de acesso e tente criar o usuário novamente.

5. No corpo da resposta de uma criação bem-sucedida, role para baixo até a linha 40, que tem o valor do OCID do usuário que foi criado.

   Por exemplo: ocid1.user.oc1..aabaaacaaaq7xxxxxx

6. Destaque o valor do OCID que está entre aspas duplas. No menu de atalho, selecione Definir: Ambiente A para Teste de API REST e, em seguida, selecione id do usuário no menu secundário.
7. No canto superior direito do workbench, selecione o ícone para abrir o painel de variáveis.

   O valor userid designado é mostrado em Todas as variáveis.

Essa tarefa recupera os detalhes de um usuário específico usando a variável userid.

O procedimento a seguir pressupõe que você tenha concluído a tarefa anterior Create a User.

1. Na barra lateral à esquerda, selecione Coleções. Expanda Usuários e depois Pesquisar.
2. Em Pesquisar, selecione Obter um usuário específico.

   A guia GET da API é exibida no workbench.

3. Selecione Enviar.

   • Se bem-sucedido, confirme se o status 200 OK aparece no visualizador de resposta. Você também deverá ver detalhes sobre esse usuário específico na guia Corpo.

   • Se você vir o status 401 Unauthorized com a mensagem de erro Proper authorization is required for this area, solicite um novo token de acesso e tente recuperar o usuário específico novamente.

Esta tarefa exclui um usuário especificado pela variável userid.

O procedimento a seguir pressupõe que você tenha concluído as tarefas do tutorial Criar um Usuário e Obter um Usuário.

Se necessário, solicite um novo token de acesso antes de executar esta tarefa.

1. Na barra lateral à esquerda, selecione Coleções. Expanda Usuários e depois Excluir.
2. Selecione Excluir usuário.

   A guia DELETE da API é exibida no workbench.

3. No canto superior direito do workbench, selecione o ícone para abrir o painel de variáveis.

   Em Todas as variáveis, confirme se a variável userid ainda mostra o mesmo valor de OCID que foi usado para recuperar os detalhes do usuário.

4. Selecione Enviar.

   • Se bem-sucedido, confirme se o status 204 No content aparece no visualizador de resposta. A guia Corpo está em branco porque nenhum corpo de resposta é retornado para uma operação DELETE.

   • Se você vir o status 401 Unauthorized com a mensagem de erro Proper authorization is required for this area, solicite um novo token de acesso e tente excluir o usuário específico novamente.

5. Quando a exclusão for bem-sucedida, selecione a guia GANHAR um usuário específico no workbench. Em seguida, selecione Enviar.

   No visualizador de resposta, confirme se o status 404 Not found é exibido, o que indica que o usuário foi excluído.

Para explorar diretrizes para criar solicitações e casos de uso típicos usando APIs REST de domínios de identidades da OCI, consulte:

• Estruturando Solicitações de Recursos
• Casos de Uso de API