directoryObject: validateProperties

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 Benutzerdefinierten Richtlinie für gesperrte Wörter
3. Überprüfen, ob der E-Mail-Spitzname eindeutig ist

Diese API gibt nur den ersten Aufgetretenen Überprüfungsfehler zurück. Wenn bei den Eigenschaften mehrere Überprüfungen fehlschlagen, 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 Überprüfungsfehlern erhalten, wenn Sie nur die Präfix- und Suffixbenennungsrichtlinie überprüfen. Weitere Informationen zum Konfigurieren von Benennungsrichtlinien finden Sie unter Konfigurieren der Benennungsrichtlinie.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Group.Read.All, Directory.Read.All, Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt
Anwendung	Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

HTTP-Anforderung

POST /directoryObjects/validateProperties

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich.
Content-Type	application/json

Anforderungstext

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

Parameter	Typ	Beschreibung
Entitytype	Zeichenfolge	Group ist der einzige unterstützte Entitätstyp.
displayName	Zeichenfolge	Der Anzeigename der zu überprüfenden Gruppe. Die Eigenschaft ist nicht einzeln erforderlich. Es ist jedoch mindestens eine Eigenschaft (displayName oder mailNickname) erforderlich.
mailNickname	Zeichenfolge	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 beziehen sich auf die Attribute und Rollen der onBehalfOfUserId .

Antwort

Wenn die Methode erfolgreich ist und keine Überprüfungsfehler auftreten, gibt die Methode den Antwortcode zurück 204 No Content . Im Antworttext wird nichts zurückgegeben.

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

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

Beispiele

Beispiel 1: Erfolgreiche Überprüfungsanforderung

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

Anforderung

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var entityType = "Group";

var displayName = "Myprefix_test_mysuffix";

var mailNickname = "Myprefix_test_mysuffix";

var onBehalfOfUserId = Guid.Parse("onBehalfOfUserId-value");

await graphClient.DirectoryObjects
    .ValidateProperties(entityType,displayName,mailNickname,onBehalfOfUserId)
    .Request()
    .PostAsync();

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const validateProperties = {
  entityType: 'Group',
  displayName: 'Myprefix_test_mysuffix',
  mailNickname: 'Myprefix_test_mysuffix',
  onBehalfOfUserId: 'onBehalfOfUserId-value'
};

await client.api('/directoryObjects/validateProperties')
    .post(validateProperties);

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/directoryObjects/validateProperties"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *entityType = @"Group";
payloadDictionary[@"entityType"] = entityType;

NSString *displayName = @"Myprefix_test_mysuffix";
payloadDictionary[@"displayName"] = displayName;

NSString *mailNickname = @"Myprefix_test_mysuffix";
payloadDictionary[@"mailNickname"] = mailNickname;

NSString *onBehalfOfUserId = @"onBehalfOfUserId-value";
payloadDictionary[@"onBehalfOfUserId"] = onBehalfOfUserId;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String entityType = "Group";

String displayName = "Myprefix_test_mysuffix";

String mailNickname = "Myprefix_test_mysuffix";

UUID onBehalfOfUserId = UUID.fromString("onBehalfOfUserId-value");

graphClient.directoryObjects()
    .validateProperties(DirectoryObjectValidatePropertiesParameterSet
        .newBuilder()
        .withEntityType(entityType)
        .withDisplayName(displayName)
        .withMailNickname(mailNickname)
        .withOnBehalfOfUserId(onBehalfOfUserId)
        .build())
    .buildRequest()
    .post();

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
entityType := "Group"
requestBody.SetEntityType(&entityType)
displayName := "Myprefix_test_mysuffix"
requestBody.SetDisplayName(&displayName)
mailNickname := "Myprefix_test_mysuffix"
requestBody.SetMailNickname(&mailNickname)
onBehalfOfUserId := "onBehalfOfUserId-value"
requestBody.SetOnBehalfOfUserId(&onBehalfOfUserId)
graphClient.DirectoryObjects().ValidateProperties().Post(requestBody)

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

PowerShell

Import-Module Microsoft.Graph.DirectoryObjects

$params = @{
    EntityType = "Group"
    DisplayName = "Myprefix_test_mysuffix"
    MailNickname = "Myprefix_test_mysuffix"
    OnBehalfOfUserId = "onBehalfOfUserId-value"
}

Test-MgDirectoryObjectProperty -BodyParameter $params

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Antwort

HTTP/1.1 204 No Content

Beispiel 2: Anforderung mit Überprüfungsfehlern

Dies ist ein Beispiel für eine Anforderung mit Überprüfungsfehlern.

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