Tipo de recurso educationUser
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.
Representa um utilizador no sistema. Este recurso é uma variante específica da educação do recurso de utilizador padrão, com o mesmo id que o Microsoft Graph devolve do ponto final não específico /users da educação.
Este objeto fornece um subconjunto direcionado de propriedades do objeto de utilizador principal e adiciona um conjunto de propriedades específicas da educação, como primaryRole, studente teacher.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Obter usuário | educationUser | Leia as propriedades e relações de um objeto educationUser. |
| Listar classes | Coleção educationClass | Obtenha a coleção de objetos educationClass da qual o usuário é membro. |
| Listar escolas | Coleção educationSchool | Obtenha a coleção de objetos educationSchool da qual o usuário é um membro. |
| Obter usuário | user | Obtenha o user do diretório simples que corresponde a esse educationUser. |
| Atualizar | educationUser | Atualize um objeto educationUser. |
| Excluir usuário | Nenhum | Exclua um objeto educationUser. |
| Obter delta | Coleção educationUser | Obter alterações incrementais para educaçãoUtilizadores. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| id | String | O identificador exclusivo do usuário. Herdado de directoryObject. Chave. Não anulável. Somente leitura. |
| accountEnabled | Booliano | True se a conta estiver habilitada; caso contrário, false. Essa propriedade é obrigatória quando um usuário é criado. Oferece suporte a $filter. |
| assignedLicenses | Coleção assignedLicense | As licenças que são atribuídas ao usuário. Não anulável. |
| assignedPlans | Coleção assignedPlan | Os planos que são atribuídos ao usuário. Somente leitura. Não anulável. |
| businessPhones | Coleção de cadeias de caracteres | Números de telefone para o usuário. Observação: embora essa seja uma coleção de cadeias de caracteres, somente um número pode ser definido para essa propriedade. |
| createdBy | identitySet | Entidade que criou o usuário. |
| department | String | O nome do departamento no qual o usuário trabalha. Oferece suporte a $filter. |
| displayName | String | O nome exibido para o usuário no catálogo de endereços. Oferece suporte a $filter e $orderby. |
| externalSource | Cadeia de caracteres | O tipo de origem externa a partir da quais este recurso foi gerado (determinado automaticamente a partir de externalSourceDetail). Os valores possíveis são: sis, lms ou manual. |
| externalSourceDetail | Cadeia de caracteres | O nome da origem externa de onde este recurso foi gerado. |
| givenName | String | O nome fornecido (nome) do usuário. Oferece suporte a $filter. |
| String | O endereço SMTP para o utilizador; por exemplo, "jeff@contoso.com". Somente Leitura. Oferece suporte a $filter. | |
| mailNickname | String | O alias de email do usuário. Essa propriedade deve ser especificada quando um usuário é criado. Oferece suporte a $filter. |
| mailingAddress | physicalAddress | Endereço de email do usuário. Nota: type e postOfficeBox não são suportados para educationUser recursos. |
| middleName | Cadeia de caracteres | O nome do meio do usuário. |
| mobilePhone | String | O número de celular principal do usuário. |
| officeLocation | String | A localização do escritório para o utilizador. |
| onPremisesInfo | educationOnPremisesInfo | Informações adicionais utilizadas para associar o utilizador do Microsoft Entra à sua contraparte do Active Directory. |
| passwordPolicies | String | Especifica as políticas de senha do usuário. Para obter mais detalhes, veja o recurso de utilizador padrão. |
| passwordProfile | passwordProfile | Especifica o perfil de senha do usuário. O perfil contém a senha do usuário. Essa propriedade é obrigatória quando um usuário é criado. Para obter mais detalhes, veja o recurso de utilizador padrão. |
| preferredLanguage | String | O idioma preferencial do usuário. Deve seguir o código ISO 639-1; por exemplo, "en-US". |
| primaryRole | cadeia de caracteres | Função padrão de um usuário. A função do usuário pode ser diferente em uma aula individual. Os valores possíveis são: student, teacher, faculty. Oferece suporte a $filter. |
| provisionedPlans | coleção provisionedPlan | Os planos que estão provisionados para o usuário. Somente leitura. Não anulável. |
| relatedContacts | relatedContact collection | Registos relacionados relacionados com o utilizador. As relações possíveis são parent, relative, aide, doctor, guardian, child, , , otherunknownFutureValue |
| residenceAddress | physicalAddress | Endereço em que o usuário reside. Nota: type e postOfficeBox não são suportados para educationUser recursos. |
| student | educationStudent | Se a função principal for estudante, este bloco contém dados específicos do estudante. |
| surname | String | O sobrenome do usuário (nome de família ou sobrenome). Oferece suporte a $filter. |
| teacher | educationTeacher | Se a função principal for professor, este bloco contém dados específicos do professor. |
| usageLocation | String | Um código de país de duas letras (ISO 3166 Alfa-2). Necessário para os utilizadores a quem foram atribuídas licenças. Não anulável. Oferece suporte a $filter. |
| userPrincipalName | Cadeia de caracteres | O nome principal de utilizador (UPN) do utilizador. Oferece suporte a $filter e $orderby. Para obter mais detalhes, veja o recurso de utilizador padrão. |
| userType | String | Um valor de cadeia de caracteres que pode ser usado para classificar tipos de usuários no seu diretório, como “Membro” e “Convidado”. Oferece suporte a $filter. |
Importante
Ao utilizar âmbitos de permissão Delegados, o Graph só devolverá um conjunto limitado de propriedades: id, primaryRole, accountEnabled, displayName, givenName, surname, userPrincipalName, userType, , onPremisesInfo, , student/externalId. teacher/externalId Se a sua aplicação precisar de propriedades adicionais, tem de utilizar os Âmbitos de permissão da aplicação.
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| assignments | educationAssignment | Lista de atribuições para o utilizador. Anulável. |
| classes | Coleção educationClass | Aulas às quais o usuário pertence. Anulável. |
| schools | Coleção educationSchool | Escolas às quais o usuário pertence. Anulável. |
| classes ensinadas | Coleção educationClass | Turmas para as quais o utilizador é professor. |
| rubricas | educationRubric collection | Quando definida, a rubrica de classificação anexada à tarefa. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"accountEnabled": true,
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"assignedPlans": [{ "@odata.type": "microsoft.graph.assignedPlan" }],
"businessPhones": ["String"],
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"department": "String",
"displayName": "String",
"externalSource": "string",
"givenName": "String",
"id": "String (identifier)",
"mail": "String",
"mailNickname": "String",
"mailingAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"middleName": "String",
"mobilePhone": "String",
"officeLocation": "String",
"onPremisesInfo": {
"@odata.type": "microsoft.graph.educationOnPremisesInfo"
},
"passwordPolicies": "String",
"passwordProfile": { "@odata.type": "microsoft.graph.passwordProfile" },
"preferredLanguage": "String",
"primaryRole": "string",
"provisionedPlans": [{ "@odata.type": "microsoft.graph.provisionedPlan" }],
"residenceAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"student": { "@odata.type": "microsoft.graph.educationStudent" },
"surname": "String",
"teacher": { "@odata.type": "microsoft.graph.educationTeacher" },
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String"
}