reportRoot: getCredentialUsageSummary
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Relatar o estado atual de quantos usuários em sua organização usaram os recursos de redefinição de senha de autoatendimento.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegada (conta corporativa ou de estudante) | Reports.Read.All | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Reports.Read.All | Indisponível. |
Para cenários delegados, o usuário de chamada deve ter pelo menos uma das seguintes funções de Microsoft Entra:
- Leitor de Relatórios
- Leitor de segurança
- Administrador de Segurança
- Leitor Global
Solicitação HTTP
GET /reports/getCredentialUsageSummary(period='{periodValue}')
Parâmetros de função
Você deve usar o parâmetro de função a seguir para solicitar um período de tempo para a resposta.
Parâmetro | Tipo | Descrição |
---|---|---|
ponto | Cadeia de caracteres | Obrigatório. Especifica o período em dias para o qual você precisa dos dados de uso. Por exemplo: /reports/getCredentialUsageSummary(period='D30') . Períodos com suporte: D1 , D7 e D30 . O período é insensível ao caso. |
Parâmetros de consulta opcionais
Essa função dá suporte ao parâmetro de consulta OData opcional $filter. Você pode aplicar $filter em uma ou mais das seguintes propriedades do recurso credentialUsageSummary .
Propriedades | Descrição e exemplo |
---|---|
Recurso | Especifica o tipo de dados de uso desejados (registro versus redefinição). Por exemplo: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration' . Operadores de filtro com suporte: eq . |
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e um novo objeto de coleção credentialUsageSummary no corpo da resposta.
Exemplos
O exemplo a seguir mostra como chamar essa API.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade. Todas as propriedades são retornadas de uma chamada real.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getCredentialUsageSummary)",
"value":[
{
"id" : "id-value",
"feature":"registration",
"successfulActivityCount":12345,
"failureActivityCount": 123,
"authMethod": "email"
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de