Partilhar via


Obter o consentimento do cliente como Fornecedor Painel de Controlo

Como Fornecedor de Painel de Controlo (CPV), pode utilizar as APIs REST para adquirir e remover o consentimento dos seus clientes CSP para obter permissões nos respetivos inquilinos.

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

Parâmetros URI

Name Em Necessário Tipo Description
customer_id caminho Verdadeiro string ID do cliente gerado no Centro de Parceiros

Cabeçalho do pedido

Tipos de multimédia: application/json

Name Necessário Tipo Description
Autorização Verdadeiro string Token de Acesso para público-alvo https://api.partnercenter.microsoft.com
Aceitar Verdadeiro string Tipo de conteúdo aceitável; tipo de aplicação/json amplamente aceite
ms-correlationid string Utilizado para controlar os pedidos internamente. Se não for fornecido um ms-correlationid, o servidor irá gerar um novo para cada pedido
ms-requestid string Utilizado para idempotência de pedidos. Se não for fornecido um ms-requestid, o servidor irá gerar um novo para cada pedido

Corpo do pedido

Tipos de multimédia: application/json

Nome Tipo Description
applicationId string ID da Aplicação do parceiro CPV
applicationGrants Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] Lista de concessões de aplicações para obter o acesso dos seus clientes no respetivo inquilino

Respostas

Nome Tipo Description
200 OK O pedido foi esclarido com êxito. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
201 Criado O consentimento da aplicação é criado. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
400 Pedido Incorreto Havia entradas em falta ou inválidas. O corpo da resposta contém os detalhes do erro. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
401 Não Autorizado O pedido não foi autenticado. O cliente tem de transmitir um token de acesso válido para uma audiência válida. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
403 Proibido O pedido foi autenticado, mas foi recusado porque o autor da chamada não tem o direito de invocá-lo. Tipos de Multimé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 especificados. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
Erro Interno do Servidor 500 O serviço de API de parceiro ou uma das respetivas dependências não cumpriu o pedido. Os autores da chamada podem repetir o pedido. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"

Definições

Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant

Nome Tipo Description
enterpriseApplicationId string A representação GUID do recurso a obter acesso
scope string Valores separados por vírgulas do âmbito para obter acesso
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}

Parâmetros URI

Name Em Necessário Tipo Description
customer_id caminho Verdadeiro string ID do cliente gerado no Centro de Parceiros
Application_id caminho Verdadeiro string ID da sua aplicação CPV

Cabeçalho do pedido

Tipos de multimédia: application/json

Name Necessário Tipo Description
Autorização Verdadeiro string Token de acesso para a audiência https://api.partnercenter.microsoft.com
Aceitar Verdadeiro string Tipo de conteúdo aceitável, geralmente escreva application/json
ms-correlationid string Utilizado para controlar os pedidos internamente. Se não for fornecido um ms-correlationid , o servidor irá gerar um novo para cada pedido
ms-requestid string Utilizado para idempotência de pedidos. Se não for fornecido um ms-requestid, o servidor irá gerar um novo para cada pedido

Respostas

Nome Tipo Description
200 OK O pedido foi esclarido com êxito. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
201 Criado O consentimento da aplicação é eliminado. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
400 Pedido Incorreto Havia entradas em falta ou inválidas. O corpo da resposta contém os detalhes do erro. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
401 Não Autorizado O pedido não foi autenticado. O cliente tem de transmitir um token de acesso válido para uma audiência válida. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
403 Proibido O pedido foi autenticado, mas foi recusado porque o autor da chamada não tem o direito de invocá-lo. Tipos de Multimé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 especificados. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"
Erro Interno do Servidor 500 O serviço de API de parceiro ou uma das respetivas dependências não cumpriu o pedido. Os autores da chamada podem repetir o pedido. Tipos de Multimédia: "application/json", "application/xml", "text/xml", "text/json"

Passos seguintes