Obter o consentimento do cliente como fornecedor do painel de controle
Como um Fornecedor do Painel de Controle (CPV), 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
Nota
O limite de taxa é de 50 solicitações por segundo (RPS) para cada applicationId (ID do aplicativo do parceiro CPV).
Obter consentimento
Parâmetros de URI
| Nome | Em | Necessário | Type | Description |
|---|---|---|---|---|
| customer_id | path | True | string | ID do cliente gerado no Partner Center |
Cabeçalho do pedido
Tipos de suportes: application/json
| Nome | Obrigatório | Type | Description |
|---|---|---|---|
| Autorização | True | string | Token de acesso para o público https://api.partnercenter.microsoft.com |
| Aceitar | True | string | Tipo de conteúdo aceitável; Aplicativo de tipo amplamente aceito/JSON |
| MS-CorrelationID | string | Usado para rastrear 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 |
Corpo do pedido
Tipos de suportes: application/json
| Nome | Tipo | Description |
|---|---|---|
| applicationId | string | ID do pedido do parceiro CPV |
| candidaturasSubvenções | Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] | Lista de concessões de aplicativos para obter o acesso para seus clientes em seu locatário |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK | O pedido foi bem-sucedido. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 201 Criado | O consentimento do aplicativo é criado. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 400 Pedido Incorreto | Havia entrada ausente ou inválida. O corpo da resposta contém os detalhes do erro. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 401 Não Autorizado | O pedido não foi autenticado. O cliente precisa passar um token de acesso válido para um público válido. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 403 Proibido | O pedido foi autenticado, mas foi recusado porque o chamador não tem o direito de invocá-lo. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 404 Não Encontrado | O recurso não é encontrado ou não está disponível com os parâmetros de entrada fornecidos. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 500 Erro de Servidor Interno | 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 suportes: 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 que obtém acesso |
| âmbito | string | Valores separados por vírgulas do escopo para obter acesso |
Remover consentimento
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}
Nota
O limite de taxa é de 50 solicitações por segundo (RPS) para cada applicationId (ID do aplicativo do parceiro CPV).
Parâmetros de URI
| Nome | Em | Necessário | Type | Description |
|---|---|---|---|---|
| customer_id | path | True | string | ID do cliente gerado no Partner Center |
| Application_id | path | True | string | ID do seu pedido de CPV |
Cabeçalho do pedido
Tipos de suportes: application/json
| Nome | Obrigatório | Type | Description |
|---|---|---|---|
| Autorização | True | string | Token de acesso para audiência https://api.partnercenter.microsoft.com |
| Aceitar | True | string | Tipo de conteúdo aceitável, geralmente tipo application/json |
| MS-CorrelationID | string | Usado para rastrear 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 | Tipo | Description |
|---|---|---|
| 200 OK | O pedido foi bem-sucedido. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 201 Criado | O consentimento do aplicativo é excluído. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 400 Pedido Incorreto | Havia entrada ausente ou inválida. O corpo da resposta contém os detalhes do erro. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 401 Não Autorizado | O pedido não foi autenticado. O cliente precisa passar um token de acesso válido para um público válido. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 403 Proibido | O pedido foi autenticado, mas foi recusado porque o chamador não tem o direito de invocá-lo. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 404 Não Encontrado | O recurso não é encontrado ou não está disponível com os parâmetros de entrada fornecidos. Tipos de suportes: application/json, application/xml, text/xml, text/json |
|
| 500 Erro de Servidor Interno | 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 suportes: application/json, application/xml, text/xml, text/json |