directoryObject : validateProperties

Espace de noms: microsoft.graph

Validez que le nom d’affichage d’un groupe Microsoft 365 ou surnom d’un courrier est conforme aux stratégies de noms. Les clients peuvent utiliser cette API pour déterminer si un nom d’affichage ou un surnom de messagerie est valide avant d’essayer de créer un groupe Microsoft 365. Pour valider les propriétés d’un groupe existant, utilisez la fonction validateProperties pour les groupes.

Les validations suivantes sont effectuées pour les propriétés de nom d’affichage et de surnom de courrier :

  1. Valider la stratégie de nommage de préfixe et de suffixe
  2. Valider la stratégie personnalisée de mots interdits
  3. Vérifiez que le surnom de l’e-mail est unique

Remarque

  • Les caractères suivants sont considérés comme des caractères non valides et ne font pas partie des validations de stratégie : @ () \ \[] " ; : <> , SPACE.

  • Les administrateurs ayant les rôles d’administrateur d’utilisateur et d’administrateur général sont exemptés des stratégies d’appellation des mots interdits personnalisés et des préfixes et suffixes, ce qui leur permet de créer des groupes à l’aide de mots bloqués et avec leurs propres conventions d’affectation de noms.

Cette API retourne avec la première défaillance rencontrée. Si une ou plusieurs propriétés échouent à plusieurs validations, seule la propriété avec le premier échec de validation est retournée. Toutefois, vous pouvez valider le surnom de l’e-mail et le nom d’affichage et recevoir une série d’erreurs de validation si vous validez uniquement la stratégie d’appellation de préfixe et de suffixe.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Group.Read.All Directory.Read.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Group.Read.All Directory.Read.All, Directory.ReadWrite.All, Group.ReadWrite.All

Requête HTTP

POST /directoryObjects/validateProperties

En-têtes de demande

Nom Description
Autorisation Porteur {code}. Obligatoire.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
entityType String Group est le seul type d’entité pris en charge.
displayName String Nom d’affichage du groupe à valider. DisplayName ou mailNickname doivent être spécifiés.
mailNickname String Surnom de messagerie du groupe à valider. DisplayName ou mailNickname doivent être spécifiés.
onBehalfOfUserId Guid ID d’objet de l’utilisateur à emprunter lors de l’appel de l’API. Les résultats de la validation sont pour les attributs et les rôles de onBehalfOfUserId.

Réponse

En cas de réussite et qu’il n’y a pas d’erreurs de validation, la méthode retourne le 204 No Content code de réponse. Elle ne renvoie rien dans le corps de la réponse.

Lorsqu’un administrateur général ou un administrateur d’utilisateur initie une demande qui enfreint les stratégies de nommage personnalisées de mots interdits ou de préfixes et de suffixes, l’API retourne un 204 No Content code de réponse, car ces administrateurs sont exemptés de nommer les stratégies. Pour les autres utilisateurs ou administrateurs, les demandes enfreignant ces stratégies ne sont pas valides.

Si la requête n’est pas valide, la méthode retourne le 400 Bad Request code de réponse. Un message d’erreur contenant des détails sur la demande non valide est renvoyé dans le corps de la réponse.

En cas d’erreur de validation, la méthode renvoie 422 Unprocessable Entity le code de réponse. Un message d’erreur et une collection de détails d’erreur sont renvoyés dans le corps de la réponse.

Exemples

Exemple 1 : demande de validation réussie

Demande

POST https://graph.microsoft.com/beta/directoryObjects/validateProperties
Content-type: application/json

{
  "entityType": "Group",
  "displayName": "Myprefix_test_mysuffix",
  "mailNickname": "Myprefix_test_mysuffix",
  "onBehalfOfUserId": "onBehalfOfUserId-value"
}

Réponse

HTTP/1.1 204 No Content

Exemple 2 : Demande de validation non réussie

Demande

POST https://graph.microsoft.com/beta/directoryObjects/validateProperties
Content-type: application/json

{
  "entityType": "Group",
  "displayName": "test",
  "mailNickname": "test",
  "onBehalfOfUserId": "onBehalfOfUserId-value"
}

Réponse

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": {
    "code": "Request_UnprocessableEntity",
    "message": "The values provided contain one or more validation errors.",
    "innerError": {
      "request-id": "request-id-value",
      "date": "date-value"
    },
    "details": [
      {
        "target": "displayName",
        "code": "MissingPrefixSuffix",
        "message": "Property mailNickname is missing a required prefix/suffix per your organization's Group naming requirements.",
        "prefix": "Myprefix_",
        "suffix": "_mysuffix"
      },
      {
        "target": "mailNickname",
        "code": "MissingPrefixSuffix",
        "message": "Property mailNickname is missing a required prefix/suffix per your organization's Group naming requirements.",
        "prefix": "Myprefix_",
        "suffix": "_mysuffix"
      }
    ]
  }
}
  • Last updated on