Partager via


Créer un objet educationUser

Espace de noms: microsoft.graph

Créez un objet educationUser .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application EduRoster.ReadWrite.All Non disponible.

Requête HTTP

POST /education/users

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet educationUser .

Le tableau suivant répertorie les propriétés qui sont requises lorsque vous créez educationUser.

Propriété Type Description
accountEnabled Boolean Valeur true si le compte est activé ; sinon, valeur false. Cette propriété est requise lorsqu’un utilisateur est créé. Prend en charge $filter.
assignedLicenses collection assignedLicense Licences attribuées à l’utilisateur. Ne pouvant accepter la valeur null.
assignedPlans collection assignedPlan Plans de charge affectés à l’utilisateur. En lecture seule. Ne pouvant accepter la valeur null.
businessPhones String collection Numéros de téléphone de l’utilisateur. Remarque : bien qu’il s’agisse d’une collection de chaînes, seul un numéro peut être défini pour cette propriété.
createdBy identitySet Entité qui a créé l’utilisateur.
department String Nom du service où travaille l’utilisateur. Prend en charge $filter.
displayName String Nom affiché dans le carnet d’adresses de l’utilisateur. Il s’agit généralement de la combinaison du prénom de l’utilisateur, de l’initiale de son deuxième prénom et de son nom. Cette propriété est requise lorsqu’un utilisateur est créé et ne peut pas être effacée pendant les mises à jour. Prend en charge $filter et $orderby.
externalSource educationExternalSource Endroit à partir duquel cet utilisateur a été créé. Les valeurs possibles sont les suivantes : sis, manual.
externalSourceDetail Chaîne Nom de la source externe à partir de laquelle cette ressource a été générée.
givenName String Prénom de l’utilisateur. Prend en charge $filter.
mail String Adresse SMTP de l’utilisateur ; par exemple, «jeff@contoso.com ». En lecture seule. Prend en charge $filter.
mailingAddress physicalAddress Adresse de messagerie de l’utilisateur.
mailNickname String Alias de messagerie de l’utilisateur. Cette propriété doit être spécifiée lors de la création d’un utilisateur. Prend en charge $filter.
middleName String Deuxième prénom de l’utilisateur.
mobilePhone String Numéro de téléphone portable principal de l’utilisateur.
onPremisesInfo educationOnPremisesInfo Informations supplémentaires utilisées pour associer l’utilisateur AAD à son équivalent Active Directory.
passwordPolicies String Spécifie les stratégies de mot de passe de l’utilisateur. Cette valeur est une énumération avec une seule valeur possible, « DisableStrongPassword », qui permet de spécifier des mots de passe plus faibles que la stratégie par défaut. Vous pouvez également spécifier la valeur « DisablePasswordExpiration ». Les deux valeurs peuvent être spécifiées ensemble, par exemple : « DisablePasswordExpiration, DisableStrongPassword ».
passwordProfile passwordProfile Spécifie le profil du mot de passe de l’utilisateur. Le profil contient le mot de passe de l’utilisateur. Cette propriété est requise lorsqu’un utilisateur est créé. Le mot de passe du profil doit respecter les exigences minimales spécifiées par la propriété passwordPolicies. Par défaut, un mot de passe fort est requis.
preferredLanguage String Langue par défaut de l’utilisateur. Doit respecter le Code ISO 639-1, par exemple « fr-FR ».
primaryRole educationUserRole Rôle par défaut pour un utilisateur. Le rôle de l’utilisateur peut être différent dans une classe individuelle. Les valeurs possibles sont student, teacher et none.
provisionedPlans collection provisionedPlan Plans de charge configurés pour l’utilisateur. En lecture seule. Ne pouvant accepter la valeur null.
residenceAddress physicalAddress Adresse à laquelle habite l’utilisateur.
student educationStudent Si le rôle principal est student, ce bloc contient des données spécifiques à l’étudiant.
surname String Nom de l’utilisateur (nom de famille). Prend en charge $filter.
teacher educationTeacher Si le rôle principal est enseignant, ce bloc contient des données spécifiques à l’enseignant.
usageLocation String Code pays à deux lettres (norme ISO 3166). Obligatoire pour les utilisateurs qui recevront des licences en raison d’une obligation légale qui exige la vérification de la disponibilité des services dans les pays ou régions. Voici quelques exemples : « US », « JP » et « GB ». Ne peut accepter une valeur null. Prend en charge $filter.
userPrincipalName String Nom d’utilisateur principal (UPN) de l’utilisateur.
userType String Valeur de chaîne qui peut être utilisée pour classer les types d’utilisateur dans votre répertoire, tels que « Membre » et « Invité ». Prend en charge $filter.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 201 Created et un objet educationUser dans le corps de la réponse.

Exemples

Demande

POST https://graph.microsoft.com/v1.0/education/users
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.educationUser",
  "primaryRole": "String",
  "middleName": "String",
  "externalSource": "String",
  "externalSourceDetail": "String",
  "residenceAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "mailingAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "student": {
    "@odata.type": "microsoft.graph.educationStudent"
  },
  "teacher": {
    "@odata.type": "microsoft.graph.educationTeacher"
  },
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "accountEnabled": "Boolean",
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "assignedPlans": [
    {
      "@odata.type": "microsoft.graph.assignedPlan"
    }
  ],
  "businessPhones": [
    "String"
  ],
  "department": "String",
  "displayName": "String",
  "givenName": "String",
  "mail": "String",
  "mailNickname": "String",
  "mobilePhone": "String",
  "passwordPolicies": "String",
  "passwordProfile": {
    "@odata.type": "microsoft.graph.passwordProfile"
  },
  "officeLocation": "String",
  "preferredLanguage": "String",
  "provisionedPlans": [
    {
      "@odata.type": "microsoft.graph.provisionedPlan"
    }
  ],
  "refreshTokensValidFromDateTime": "String (timestamp)",
  "showInAddressList": "Boolean",
  "surname": "String",
  "usageLocation": "String",
  "userPrincipalName": "String",
  "userType": "String",
  "onPremisesInfo": {
    "@odata.type": "microsoft.graph.educationOnPremisesInfo"
  }
}

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.educationUser",
  "id": "90eedea1-dea1-90ee-a1de-ee90a1deee90",
  "primaryRole": "String",
  "middleName": "String",
  "externalSource": "String",
  "externalSourceDetail": "String",
  "residenceAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "mailingAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "student": {
    "@odata.type": "microsoft.graph.educationStudent"
  },
  "teacher": {
    "@odata.type": "microsoft.graph.educationTeacher"
  },
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "accountEnabled": "Boolean",
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "assignedPlans": [
    {
      "@odata.type": "microsoft.graph.assignedPlan"
    }
  ],
  "businessPhones": [
    "String"
  ],
  "department": "String",
  "displayName": "String",
  "givenName": "String",
  "mail": "String",
  "mailNickname": "String",
  "mobilePhone": "String",
  "passwordPolicies": "String",
  "passwordProfile": {
    "@odata.type": "microsoft.graph.passwordProfile"
  },
  "officeLocation": "String",
  "preferredLanguage": "String",
  "provisionedPlans": [
    {
      "@odata.type": "microsoft.graph.provisionedPlan"
    }
  ],
  "refreshTokensValidFromDateTime": "String (timestamp)",
  "showInAddressList": "Boolean",
  "surname": "String",
  "usageLocation": "String",
  "userPrincipalName": "String",
  "userType": "String",
  "onPremisesInfo": {
    "@odata.type": "microsoft.graph.educationOnPremisesInfo"
  }
}