Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
A API de Gestão de Clientes Web IQ da Microsoft devolve os clientes existentes, contas de faturação Web IQ e AppIDs Web IQ disponíveis para o chamador autenticado. A descoberta não cria uma conta nem concede acesso.
Ponto final:GET https://api.microsoft.ai/v1/customer/authorized-resources
Para os passos de concessão de acesso do administrador e um guia de ponta a ponta, consulte Resultados do Filtro com Escopos.
Autenticação e pedido
As cargas de trabalho utilizam um token portador Microsoft Entra apenas para aplicação solicitado com https://api.microsoft.ai/.default. A identidade da carga de trabalho deve estar ativa e estar CustomerApiAccess presente em cada conta de faturação pretendida. Uma chave API de pesquisa em tempo de execução ou ligação AppID de pesquisa não concede acesso à gestão.
GET /v1/customer/authorized-resources HTTP/1.1
Host: api.microsoft.ai
Authorization: Bearer <access-token>
Accept: application/json
Não é necessário nenhum ID de cliente, ID de conta de faturação ou AppID Web IQ para ligar para a descoberta.
Resposta
HTTP 200 OK devolve um array de objetos cliente. Cada cliente contém um billingAccounts array:
[
{
"customerId": "11111111-1111-4111-8111-111111111111",
"displayName": "Example customer",
"permissions": { "canWrite": false },
"billingAccounts": [
{
"billingAccountId": "22222222-2222-4222-8222-222222222222",
"displayName": "Example billing account",
"isTrial": false,
"permissions": { "canWrite": false },
"appProfiles": []
}
]
}
]
| Campo | Tipo | Description |
|---|---|---|
customerId |
string (UUID) | Identifica o cliente que contém as contas de faturação. Não é o ID usado nas rotas de escopo. |
displayName |
cadeia (de caracteres) | Nome de exibição do cliente ou da conta de faturação. |
billingAccounts |
matriz | Contas de faturação disponíveis para o interlocutor neste cliente. |
billingAccounts[].billingAccountId |
string (UUID) | Use este ID nas rotas de gestão do âmbito. Selecione explicitamente a conta pretendida em vez de tomar automaticamente o primeiro resultado. |
billingAccounts[].isTrial |
boolean | Se a conta de faturação é um período de experiência. Os clientes e contas devem estar ativos; os testes expirados são excluídos. |
billingAccounts[].appProfiles |
matriz | AppIDs do Web IQ e os seus metadados de configuração. Uma conta pode aparecer com um array vazio. |
billingAccounts[].appProfiles[].appId |
cadeia (de caracteres) | Web IQ AppID pertencente à conta de faturação. Não é um ID de aplicação Entra (cliente). |
permissions.canWrite |
boolean | Acesso legado de escrita na configuração de faturação, seja na conta do cliente ou na conta de faturação. Não é um flag de capacidade de escrita de escopo: CustomerApiAccess pode permitir escritas de âmbito quando isto é false. |
Uma carga de trabalho válida mas desconhecida ou não atribuída pode receber 200 OK com []. Isto não é um erro de serviço e pode ocorrer mesmo que a mesma identidade possa chamar a pesquisa. Verifique a sua subvenção de gestão e elegibilidade da conta, em vez de chamar repetidamente a descoberta para fornecer acesso.
Códigos de status
| Status | Meaning | Action |
|---|---|---|
200 |
Hierarquia autorizada existente, possivelmente vazia. | Escolha billingAccounts[].billingAccountId. Se a conta pretendida estiver ausente, peça ao administrador para verificar o par inquilino/cliente, identidade ativa, concessão da conta e elegibilidade da conta. |
400 |
Pedido inválido. | Corrige a entrada. A descoberta é apenas de leitura e não aceita pedidos de provisionamento. |
401 |
Autenticação em falta, expirada ou inválida. | Adquira um token válido apenas para aplicação com https://api.microsoft.ai/.default. |
403 |
O princípio resolvido é inativo ou inconsistente. | Peça ao administrador para verificar a identidade da carga de trabalho e o acesso à conta. |
500 ou 503 |
Falha de serviço ou dependência. | Retry lê com bounced backoff. Não trate isto como um resultado vazio e bem-sucedido. |
Para obter ajuda com falhas persistentes, contacte o Suporte Web IQ com detalhes de pedidos limpos, nunca tokens ou credenciais de aplicação.