Listar educationSynchronizationProfiles (preterido)
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.
Cuidado
A API do Perfil de Sincronização de Educação foi preterida e deixará de devolver dados a 31 de dezembro de 2024. Para obter informações sobre como migrar para a nova API de Dados do Setor, veja Transição do School Data Sync (Clássico).
Obtenha a coleção de perfis de sincronização de dados escolares no inquilino.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
Delegado (conta corporativa ou de estudante) | EduAdministration.Read | EduAdministration.ReadWrite |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | EduAdministration.Read.All | EduAdministration.ReadWrite.All |
Solicitação HTTP
GET /education/synchronizationProfiles
Parâmetros de consulta opcionais
Este método suporta os seguintes Parâmetros de Consulta OData para ajudar a personalizar a resposta: $filter, $orderby, $top, $skip e $count.
Cabeçalhos de solicitação
Nome | Tipo | Descrição |
---|---|---|
Autorização | string | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, este método devolve um 200 OK
código de resposta e uma coleção de objetos educationSynchronizationProfile no corpo da resposta.
Exemplo
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/education/synchronizationProfiles
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"displayName": "Test Profile",
"state": "provisioned",
"id": "15e9b9fa-de85-492e-aa44-550c40de626e",
"dataProvider": {
"@odata.type": "microsoft.graph.educationCsvDataProvider",
"customizations": {
"school": {
"optionalPropertiesToSync": [
"School NCES_ID",
"State ID",
"GradeLow",
"GradeHigh",
"Principal Name"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"section": {
"optionalPropertiesToSync": [],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"student": {
"optionalPropertiesToSync": [
"State ID",
"Email",
"Middle Name"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacher": {
"optionalPropertiesToSync": [
"Teacher Number",
"Middle Name"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"studentEnrollment": {
"synchronizationStartDate": "0001-01-01T00:00:00Z",
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacherRoster": {
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
}
}
},
"identitySynchronizationConfiguration": {
"@odata.type": "microsoft.graph.educationIdentityCreationConfiguration",
"userDomains": [
{
"appliesTo": "student",
"name": "testschool.edu"
},
{
"appliesTo": "teacher",
"name": "testschool.edu"
}
]
},
"licensesToAssign": [
{
"@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment",
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment",
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}
]
}