directoryObject: validateProperties

  • Artigo

Namespace: microsoft.graph

Valide se o nome de exibição ou apelido de email de um grupo da Microsoft 365 está em conformidade com as políticas de nomenclatura. Os clientes podem usar essa API para determinar se um nome de exibição ou um apelido de email é válido antes de tentar criar um grupo do Microsoft 365. Para validar as propriedades de um grupo existente, use o grupo: validar a funçãoProperties .

As seguintes validações de política são executadas para as propriedades nome de exibição e apelido de email:

  1. Validar a política de nomenclatura de prefixo e sufixo
  2. Validar a política de palavras proibidas personalizadas
  3. Validar que o apelido de email é exclusivo

Observação

Caracteres inválidos não fazem parte das validações da política. Os seguintes caracteres são inválidos: @ () \ [] " ; : <> , SPACE.

Essa API retorna apenas a primeira falha de validação encontrada. Se as propriedades falharem em várias validações, somente a primeira falha de validação será retornada. No entanto, você pode validar o apelido de email e o nome de exibição e receber uma coleção de erros de validação se estiver validando apenas a política de nomenclatura de prefixo e sufixo. Para saber mais sobre como configurar políticas de nomenclatura, consulte Configurar política de nomenclatura.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Group.Read.All Directory.Read.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Group.Read.All Directory.Read.All, Directory.ReadWrite.All, Group.ReadWrite.All

Solicitação HTTP

POST /directoryObjects/validateProperties

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
Entitytype Cadeia de caracteres O grupo é o único tipo de entidade com suporte.
displayName Cadeia de caracteres O nome de exibição do grupo a ser validado. A propriedade não é necessária individualmente. No entanto, pelo menos uma propriedade (displayName ou mailNickname) é necessária.
mailNickname String O apelido de email do grupo a ser validado. A propriedade não é necessária individualmente. No entanto, pelo menos uma propriedade (displayName ou mailNickname) é necessária.
onBehalfOfUserId Guid A ID do usuário a ser representada ao chamar a API. Os resultados de validação são para os atributos e funções onBehalfOfUserId .

Resposta

Se for bem-sucedido e não houver erros de validação, o método retornará 204 No Content o código de resposta. Ele não retorna nada no corpo da resposta.

Se a solicitação for inválida, o método retornará 400 Bad Request o código de resposta. Uma mensagem de erro com detalhes sobre a solicitação inválida é retornada no corpo da resposta.

Se houver um erro de validação, o método retornará 422 Unprocessable Entity o código de resposta. Uma mensagem de erro e uma coleção de detalhes de erro são retornados no corpo da resposta.

Exemplos

Exemplo 1: Solicitação de validação bem-sucedida

Este é um exemplo de uma solicitação de validação bem-sucedida.

Solicitação

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

Resposta

HTTP/1.1 204 No Content

Exemplo 2: Solicitar com erros de validação

Este é um exemplo de uma solicitação com erros de validação.

Solicitação

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

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

Resposta

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