Obtenha o consentimento do cliente como fornecedor do painel de controle
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
Observação
O limite de taxa é de 50 solicitações por segundo (RPS) para cada applicationId (ID do aplicativo do parceiro CPV).
Obter consentimento
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ória | Type | Descrição |
|---|---|---|---|
| Autorização | True | string | Token de acesso para público https://api.partnercenter.microsoft.com |
| Accept | True | string | Tipo de conteúdo aceitável; Tipo amplamente aceito 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 |
Corpo da solicitação
Tipos de mídia: application/json
| Nome | Tipo | Descrição |
|---|---|---|
| applicationId | string | ID do aplicativo do parceiro CPV |
| Subsídios de aplicação | Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] | Lista de concessões de aplicativos para obter acesso para seus clientes em seu locatário |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK | Solicitação com êxito. Tipos de mídia: application/json, application/xml, text/xml, text/json |
|
| 201 - criada | 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 atendeu à 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 | Tipo | Descrição |
|---|---|---|
| Código-de_Aplicação empresarial | string | A representação GUID do recurso que obtém acesso |
| scope | string | Valores separados por vírgula do escopo para obter acesso |
Remover consentimento
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}
Observação
O limite de taxa é de 50 solicitações por segundo (RPS) para cada applicationId (ID do aplicativo do parceiro CPV).
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 seu pedido de CPV |
Cabeçalho da solicitação
Tipos de mídia: application/json
| Nome | Obrigatória | Type | Descrição |
|---|---|---|---|
| Autorização | True | string | Token de acesso para público https://api.partnercenter.microsoft.com |
| Accept | True | string | Tipo de conteúdo aceitável, geralmente tipo application/json |
| ms-correlationid | string | Usado para rastrear solicitações internamente. Se a 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 | Descrição |
|---|---|---|
| 200 OK | Solicitação com êxito. Tipos de mídia: application/json, application/xml, text/xml, text/json |
|
| 201 - criada | 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 não atendeu à solicitação. Os chamadores podem repetir a solicitação. Tipos de mídia: application/json, application/xml, text/xml, text/json |