Criar ou atualizar IDs e segredos do cliente no Partner Center

Artigo
12/20/2023

Aviso

O serviço de gerenciamento de ID de Cliente do SharePoint está passando por uma alteração crítica. Você precisará de um locatário do Microsoft Azure AD/Entra para continuar a usar o serviço sem interrupções após 1º de março de 2023. Vá para as configurações do locatário em sua Conta do Partner Center e crie uma nova ID do Entra ou associe sua ID atual para continuar usando o serviço.

Para atualizar segredos do cliente expirando em suplementos do SharePoint

Gere e adicione um novo segredo do cliente no Partner Center para associar a essa ID de cliente de suplemento específica. Para obter etapas específicas, consulte Para gerar segredos adicionais do cliente em Atualizar o segredo do cliente associado à ID do cliente posteriormente neste artigo.
Atualize seu aplicativo Web remoto para usar o novo segredo do cliente. Para obter informações sobre como fazer isso usando o Microsoft Office Developer Tools para Visual Studio, consulte Atualizar o aplicativo Web remoto no Visual Studio para usar o novo segredo em Substituir um segredo do cliente expirando em um Suplemento do SharePoint.
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.

Usando 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 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 de terceiros 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 delegadas por um usuário a um suplemento.

Por exemplo, seu suplemento pode ser um suplemento de calendário de viagem que é aberto como um IFRAME em um Site do SharePoint do Microsoft 365. O OAuth permitiria que o suplemento identificasse o usuário a quem pertence o calendário de viagem, ou se o suplemento de calendário de viagem precisasse acessar outros aspectos do Microsoft 365, como recursos ou informações de calendário, ele poderia 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 do OAuth de Token de Contexto para Suplementos do SharePoint e Registrar 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.
Bloquear o acesso para todos os países/regiões, exceto 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, esse é o segredo do cliente com uma marca de seleção verde ao lado de Active na coluna Status na página 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.

Para adicionar uma ID do cliente

Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.
Na guia Nova ID do cliente, selecione Adicionar nova ID do cliente.

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 usará essa ID de cliente; Por exemplo, "aplicativo de calendário"
Domínio do aplicativo	Forneça o domínio no qual o suplemento será executado. Por exemplo: `app.contoso.com`. Esse 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://`

Selecione Criar segredo agora.
Escolha por quanto tempo o segredo do cliente será válido. As opções são um, dois ou três anos. É recomendável escolher um ano, pois isso pode ser mais fácil de acompanhar em seus processos de negócios do que períodos de tempo mais longos. No entanto, não há impacto na segurança na escolha de dois ou três anos. Quando o segredo do cliente estiver expirando, você precisará atualizar seu suplemento.
Selecione a disponibilidade do segredo do cliente. Selecione uma destas opções:
- 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.
Selecione Criar segredo agora.
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 será mostrado no Partner Center novamente. Você também deve registrar as datas de início e término, para que esteja ciente do período de validade do segredo do cliente e 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.
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 que o segredo do cliente comprometido for excluído e antes que o novo segredo do cliente seja adicionado, seu suplemento poderá ficar temporariamente indisponível. Isso pode ser aceitável dependendo da gravidade do impacto nos negócios de um segredo de cliente perdido ou roubado.

Para gerar segredos adicionais do cliente

Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.
Na guia IDs do cliente, selecione a ID do cliente à qual você deseja associar segredos adicionais do cliente.
Na página de detalhes da ID do cliente, selecione Novo segredo do cliente.
Escolha por quanto tempo você deseja que o segredo seja válido. As opções são um, dois ou três anos.
Selecione Criar.
Copie o segredo do cliente mostrado na caixa de diálogo Obter 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 será mostrado no Partner Center novamente. Registrar as datas de início e término, para que esteja ciente do período de validade do segredo do cliente e sua data de validade.
Selecione Concluído.

Observação

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

Para excluir um segredo do cliente

Entre no Partner Center com sua conta de desenvolvedor e vá para a página Visão geral do produto para seu suplemento.
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 que seu suplemento acesse os dados necessários, a menos que você tenha criado segredos adicionais que sejam válidos e associados ao seu suplemento, e você o configurou para usar esses segredos adicionais do cliente. Se você tiver apenas um segredo do cliente associado à ID do cliente, recomendamos que você gere um segredo de cliente adicional antes de excluí-lo.
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 uma ID do cliente associada ao suplemento exclui todos os segredos do cliente associados e impede que ele acesse os dados necessários. Qualquer cliente que usa seu suplemento terá tempo de inatividade depois que você excluir uma ID do cliente associada a ele.

Para excluir uma ID do cliente

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

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

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.
Exclua a ID do cliente do código.
Exclua a ID do cliente do Partner Center, conforme descrito no procedimento anterior.
Adicione a nova ID do cliente e o segredo do cliente ao seu código.
Na página Visão geral do Produto, escolha Publicar.

Observação

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

Share via