Obter o consentimento do cliente como fornecedor de Painel de Controle

  • Artigo

Como um CPV (fornecedor de Painel de Controle), você pode usar APIs REST para adquirir e remover o consentimento de seus clientes CSP para obter permissões em seus locatários.

POST https://api.partnercenter.microsoft.com/v1/customers/{<customer_id>}/applicationconsents

Parâmetros do URI

Nome Em Obrigatório Type Descrição
customer_id caminho True string ID do cliente gerado no Partner Center

Cabeçalho da solicitação

Tipos de mídia: application/json

Nome Obrigatório Type Descrição
Autorização True string Token de acesso para público-alvo https://api.partnercenter.microsoft.com
Aceitar True string Tipo de conteúdo aceitável; aplicativo/json de tipo amplamente aceito
ms-correlationid string Usado para acompanhar solicitações internamente. Se uma ms-correlationid não for fornecida, o servidor gerará uma nova para cada solicitação
ms-requestid string Usado para idempotency de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Corpo da solicitação

Tipos de mídia: application/json

Nome Type Descrição
applicationId string ID do aplicativo do parceiro CPV
applicationGrants Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] Lista de concessões de aplicativo para obter o acesso para seus clientes em seu locatário

Respostas

Nome Type Descrição
200 OK Solicitação com êxito. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
201 Criado O consentimento do aplicativo é criado. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
400 Solicitação Inválida Havia entrada ausente ou inválida. O corpo da resposta contém os detalhes do erro. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
401 Não Autorizado A solicitação não foi autenticada. O cliente precisa passar um token de acesso válido para o público-alvo válido. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
403 Proibido A solicitação foi autenticada, mas foi recusada porque o chamador não tem os direitos de invocá-la. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
404 Não Encontrado O recurso não foi encontrado ou não está disponível com os parâmetros de entrada fornecidos. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
Erro interno de servidor 500 O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir a solicitação. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"

Definições

Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant

Nome Type Descrição
enterpriseApplicationId string A representação GUID do recurso que está obtendo acesso
scope string Valores separados por vírgulas do escopo para obter acesso 
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}

Parâmetros do URI

Nome Em Obrigatório Type Descrição
customer_id caminho True string ID do cliente gerado no Partner Center
Application_id caminho True string ID do aplicativo CPV

Cabeçalho da solicitação

Tipos de mídia: application/json

Nome Obrigatório Type Descrição
Autorização True string Token de acesso para público-alvo https://api.partnercenter.microsoft.com
Aceitar True string Tipo de conteúdo aceitável, geralmente digite application/json
ms-correlationid string Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação
ms-requestid string Usado para idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Respostas

Nome Type Descrição
200 OK Solicitação com êxito. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
201 Criado O consentimento do aplicativo é excluído. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
400 Solicitação Inválida Havia entrada ausente ou inválida. O corpo da resposta contém os detalhes do erro. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
401 Não Autorizado A solicitação não foi autenticada. O cliente precisa passar um token de acesso válido para o público-alvo válido. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
403 Proibido A solicitação foi autenticada, mas foi recusada porque o chamador não tem os direitos de invocá-la. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
404 Não Encontrado O recurso não foi encontrado ou não está disponível com os parâmetros de entrada fornecidos. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"
Erro interno de servidor 500 O serviço de API do parceiro ou uma de suas dependências falhou ao atender à solicitação. Os chamadores podem repetir a solicitação. Tipos de mídia: "application/json", "application/xml", "text/xml", "text/json"

Próximas etapas