Compartilhar via

Criar ou atualizar IDs e segredos do cliente no Partner Center

  • Artigo

Importante

Para continuar a usar o serviço sem interrupções após 1º de março de 2023, você precisa de um inquilino do Microsoft Azure AD/Entra. Acesse as configurações do locatário em sua conta do Partner Center e crie uma nova ID do Microsoft Entra ou associe sua ID atual.

Atualizar um segredo do cliente prestes a expirar em complementos do SharePoint

  1. Gere e adicione um novo segredo do cliente no Partner Center para associá-lo a essa ID de cliente de suplemento específica. Para obter etapas específicas, consulte Gerar outros segredos do cliente.
  2. Atualize seu aplicativo Web remoto para usar o novo segredo do cliente. Para obter mais informações, consulte a seção Atualizar o aplicativo Web remoto no Visual Studio para usar a nova seção do segredo em Substituir um segredo de cliente expirando em um suplemento do SharePoint.
  3. Republice seu aplicativo Web remoto.

Importante

O Microsoft Office Developer Tools para Visual Studio dá suporte à configuração de um segredo de cliente secundário que você pode usar para atualizar o segredo do cliente expirando.

Usar o OAuth para autenticar e autorizar suplementos

O Open Authorization (OAuth) é um protocolo aberto para autorização. O OAuth permite a autorização segura de aplicativos Web e desktop de maneira simples e padrão. Ele permite que os usuários aprovem um aplicativo para agir em seu nome sem compartilhar seu nome de usuário e senha. Por exemplo, os usuários podem compartilhar seus recursos ou dados privados (lista de contatos, documentos, fotos, vídeos e assim por diante) que são armazenados em um site com outro site, sem precisar fornecer suas credenciais (normalmente nome de usuário e senha).

Com o OAuth, os usuários podem autorizar um provedor de serviços (por exemplo, SharePoint) a fornecer tokens em vez de credenciais (por exemplo, nome de usuário e senha) para seus dados que são hospedados por um determinado provedor de serviços (por exemplo, SharePoint). Cada token concede acesso a um site específico (por exemplo, um repositório de documentos do SharePoint), para recursos específicos (por exemplo, documentos de uma pasta) e por uma duração definida. Em seguida, os usuários podem conceder a um site que não seja da Microsoft acesso a informações armazenadas com outro provedor de serviços (por exemplo, SharePoint), sem compartilhar seu nome de usuário e senha e sem compartilhar todos os dados que eles têm no SharePoint.

Se o suplemento exigir esse tipo de autorização, você precisará associar a ID do cliente OAuth e os segredos do cliente ao seu suplemento. Gere segredos do cliente OAuth no Partner Center e adicioná-los ao código do suplemento.

Quando um usuário instala um suplemento que tem uma ID do cliente associada e um segredo do cliente, uma caixa de diálogo de consentimento é exibida. Se o usuário der consentimento, o suplemento poderá agir em nome do usuário para acessar os dados exigidos pelo suplemento. Os usuários só podem conceder as permissões que têm. As concessões representam as permissões que um usuário delega a um complemento.

Por exemplo, seu suplemento pode ser um suplemento de calendário de viagem que é aberto como um IFRAME em um site do Microsoft 365 SharePoint. O OAuth permite que o suplemento identifique o usuário a quem pertence o calendário de viagem. Ou se o suplemento calendário de viagem precisar acessar outros aspectos do Microsoft 365, como recursos ou informações de calendário, ele poderá acessá-los em nome do usuário conectado.

Observação

Para obter mais informações sobre OAuth, ID do cliente e segredos do cliente, consulte Autorização e autenticação de suplementos do SharePoint, fluxo OAuth do token de contexto para suplementos do SharePoint e registro de suplementos do SharePoint 2013 .

Adicionar uma ID do cliente e segredo do cliente OAuth

Você pode associar apenas uma ID de cliente ao suplemento, mas pode associar vários segredos do cliente a uma ID do cliente. Para fins administrativos e de segurança, recomendamos limitar o número de segredos do cliente associados a uma ID do cliente.

Importante

