Red Hat Summit Red Hat SummitSuporteConsoleDesenvolvedoresComeçar um testeContato

Este conteúdo não está disponível no idioma selecionado.

Chapter 2. Red Hat single sign-on and Red Hat build of Keycloak for the 3scale API Management Admin Portal

This guide provides information about how to configure and use Red Hat single sign-on and Red Hat build of Keycloak with the 3scale API Management Admin Portal.

3scale supports single sign-on (SS0) authentication for your members and administrators.

The 3scale Admin Portal supports the following SSO providers, each which support a number of identity brokering and member federation options:

Note

You can enable multiple SSO member authentication types.

Only users that have been added to Red Hat single sign-on, Red Hat build of Keycloak or Auth0 will be able to access your 3scale Admin Portal through SSO. If you want to further restrict the access by either roles or user groups you should refer to the corresponding step by step tutorials on the Red Hat single sign-on, Red Hat build of Keycloak or Auth0 support portals.

Once you have established SSO through your chosen provider, you must configure it and enable it on the 3scale Admin Portal.

2.1.1. Single sign-on prerequisites
Copiar o link

2.1.2. Auth0 prerequisites
Copiar o link

  • An Auth0 Subscription and account.

2.1.3. Enable Red Hat single sign-on
Copiar o link

As an administrator, perform the following steps in the 3scale Admin Portal to enable Red Hat single sign-on, Red Hat build of Keycloak or Auth0:

  1. Ensure your preferred SSO provider, highlighted in the prerequisites, is properly configured.

  2. Navigate to SSO Integrations in the Account Settings:

    • Click the gear icon in the upper right corner of the page
    • Navigate to Account Settings (gear icon) > Users > SSO Integrations, and click Create a new SSO integration.
  3. Select your SSO provider from the dropdown list.

  4. Enter the required information, provided when you configured your SSO:

    • Client
    • Client Secret
    • Realm or Site
  5. Click Create Authentication Provider
Note

If, during testing, you encounter a callback URL mismatch, add the callback URL shown in the error message to your Auth0 allowed callback URLs.

Once you have configured SSO, members can sign on using the account credentials in connected Identity Providers (IdPs).

Follow these steps to log in to the 3scale API Management Admin Portal using SSO:

  1. Navigate to your 3scale login page: 

    https://<organization>-admin.3scale.net/p/login
    Copy to Clipboard Toggle word wrap
  2. Authorize 3scale with your IdP
  3. If necessary, complete sign up by entering any needed information

Once you successfully sign up, you will have a member account under the application programming interface (API) provider organization, and you will be automatically logged in.

This section describes the redirection to an IdP login window via Red Hat single sign-on. As a 3scale API Management administrator, complete these steps to have your 3scale account accessible through an optional SSO login page.

2.3.1. Prerequisites
Copiar o link

  • 3scale 2.15
  • A Red Hat single sign-on or Red Hat build of Keycloak instance and realm configured as described under the Configuring Red Hat single sign-on section of the Developer Portal documentation.
Note

Before you can integrate Red Hat single sign-on and Red Hat build of Keycloak with 3scale, you must have a working Red Hat single sign-on or Red Hat build of Keycloak instance. Refer to the Red Hat single sign-on documentation for installation instructions: Installing Red Hat single sign-on 7.6 or Red Hat build of Keycloak 24.0 Server guide.

2.3.2. Required steps
Copiar o link

  1. Access and follow the instructions for setting up Red Hat single sign-on under the Red Hat single sign-on and Red Hat build of Keycloak for the 3scale Admin Portal section of the 3scale documentation.

  2. Provide your Red Hat single sign-on or Red Hat build of Keycloak administrator with your 3scale URL that will form the basis for a redirect within single sign-on for your secure logon. Use the following URL format: 

    https://<organization>-admin.3scale.net/auth/<system_name>/bounce
    Copy to Clipboard Toggle word wrap

  3. <system_name> can be fetched via the SSO Integration detail page of the Admin Portal: 

    https://<organization>.3scale.net/p/admin/account/authentication_providers/<ID>
    Copy to Clipboard Toggle word wrap

  4. keycloak_0123456aaaaa can also be found via the SSO Integration detail page in the Callback URL for OAuth flow test field, which looks like the following: 

    https://<organization>.3scale.net/auth/keycloak_0123456aaaaa/callback
    Copy to Clipboard Toggle word wrap
Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat