directoryObject: validateProperties

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 son válidos 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 validaciones siguientes para las propiedades de nombre para mostrar y alias de correo:

  1. Validar la directiva de nomenclatura de prefijos y sufijos
  2. Validar la directiva personalizada de palabras prohibidas
  3. Validar que el alias de correo sea único

Nota:

  • Los siguientes caracteres se consideran caracteres no válidos y no forman parte de las validaciones de directiva: @ () \ \[] " ; : <> , SPACE.

  • Los administradores con los roles de administrador de usuarios y administrador global están exentos de las directivas de nomenclatura personalizadas de palabras prohibidas y prefijos y sufijos, lo que les permite crear grupos mediante palabras bloqueadas y con sus propias convenciones de nomenclatura.

Esta API se devuelve con el primer error encontrado. Si una o más propiedades dan error en varias validaciones, solo se devuelve la propiedad con el primer error de validación. Sin embargo, puede validar tanto el alias de correo como el nombre para mostrar y recibir una serie de errores de validación si solo está validando la directiva de nomenclatura de prefijo y sufijo.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos 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 admitido.
displayName Cadena Nombre para mostrar del grupo que se va a validar. Se debe especificar displayName o mailNickname .
mailNickname Cadena El alias de correo del grupo que se va a validar. Se debe especificar displayName o mailNickname .
onBehalfOfUserId Guid El 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 de onBehalfOfUserId.

Respuesta

Si se realiza 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.

Cuando un administrador global o un administrador de usuarios inicia una solicitud que infringe las palabras prohibidas personalizadas o las directivas de nomenclatura de prefijos y sufijos, la API devuelve un 204 No Content código de respuesta, ya que estos administradores están exentos de las directivas de nomenclatura. Para otros usuarios o administradores, las solicitudes que infringen estas directivas no son válidas.

Si la solicitud no es válida, el método devuelve 400 Bad Request el 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: 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

Ejemplo 2: Una solicitud de validación incorrecta

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 Unprocessable Entity
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"
      }
    ]
  }
}
  • Last updated on