Para enviar um Suplemento do SharePoint que usa o OAuth e distribuí-lo para a China, você deve:

  • Use uma ID de cliente separada e um segredo do cliente para a China.
  • Adicione um pacote de suplemento separado especificamente para a China.
  • Bloqueie o acesso para todos os países/regiões, exceto a China.
  • Crie uma listagem de suplemento separada para a China.

Para obter mais informações sobre como distribuir suplementos para a China, consulte Enviar aplicativos para o Office 365 operados pela 21Vianet na China.

Os dados de entrada para seu suplemento são assinados usando apenas um segredo do cliente de assinatura. No Partner Center, é o segredo do cliente com uma marca de seleção verde ao lado de Ativo na coluna Status na página de IDs do cliente. Se você excluir o segredo do cliente de assinatura usado pelo suplemento, o próximo segredo do cliente válido será usado.

Seu suplemento pode usar quaisquer segredos de cliente válidos como senhas para se comunicar com a Microsoft. Quando um segredo do cliente expira, ele não pode mais ser usado como uma senha. Se houver apenas um segredo do cliente associado à ID do cliente, excluir esse segredo poderá impedir que o suplemento acesse os dados necessários.

Se o suplemento for um serviço e precisar de IDs de cliente OAuth e segredos do cliente, siga estas etapas.

Adicionar uma nova ID do cliente

Importante

A oferta deve ser publicada nas lojas da Microsoft antes de usar as IDs de cliente no ambiente de produção. Não fazer isso pode afetar negativamente a usabilidade do seu aplicativo por seus clientes. Recomendamos que você mova aplicativos não publicados para Soluções do SharePoint, pois os complementos do SharePoint estão sendo descontinuados.

  1. Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.

  2. Na guia Nova ID do cliente, selecione Adicionar nova ID do cliente.

  3. Na caixa de diálogo Nova ID do cliente, forneça as seguintes informações.

    Item Informações a serem fornecidas
    Nome amigável Selecione um nome para ajudá-lo a reconhecer qual suplemento usa a ID do cliente; por exemplo, "aplicativo de calendário"
    Domínio do aplicativo Forneça o domínio no qual o complemento é executado. Por exemplo: app.contoso.com.
    Deve ser um nome de domínio válido que você possui; ele não deve incluir http:// ou https://,
    e não deve ser um nome de domínio internacional
    URL de redirecionamento do aplicativo Forneça o URL de redirecionamento para a qual enviar os usuários depois que eles concordarem com os requisitos de acesso do suplemento na caixa de diálogo de consentimento.
    Essa URL deve começar com https://, http://, ou ms-app://

  4. Selecione Criar segredo agora.

  5. Escolha por quanto tempo o segredo do cliente é válido. As opções são um, dois ou três anos. É recomendável escolher um ano, pois pode ser mais fácil acompanhar dentro de seus processos de negócios do que períodos de tempo mais longos. Mas não há implicação de segurança em escolher dois ou três anos. Quando o segredo do aplicativo estiver expirando, você precisa atualizar seu complemento.

  6. Selecione qual tipo de disponibilidade de segredo do cliente:

    • Essa ID do cliente será usada para um aplicativo disponível em todo o mundo.
    • Essa ID do cliente será usada para um aplicativo disponível apenas na China.

  7. Selecione Criar segredo agora.

  8. Na página Obter segredo do cliente, copie a ID do cliente e o segredo do cliente para um local seguro para que você possa se referir a ela mais tarde.

    Importante

    O segredo do cliente está associado à ID do cliente, mas não é mostrado no Partner Center novamente, portanto, certifique-se de registrá-lo. Além disso, registre as datas de início e término, para que você esteja ciente do período em que o segredo do cliente é válido e da sua data de validade. Se o segredo do cliente estiver perto de expirar, você precisará gerar um novo segredo do cliente e atualizar seu suplemento. Para obter mais informações, consulte Atualizar o segredo do cliente associado à ID do cliente.

  9. Selecione Concluído.

Atualize o segredo do cliente associado à sua ID do cliente

