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.

Um usuário no sistema. Esse recurso é uma variante específica da educação do recurso de usuário padrão, com o mesmo id que o Microsoft Graph retorna do ponto de extremidade não específico /users da educação.

Esse objeto fornece um subconjunto de propriedades direcionadas do objeto principal do usuário 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 educationUser 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 Nenhum Exclua um objeto educationUser.
Delta Coleção educationUser Obtenha alterações incrementais para educationUsers.

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 String collection 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 do qual esse recurso foi gerado (determinado automaticamente por externalSourceDetail). Os valores possíveis são: sis, lms ou manual.
externalSourceDetail Cadeia de caracteres O nome da origem externa da qual esse recurso foi gerado.
givenName String O nome fornecido (nome) do usuário. Oferece suporte a $filter.
mail String O endereço SMTP para o usuário; 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. Observação: type e postOfficeBox não há suporte 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.
onPremisesInfo educationOnPremisesInfo Informações adicionais usadas para associar o usuário Microsoft Entra ao seu equivalente do Active Directory.
passwordPolicies String Especifica as políticas de senha do usuário. Consulte o recurso de usuário padrão para obter mais detalhes.
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. Consulte o recurso de usuário padrão para obter mais detalhes.
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 coleção relatedContact Registros relacionados relacionados ao usuário. As relações possíveis são parent, relative, aide, doctor, guardian, , child, , otherunknownFutureValue
residenceAddress physicalAddress Endereço em que o usuário reside. Observação: type e postOfficeBox não há suporte para educationUser recursos.
student educationStudent Se a função primária for o aluno, esse bloco conterá dados específicos do aluno.
surname String O sobrenome do usuário (nome de família ou sobrenome). Oferece suporte a $filter.
teacher educationTeacher Se a função primária for professora, esse bloco conterá dados específicos do professor.
usageLocation String Um código de país de duas letras (ISO 3166 Alpha-2). Necessário para usuários que receberão licenças. Não anulável. Oferece suporte a $filter.
userPrincipalName Cadeia de caracteres O nome da entidade de usuário (UPN) para o usuário. Oferece suporte a $filter e $orderby. Consulte recurso de usuário padrão para obter detalhes adicionais.
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 usar escopos de permissão delegados, o Graph retornará apenas um conjunto limitado de propriedades: id, , primaryRole, accountEnabled, givenNamedisplayName, surname, userPrincipalName, userType, onPremisesInfo, , student/externalId, . teacher/externalId Se seu aplicativo exigir propriedades adicionais, você deve usar escopos de permissão do aplicativo.

Relações

Relação Tipo Descrição
assignments educationAssignment Lista de atribuições para o usuário. 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.
taughtClasses Coleção educationClass Classes para as quais o usuário é professor.
Rubricas coleção educationRubric Quando definido, a rubrica de classificação anexada à atribuição.

Representação JSON

A representação JSON a seguir 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"
}