Partager via

directoryObject : validateProperties

  • Article

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 de tenter 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 messagerie :

  1. Valider la stratégie de nommage de préfixe et de suffixe
  2. Valider la stratégie personnalisée des mots interdits
  3. Vérifier que le surnom du courrier est unique

Cette API retourne avec le premier échec rencontré. 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 à la fois le surnom du courrier et le nom d’affichage et recevoir une collection d’erreurs de validation si vous validez uniquement le préfixe et la stratégie de nommage de suffixe.

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) 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 Chaîne Group est le seul type d’entité pris en charge.
displayName Chaîne Nom complet du groupe à valider. La propriété n’est pas requise individuellement. Toutefois, au moins une propriété (displayName ou mailNickname) est requise.
mailNickname Chaîne Surnom de messagerie du groupe à valider. La propriété n’est pas requise individuellement. Toutefois, au moins une propriété (displayName ou mailNickname) est requise.
onBehalfOfUserId Guid ID d’objet de l’utilisateur à emprunter lors de l’appel de l’API. Les résultats de validation concernent les attributs et les rôles de l’onBehalfOfUserId.

Réponse

Si elle réussit et qu’il n’y a pas d’erreur de validation, la méthode retourne 204 No Content le code de réponse. Il ne retourne rien dans le corps de la réponse.

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

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

Exemples

Il s’agit d’un exemple de 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

Il s’agit d’un exemple de requête avec des erreurs de validation.

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 
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"
      }
    ]
  }
}