Atualize o segredo do cliente nas seguintes situações:

  • O segredo do cliente está expirando

    Recomendamos que você adicione um novo segredo do cliente no Partner Center enquanto o segredo do cliente atual ainda é válido. Atualize seu suplemento com o novo segredo do cliente e exclua o segredo do cliente que está perto de expirar, escolha Excluir ao lado dessa entrada na página IDs do cliente no Partner Center.

    Observação

    O Microsoft Office Developer Tools para Visual Studio dá suporte à configuração de um segredo de cliente secundário que você pode usar para atualizar o segredo do cliente expirando.

  • A segurança do segredo do cliente está comprometida

    Para responder a um compromisso de segurança rapidamente, excluía o segredo do cliente comprometido do Partner Center primeiro, adicionar um novo segredo do cliente e atualizar seu suplemento com o novo segredo do cliente.

    Importante

    Depois de excluir um segredo do cliente comprometido e antes de adicionar o novo segredo do cliente, o suplemento poderá ficar temporariamente indisponível. Mas esse cenário pode ser melhor do que os impactos comerciais potencialmente graves resultantes de um segredo do cliente perdido ou roubado.

Gerar outros segredos do cliente

  1. Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.

  2. Na guia Identificações de Cliente, selecione a identificação do cliente à qual você deseja associar segredos de outros clientes.

  3. Na página de detalhes da ID do cliente, selecione Novo segredo do cliente.

  4. Escolha por quanto tempo você deseja que o segredo seja válido. As opções são um, dois ou três anos.

  5. Selecione Criar.

  6. Na caixa de diálogo Obter segredo do cliente, copie o segredo do cliente para um local seguro para que você possa se referir a ele mais tarde.

    Importante

    O segredo do cliente está associado à ID do cliente, mas não é mostrado no Partner Center novamente, portanto, certifique-se de registrá-lo. Além disso, registre as datas de início e término para estar ciente do período de validade e da expiração do client secret.

  7. Selecione Concluído.

    Observação

    O novo segredo do cliente está ativo dentro de 15 minutos.

Excluir um segredo de cliente

  1. Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.

  2. Na guia IDs do Cliente, selecione Excluir ao lado da ID do cliente que tem o segredo do cliente que você deseja excluir.

    Importante

    Excluir um segredo do cliente pode impedir o acesso do seu suplemento aos dados necessários, a menos que você tenha criado segredos extras que você valide e associe ao suplemento. Você também deve configurar seu complemento para usar os segredos adicionais do cliente. Se você tiver apenas um segredo do cliente associado à ID do cliente, recomendamos que você gere outro segredo do cliente antes de excluí-lo.

  3. Na caixa de diálogo Confirmação, selecione Excluir.

Excluir uma ID do cliente

Talvez você queira excluir uma ID do cliente em determinadas situações, por exemplo:

  • Você não deseja mais oferecer seu suplemento.
  • Você deseja oferecer uma nova versão do suplemento e não deseja mais oferecer a versão anterior. Nessa situação, talvez você queira excluir a ID do cliente associada à versão anterior do suplemento.

Aviso

Excluir um ID de cliente associado ao suplemento exclui todos os segredos do cliente associados e impede que ele acesse os dados necessários. Qualquer cliente que utiliza seu complemento experimenta indisponibilidade depois que você exclui uma ID de cliente associada a ele.

  1. Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.
  2. Na guia IDs do Cliente, selecione Excluir ao lado da ID do cliente que tem o segredo do cliente que você deseja excluir.
  3. Na caixa de diálogo Confirmação, selecione Excluir.

Para excluir uma ID de cliente, mas continuar oferecendo seu suplemento

  1. Adicione outra ID do cliente e pelo menos um segredo do cliente válido. Para obter detalhes, consulte Adicionar uma ID do cliente e um segredo do cliente.

  2. Exclua a ID do cliente do código.

  3. Exclua a ID do cliente do Partner Center, conforme descrito no procedimento anterior.

  4. Adicione a nova ID do cliente e o segredo do cliente ao seu código.

  5. Na página Visão geral do Produto, escolha Publicar.

    Observação

    Os clientes que usam seu suplemento enfrentam tempo de inatividade durante a atualização de seu código e o processo de aprovação no Partner Center.

Conteúdo relacionado