grupo: validarProperties
Namespace: microsoft.graph
Valide se o nome de exibição ou o apelido de email de um grupo do Microsoft 365 estiver em conformidade com as políticas de nomenclatura. Os clientes podem usar a API para determinar se um nome de exibição ou um apelido de email é válido antes de tentar atualizar um grupo do Microsoft 365. Para validar propriedades antes de criar um grupo, use a função validateProperties para objetos de diretório.
As seguintes validações são executadas para as propriedades nome de exibição e apelido de email:
- Validar a política de nomenclatura de prefixo e sufixo
- Validar a política de palavras proibidas personalizadas
Essa API retorna com a primeira falha encontrada. Se uma ou mais propriedades falharem em várias validações, somente a propriedade com 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.
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 | Group.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Group.Read.All | Group.ReadWrite.All |
Solicitação HTTP
POST /groups/{id}/validateProperties
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Authorization | Portador {code} |
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 |
---|---|---|
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 objeto do usuário a ser representado 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 retorna o 422 Unprocessable Entity
código de resposta. Uma mensagem de erro e uma coleção de detalhes de erro são retornados no corpo da resposta.
Exemplos
Este é um exemplo de uma solicitação de validação bem-sucedida.
Solicitação
POST https://graph.microsoft.com/beta/groups/{id}/validateProperties
Content-type: application/json
{
"displayName": "Myprefix_test_mysuffix",
"mailNickname": "Myprefix_test_mysuffix",
"onBehalfOfUserId": "onBehalfOfUserId-value"
}
Resposta
HTTP/1.1 204 No Content
Este é um exemplo de uma solicitação com erros de validação.
Solicitação
POST https://graph.microsoft.com/beta/groups/{id}/validateProperties
Content-type: application/json
{
"displayName": "MyPrefix_test_mysuffix",
"mailNickname": "MyPrefix_test_mysuffix"
}
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": "id-value",
"date": "date-value"
},
"details": [
{
"target": "mailNickname",
"code": "PropertyConflict",
"message": "Another object with the same value for property mailNickname already exists."
}
]
}
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de