directoryObject: validateProperties

  • Artikel

Namespace: microsoft.graph

Überprüften, ob der Anzeigename oder E-Mail-Spitzname einer Microsoft 365-Gruppe den Benennungsrichtlinien entspricht. Clients können diese API verwenden, um zu bestimmen, ob ein Anzeigename oder E-Mail-Spitzname gültig ist, bevor sie versuchen, eine Microsoft 365-Gruppe zu erstellen . Verwenden Sie die Funktion group: validateProperties , um die Eigenschaften einer vorhandenen Gruppe zu überprüfen.

Die folgenden Richtlinienüberprüfungen werden für die Eigenschaften Anzeigename und E-Mail-Spitzname durchgeführt:

  1. Überprüfen der Präfix- und Suffixbenennungsrichtlinie
  2. Überprüfen der Richtlinie für benutzerdefinierte gesperrte Wörter
  3. Überprüfen, ob der E-Mail-Spitzname eindeutig ist

Hinweis

Ungültige Zeichen sind nicht Teil der Richtlinienüberprüfungen. Die folgenden Zeichen sind ungültig: @ () \ [] " ; : <> , SPACE.

Diese API gibt nur den ersten aufgetretenen Überprüfungsfehler zurück. Wenn die Eigenschaften mehrere Überprüfungen nicht bestehen, wird nur der erste Überprüfungsfehler zurückgegeben. Sie können jedoch sowohl den E-Mail-Spitznamen als auch den Anzeigenamen überprüfen und eine Sammlung von Validierungsfehlern erhalten, wenn Sie nur die Präfix- und Suffixbenennungsrichtlinie überprüfen. Weitere Informationen zum Konfigurieren von Benennungsrichtlinien finden Sie unter Konfigurieren von Benennungsrichtlinien.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Group.Read.All Directory.Read.All, Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Group.Read.All Directory.Read.All, Directory.ReadWrite.All, Group.ReadWrite.All

HTTP-Anforderung

POST /directoryObjects/validateProperties

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter Typ Beschreibung
Entitytype String Group ist der einzige unterstützte Entitätstyp.
displayName String Der Anzeigename der zu überprüfenden Gruppe. Die -Eigenschaft ist nicht einzeln erforderlich. Es ist jedoch mindestens eine Eigenschaft (displayName oder mailNickname) erforderlich.
mailNickname String Der E-Mail-Spitzname der zu überprüfenden Gruppe. Die -Eigenschaft ist nicht einzeln erforderlich. Es ist jedoch mindestens eine Eigenschaft (displayName oder mailNickname) erforderlich.
onBehalfOfUserId GUID Die ID des Benutzers, der beim Aufrufen der API die Identität annehmen soll. Die Validierungsergebnisse gelten für die Attribute und Rollen von onBehalfOfUserId .

Antwort

Wenn die Methode erfolgreich verläuft und keine Validierungsfehler auftreten, gibt die Methode den Antwortcode zurück 204 No Content . Es gibt nichts im Antworttext zurück.

Wenn die Anforderung ungültig ist, gibt die Methode den Antwortcode zurück 400 Bad Request . Eine Fehlermeldung mit Details zur ungültigen Anforderung wird im Antworttext zurückgegeben.

Wenn ein Validierungsfehler auftritt, gibt die Methode den Antwortcode zurück 422 Unprocessable Entity . Eine Fehlermeldung und eine Auflistung von Fehlerdetails werden im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Erfolgreiche Überprüfungsanforderung

Dies ist ein Beispiel für eine erfolgreiche Überprüfungsanforderung.

Anforderung

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

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

Antwort

HTTP/1.1 204 No Content

Beispiel 2: Anforderung mit Validierungsfehlern

Dies ist ein Beispiel für eine Anforderung mit Validierungsfehlern.

Anforderung

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

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

Antwort

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