Compartilhar via


Atualizar educationUser

Namespace: microsoft.graph

Atualize as propriedades de um objeto educationUser .

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
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo EduRoster.ReadWrite.All Indisponível.

Solicitação HTTP

PATCH /education/me
PATCH /education/users/{id}

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
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. Geralmente é a combinação do nome, da inicial do nome do meio e do sobrenome do usuário. Essa propriedade é necessária quando um usuário é criado e não pode ser desmarcada durante as atualizações. Oferece suporte a $filter e $orderby.
externalSource educationExternalSource De onde esse usuário foi criado. Os valores possíveis são: sis e manual.
externalSourceDetail Cadeia de caracteres O nome da fonte 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.
mailingAddress physicalAddress Endereço de email do usuário.
mailNickname String O alias de email do usuário. Essa propriedade deve ser especificada quando um usuário é criado. Oferece suporte a $filter.
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 do AAD ao seu equivalente do Active Directory.
passwordPolicies String Especifica as políticas de senha do usuário. Este valor é uma enumeração com um possível valor sendo "DisableStrongPassword", que permite especificar as senhas mais fracas do que a política padrão. O "DisablePasswordExpiration" também pode ser especificado. Os dois podem ser especificados juntos, por exemplo: "DisablePasswordExpiration, DisableStrongPassword".
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. A senha no perfil deve atender a requisitos mínimos, conforme especificado pela propriedade passwordPolicies. Por padrão, é obrigatória uma senha forte.
preferredLanguage String O idioma preferencial do usuário. Deve seguir o código ISO 639-1; por exemplo, "en-US".
primaryRole educationUserRole 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, none, unknownFutureValue.
provisionedPlans coleção provisionedPlan Os planos que estão provisionados para o usuário. Somente leitura. Não anulável.
residenceAddress physicalAddress Endereço em que o usuário reside.
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 Cadeia de caracteres Um código de país de duas letras (padrão ISO 3166). Obrigatório para os usuários que receberão licenças devido à exigência legal de verificar a disponibilidade de serviços em países ou regiões. Os exemplos incluem: "US", "JP" e "GB". Não anulável. Oferece suporte a $filter.
userPrincipalName String O nome UPN do usuário.
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.

Resposta

Se bem-sucedido, esse método retornará um código de resposta 200 OK e um objeto educationUser atualizado no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/v1.0/education/users/{user-id}
Content-type: application/json

{
  "displayName": "Rogelio Cazares",
  "givenName": "Rogelio",
  "middleName": "Fernando",
  "surname": "Cazares",
}
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

{
  "id": "13020",
  "displayName": "Rogelio Cazares",
  "givenName": "Rogelio",
  "middleName": "Fernando",
  "surname": "Cazares",
  "mail": "rogelioC@contoso.com",
  "mobilePhone": "+1 (253) 555-0101",
  "createdBy": {
        "user": {
          "displayName": "Susana Rocha",
          "id": "14012",
        }
  },
  "externalSource": "sis",
  "mailingAddress": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
  "primaryRole": "string",
  "residenceAddress": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
  "student": {
      "primaryRole": "student",
      "externalId": "13005",
      "birthDate": "2001-01-01T00:00:00Z"
    }
}