Partilhar via

Integração do Microsoft Entra SSO com o Redocly

  • Artigo

Neste artigo, você aprenderá como integrar o Redocly ao Microsoft Entra ID. Redocly é a primeira ferramenta de documentação do desenvolvedor que nos permite manter os documentos no GitHub, mantendo os documentos do desenvolvedor perto dos desenvolvedores. Ao integrar o Redocly com o Microsoft Entra ID, você pode:

  • Controle no Microsoft Entra ID quem tem acesso ao Redocly.
  • Permita que seus usuários entrem automaticamente no Redocly com suas contas do Microsoft Entra.
  • Gerencie suas contas em um local central.

Você configurará e testará o logon único do Microsoft Entra para Redocly em um ambiente de teste. O Redocly suporta logon único iniciado pela controladora de armazenamento e provisionamento de usuário Just In Time .

Pré-requisitos

Para integrar o Microsoft Entra ID com o Redocly, você precisa:

Adicionar aplicativo e atribuir um usuário de teste

Antes de iniciar o processo de configuração do logon único, você precisa adicionar o aplicativo Redocly da galeria do Microsoft Entra. Você precisa de uma conta de usuário de teste para atribuir ao aplicativo e testar a configuração de logon único.

Adicione Redocly da galeria de aplicativos do Microsoft Entra para configurar o logon único com o Redocly. Para obter mais informações sobre como adicionar aplicativo da galeria, consulte Guia de início rápido: adicionar aplicativo da galeria.

Criar e atribuir usuário de teste do Microsoft Entra

Siga as diretrizes no artigo Criar e atribuir uma conta de usuário para criar uma conta de usuário de teste chamada B.Simon.

Como alternativa, você também pode usar o Assistente de Configuração de Aplicativo Empresarial. Neste assistente, você pode adicionar um aplicativo ao seu locatário, adicionar usuários/grupos ao aplicativo e atribuir funções. O assistente também fornece um link para o painel de configuração de logon único. Saiba mais sobre os assistentes do Microsoft 365..

Configurar o Microsoft Entra SSO

Conclua as etapas a seguir para habilitar o logon único do Microsoft Entra.

  1. Entre no centro de administração do Microsoft Entra como pelo menos um administrador de aplicativos na nuvem.

  2. Navegue até Identity>Applications>Enterprise applications>Redocly>Single sign-on.

  3. Na página Selecione um método de logon único, selecione SAML.

  4. Na página Configurar logon único com SAML, selecione o ícone de lápis para Configuração Básica de SAML para editar as configurações.

    A captura de tela mostra como editar a Configuração Básica do SAML.

  5. Na seção Configuração Básica do SAML, execute as seguintes etapas:

    a. Na caixa de texto Identificador, digite uma URL usando um dos seguintes padrões:

    Identificador
    https://api.redocly.com/auth/sso?idpId=<CustomerId>
    https://api.<Region>.redocly.com/auth/sso?idpId=<CustomerId>

    b. Na caixa de texto URL de resposta, digite uma URL usando um dos seguintes padrões:

    URL de resposta
    https://api.redocly.com/auth/sso
    https://api.<Region>.redocly.com/auth/sso
    https://<SiteName>.redoc.dev/_auth/saml2
    https://<SiteName>.<REGION>.redoc.dev/_auth/saml2

    c. Na caixa de texto URL de logon, digite uma URL usando um dos seguintes padrões:

    Iniciar sessão no URL
    https://app.redocly.com/login-sso
    https://app.<Region>.redocly.com/login-sso
    https://<SiteName>.redoc.dev/_auth/idp-login
    https://<SiteName>.<REGION>.redoc.dev/_auth/idp-login

    Nota

    Estes valores não são reais. Atualize esses valores com o Identificador real, URL de resposta e URL de logon. Entre em contato com a equipe de suporte da Redocly para obter esses valores. Você também pode consultar os padrões mostrados na seção Configuração Básica de SAML.

  6. Na página Configurar logon único com SAML, na seção Certificado de Assinatura SAML, localize Certificado (PEM) e selecione Download para baixar o certificado e salvá-lo em seu computador.

    A captura de tela mostra o link de download do certificado.

  7. Na seção Configurar Redocly, copie o(s) URL(s) apropriado(s) com base em sua necessidade.

    A captura de tela mostra para copiar o URL apropriado para configuração.

Configurar SSO Redocly

Para configurar o logon único no lado do Redocly , você precisa enviar o certificado baixado (PEM) e as URLs copiadas apropriadas da configuração do aplicativo para a equipe de suporte do Redocly. Eles definem essa configuração para ter a conexão SAML SSO definida corretamente em ambos os lados.

Criar usuário de teste Redocly

Nesta seção, um usuário chamado B.Simon é criado no Redocly. O Redocly oferece suporte ao provisionamento de usuário just-in-time, que é habilitado por padrão. Não há nenhum item de ação para você nesta seção. Se um usuário ainda não existir no Redocly, um novo será normalmente criado após a autenticação.

SSO de teste

Nesta seção, você testa sua configuração de logon único do Microsoft Entra com as seguintes opções.

  • Clique em Testar este aplicativo, isso redirecionará para o URL de logon Redocly onde você pode iniciar o fluxo de login.

  • Vá diretamente para Redocly Sign-on URL e inicie o fluxo de login a partir daí.

  • Você pode usar o Microsoft My Apps. Quando você clica no bloco Redocly em Meus Aplicativos, isso redireciona para URL de Logon Redocly. Para obter mais informações, consulte Microsoft Entra My Apps.

Recursos adicionais

Próximos passos

Depois de configurar o Redocly, você pode impor o controle de sessão, que protege a exfiltração e a infiltração dos dados confidenciais da sua organização em tempo real. O controle de sessão se estende do Acesso Condicional. Saiba como impor o controlo de sessão com o Microsoft Cloud App Security.