Adicionando Log-out como Back-end do Serviço API Gateway

Para adicionar back-ends de log-out a uma especificação de implantação de API usando a Console:

1. Crie ou atualize uma implantação de API usando a Console, selecione a opção Criar implantação e informe detalhes na página Informações Básicas.

   Para obter mais informações, consulte Implantando uma API em um Gateway da API Criando uma Implantação de API e Updating an API Gateway.

2. Na página Autenticação, especifique opções de autenticação.

   Para obter mais informações sobre opções de autenticação, consulte Adicionando Autenticação e Autorização a Implantações de API.

3. Na página Rotas, crie uma nova rota e especifique:

   • Caminho: Um caminho para chamadas de API usando os métodos listados para o serviço de back-end. Observe que o caminho da rota que você especificar:

     • é relativo ao prefixo do caminho de implantação (consulte Implantando uma API em um Gateway de API por meio da Criação de uma Implantação de API)
     • deve ser precedido por uma barra ( / ) e pode ser apenas uma barra
     • pode conter várias barras (desde que elas não sejam adjacentes) e pode terminar com uma barra
     • pode incluir caracteres alfanuméricos maiúsculos e minúsculos
     • pode incluir os caracteres especiais $ - _ . + ! * ' ( ) , % ; : @ & =
     • pode incluir parâmetros e curingas (consulte Adicionando Parâmetros de Caminho e Curingas a Caminhos de Rota)
   • Métodos: Um ou mais métodos aceitos pelo serviço de back-end. No caso de back-ends de log-out, somente GET é aceito.

   • Adicionar um único backend ou Adicionar vários backends: Se todas as solicitações devem ser roteadas para o mesmo back end ou para rotear solicitações para backends diferentes de acordo com a variável de contexto e as regras informadas.

     Estas instruções supõem que você deseja usar um único back-end; portanto, selecione Adicionar um único backend. Como alternativa, se você quiser usar back-ends diferentes, selecione Adicionar vários back-ends e siga as instruções em Usando a Console para Adicionar a Seleção de Back-End Dinâmico a uma Especificação de Implantação de API.

   • Tipo de Backend: O tipo do serviço de back-end como Logout.
   • URIs pós-logout permitidos: (opcional) Uma lista de um ou mais URLs permitidos para os quais uma solicitação de logout pode ser redirecionada para revogar tokens. Os URLs na lista podem ser caminhos absolutos ou relativos, e os URLs podem incluir variáveis de contexto. Por exemplo, ["https://${request.header[tenant-id].page.html}", "https://fixed-path.page.html", "/logout_html"].

     Observe o seguinte:

     • Um URL pós-logout pode ser incluído em uma solicitação ao back-end de logout como o valor de um parâmetro de consulta chamado postLogoutUrl.
     • Se você especificar um caminho relativo (ou seja, para outra rota na implantação de API), a implantação de API e a rota deverão permitir acesso anônimo.
     • Se você não incluir explicitamente um ou mais URLs na lista, qualquer URL pós-logout será permitido.
   • Estado pós-log-out: (opcional) Dados a serem informados quando uma solicitação de log-out é redirecionada para um ponto final da sessão final e/ou um URL pós-log-out. Os dados só podem incluir variáveis de contexto (não valores estáticos). Por exemplo, request.query[region]

     Os dados são informados como o valor do parâmetro de consulta state.

4. (Opcional) Selecione Outro URL para informar detalhes de URLs pós-logout adicionais.
5. Selecione Criar para criar a rota.
6. (Opcional) Selecione Adicionar rota para informar detalhes de rotas adicionais.
7. Selecione Próximo para revisar os detalhes informados para a implantação de API.
8. Selecione Criar ou Atualizar para criar ou atualizar a implantação de API.
9. (Opcional) Confirme se a API foi implantada com êxito, chamando-a (consulte Chamando uma API Implantada em um Gateway de API).

Para adicionar back-ends de log-out a uma especificação de implantação de API em um arquivo JSON: 

