Compartir a través de

directoryObject: validateProperties

  • Artículo

Espacio de nombres: microsoft.graph

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 crear un grupo de Microsoft 365. Para validar las propiedades de un grupo existente, use la función validateProperties para grupos.

Se realizan las siguientes validaciones para las propiedades de nombre para mostrar y alias de correo:

  1. Validar la directiva de nomenclatura de prefijos y sufijos
  2. Validación de la directiva de palabras prohibidas personalizadas
  3. Validar que el alias de correo es único

Esta API devuelve con el primer error encontrado. Si una o varias propiedades no superan varias validaciones, solo se devuelve la propiedad con 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.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

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.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Group.Read.All Directory.Read.All, Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Group.Read.All Directory.Read.All, Directory.ReadWrite.All, Group.ReadWrite.All

Solicitud HTTP

POST /directoryObjects/validateProperties

Encabezados de solicitud

Nombre Descripción
Autorización {code} del portador. Obligatorio.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.

Parámetro Tipo Descripción
Entitytype Cadena Group es el único tipo de entidad compatible.
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 de objeto 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

Este es un ejemplo de una solicitud de validación correcta.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content

Este es un ejemplo de una solicitud con errores de validación.

Solicitud

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

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

Respuesta

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