Valide que el nombre para mostrar de un grupo de Microsoft 365 o el alias de correo cumpla con las directivas de nomenclatura. Los clientes pueden usar esta API para determinar si un nombre para mostrar o un alias de correo es válido antes de intentar actualizar un grupo de Microsoft 365. Para validar las propiedades antes de crear un grupo, use la función directoryobject:validateProperties .
Se realizan las siguientes validaciones de directiva para las propiedades de nombre para mostrar y alias de correo:
Validar la directiva de nomenclatura de prefijos y sufijos
Validación de la directiva de palabras prohibidas personalizadas
Esta API solo devuelve el primer error de validación que se encuentra. Si las propiedades no superan varias validaciones, solo se devuelve el primer error de validación. Sin embargo, puede validar el alias de correo y el nombre para mostrar y recibir una colección de errores de validación si solo está validando la directiva de nomenclatura de prefijos y sufijos. Para más información sobre la configuración de directivas de nomenclatura, consulte Configuración de directivas de nomenclatura.
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.
Parámetro
Tipo
Descripción
displayName
Cadena
Nombre para mostrar del grupo que se va a validar. La propiedad no es necesaria individualmente. Sin embargo, se requiere al menos una propiedad (displayName o mailNickname).
mailNickname
Cadena
El sobrenombre de correo del grupo que se va a validar. La propiedad no es necesaria individualmente. Sin embargo, se requiere al menos una propiedad (displayName o mailNickname).
onBehalfOfUserId
Guid
Identificador del usuario que se va a suplantar al llamar a la API. Los resultados de validación son para los atributos y roles del onBehalfOfUserId .
Respuesta
Si se ejecuta correctamente y no hay errores de validación, el método devuelve 204 No Content código de respuesta. No devuelve nada en el cuerpo de la respuesta.
Si la solicitud no es válida, el método devuelve 400 Bad Request código de respuesta. Se devuelve un mensaje de error con detalles sobre la solicitud no válida en el cuerpo de la respuesta.
Si hay un error de validación. El método devuelve 422 Unprocessable Entity código de respuesta. Se devuelve un mensaje de error y una colección de detalles de error en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Solicitud de validación correcta
Este es un ejemplo de una solicitud de validación correcta.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Groups.Item.ValidateProperties;
var requestBody = new ValidatePropertiesPostRequestBody
{
DisplayName = "Myprefix_test_mysuffix",
MailNickname = "Myprefix_test_mysuffix",
OnBehalfOfUserId = Guid.Parse("onBehalfOfUserId-value"),
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Groups["{group-id}"].ValidateProperties.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
"github.com/google/uuid"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphgroups "github.com/microsoftgraph/msgraph-sdk-go/groups"
//other-imports
)
requestBody := graphgroups.NewValidatePropertiesPostRequestBody()
displayName := "Myprefix_test_mysuffix"
requestBody.SetDisplayName(&displayName)
mailNickname := "Myprefix_test_mysuffix"
requestBody.SetMailNickname(&mailNickname)
onBehalfOfUserId := uuid.MustParse("onBehalfOfUserId-value")
requestBody.SetOnBehalfOfUserId(&onBehalfOfUserId)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Groups().ByGroupId("group-id").ValidateProperties().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.groups.item.validateproperties.ValidatePropertiesPostRequestBody validatePropertiesPostRequestBody = new com.microsoft.graph.groups.item.validateproperties.ValidatePropertiesPostRequestBody();
validatePropertiesPostRequestBody.setDisplayName("Myprefix_test_mysuffix");
validatePropertiesPostRequestBody.setMailNickname("Myprefix_test_mysuffix");
validatePropertiesPostRequestBody.setOnBehalfOfUserId(UUID.fromString("onBehalfOfUserId-value"));
graphClient.groups().byGroupId("{group-id}").validateProperties().post(validatePropertiesPostRequestBody);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Groups\Item\ValidateProperties\ValidatePropertiesPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ValidatePropertiesPostRequestBody();
$requestBody->setDisplayName('Myprefix_test_mysuffix');
$requestBody->setMailNickname('Myprefix_test_mysuffix');
$requestBody->setOnBehalfOfUserId('onBehalfOfUserId-value');
$graphServiceClient->groups()->byGroupId('group-id')->validateProperties()->post($requestBody)->wait();