1. Usando o editor JSON preferencial, edite a especificação existente de implantação da API à qual você deseja adicionar um back-end de log-out ou crie uma nova especificação da implantação da API (consulte Criando uma Especificação de Implantação da API).

   Por exemplo, a seguinte especificação básica de implantação de API define uma função simples sem servidor Hello World no Oracle Functions como um único back-end:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. Na seção routes, inclua uma nova seção para um backend de log-out:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       },
       {
         "path": "<logout-route-path>",
         "methods": ["<method-list>"],
         "backend": {
           "type": "OAUTH2_LOGOUT",
           "allowedPostLogoutUris": ["<url>", "<url"],
           "postLogoutState": "<logout-data>"
         }
       }
     ]
   }

   em que:

   • <logout-route-path> especifica um caminho para chamadas usando os métodos listados para o back-end de log-out. Observe que o caminho da rota que você especificar:

     • é relativo ao prefixo do caminho de implantação (consulte Implantando uma API em um Gateway de API por meio da Criação de uma Implantação de API)
     • deve ser precedido por uma barra ( / ) e pode ser apenas uma barra
     • pode conter várias barras (desde que elas não sejam adjacentes) e pode terminar com uma barra
     • pode incluir caracteres alfanuméricos maiúsculos e minúsculos
     • pode incluir os caracteres especiais $ - _ . + ! * ' ( ) , % ; : @ & =

     • pode incluir parâmetros e curingas (consulte Adicionando Parâmetros de Caminho e Curingas a Caminhos de Rota)

   • <method-list> especifica um ou mais métodos aceitos pelo back-end de log-out, separados por vírgulas. No caso de back-ends de log-out, somente GET é aceito.
   • "type": "OAUTH2_LOGOUT" especifica que o back-end é um back-end de log-out.

   • "allowedPostLogoutUris": ["<url>", "<url>"] especifica opcionalmente uma lista de um ou mais URLs permitidos para os quais uma solicitação de log-out pode ser redirecionada para revogar tokens. Os URLs na lista podem ser caminhos absolutos ou relativos, e os URLs podem incluir variáveis de contexto. Por exemplo, ["https://${request.header[tenant-id].page.html}", "https://fixed-path.page.html", "/logout_html"].

     Observe o seguinte:

     • Um URL pós-logout pode ser incluído em uma solicitação ao back-end de logout como o valor de um parâmetro de consulta chamado postLogoutUrl.
     • Se você especificar um caminho relativo (ou seja, para outra rota na implantação de API), a implantação de API e a rota deverão permitir acesso anônimo.
     • Se você não incluir explicitamente um ou mais URLs na lista, qualquer URL pós-logout será permitido.

   • "postLogoutState": "<logout-data>" especifica opcionalmente dados a serem transmitidos quando uma solicitação de log-out é redirecionada para um ponto final da sessão final e/ou um URL pós-log-out. Os dados só podem incluir variáveis de contexto (não valores estáticos). Por exemplo, request.query[region]

     Os dados são informados como o valor do parâmetro de consulta state.

   Neste exemplo, uma solicitação para o back-end /logout pode incluir um dos URLs especificados para allowedPostLogoutUris como o valor do parâmetro de consulta postLogoutUrl. Quando o URL pós-logout é chamado, o valor da variável de contexto request.query[region] é passado para o URL. Observe que, neste exemplo, um dos valores allowedPostLogoutUris ("/logout_html") é um caminho relativo para o back-end de resposta padrão /logout_html na mesma implantação de API. Como se trata de um caminho relativo para outra rota na mesma implantação de API, o back-end /logout_html deve incluir uma política de autorização do tipo ANONYMOUS, conforme mostrado aqui.

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       },
       {
         "path": "/logout",
         "methods": ["GET"],
         "backend": {
           "type": "OAUTH2_LOGOUT",
           "allowedPostLogoutUris": ["https://${request.header[tenant-id].page.html}", "/logout_html"],
           "postLogoutState": "request.query[region]"
         }
       },
       {
         "path": "/logout_html",
         "methods": ["GET"],
         "backend": {
           "type": "STOCK_RESPONSE_BACKEND",
           "body": "Token could not be revoked."
         },
         "requestPolicies": {
           "authorization": {
             "type": "ANONYMOUS"
           }
         }
       }
     ]
   }

3. Salve o arquivo JSON que contém a especificação de implantação de API.

4. Use a especificação de implantação de API ao criar ou atualizar uma implantação de API das seguintes formas:

   • especificando o arquivo JSON na Console quando você seleciona a opção Fazer Upload de uma API de implantação existente
   • especificando o arquivo JSON em uma solicitação à API REST do serviço API Gateway

   Para obter mais informações, consulte Implantando uma API em um Gateway da API Criando uma Implantação de API e Updating an API Gateway.

5. (Opcional) Confirme se a API foi implantada com êxito, chamando-a (consulte Chamando uma API Implantada em um Gateway de API).