Compartir a través de


Grupo upsert

Espacio de nombres: microsoft.graph

Cree un nuevo objeto de grupo si no existe o actualice las propiedades de un objeto de grupo existente. Puede crear o actualizar los siguientes tipos de grupo:

  • Grupo de Microsoft 365 (grupo unificado)
  • Grupo de seguridad

De forma predeterminada, esta operación devuelve solo un subconjunto de las propiedades de cada grupo. Para obtener una lista de las propiedades que se devuelven de forma predeterminada, consulte la sección Propiedades del recurso de grupo . Para obtener propiedades que no se devuelven de forma predeterminada, realice una operación GET y especifique las propiedades de una opción de consulta de OData $select.

Nota: Para crear un equipo, primero cree un grupo y, a continuación, agréguele un equipo. Para obtener más información, vea Crear equipo.

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.ReadWrite.All Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Group.ReadWrite.All Directory.ReadWrite.All

Para que una aplicación con permiso Group.Create cree un grupo con propietarios o miembros, debe tener los privilegios para leer el tipo de objeto que quiere asignar como propietario o miembro del grupo. Por lo tanto:

  • La aplicación puede asignarse a sí misma como propietario o miembro del grupo.
  • Para crear el grupo con usuarios como propietarios o miembros, la aplicación debe tener al menos el permiso User.Read.All .
  • Para crear el grupo con otras entidades de servicio como propietarios o miembros, la aplicación debe tener al menos el permiso Application.Read.All .
  • Para crear el grupo con usuarios o entidades de servicio como propietarios o miembros, la aplicación debe tener al menos el permiso Directory.Read.All .

Solicitud HTTP

PATCH /groups/(uniqueName='uniqueName')

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Necesario.
Prefer create-if-missing. Necesario para el comportamiento de upsert; de lo contrario, la solicitud se trata como una operación de actualización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto de grupo.

En la tabla siguiente se enumeran las propiedades necesarias al crear el grupo. Especifique otras propiedades grabables según sea necesario para el grupo al crear o actualizar.

Propiedad Tipo Descripción
displayName Cadena El nombre para mostrar en la lista de direcciones del grupo. La longitud máxima es de 256 caracteres. Obligatorio.
mailEnabled Booleano Se establece en true para grupos habilitados para correo electrónico. Obligatorio.
mailNickname Cadena El alias de correo para el grupo, único para los grupos de Microsoft 365 en la organización. La longitud máxima es de 64 caracteres. Esta propiedad solo puede contener caracteres incluidos en el juego de caracteres ASCII de 0 a 127 con estas excepciones: @ () \ [] " ; : <> , SPACE. Obligatorio.
securityEnabled Booleano Se establece en true para grupos habilitados para seguridad, incluidos grupos de Microsoft 365. Obligatorio. Nota: Grupos creado mediante el Centro de administración Microsoft Entra o el Azure Portal siempre tienen securityEnabled establecido inicialmente en true.

Importante

  • Crear un grupo con elGrupo. Crear un permiso de la aplicación sin especificar propietarios creará el grupo de forma anónima y el grupo no podrá ser modificable. Agregue propietarios al grupo mientras lo crea para especificar propietarios que pueden modificar el grupo.
  • Crear un grupo de Microsoft 365 mediante programación con un contexto de solo app y sin especificar los propietarios creará el grupo de forma anónima. Si lo hace, el sitio de SharePoint Online asociado puede que no se cree automáticamente hasta que no se realicen acciones manuales adicionales.
  • Un usuario que no es administrador no puede agregarse a la colección de propietarios del grupo. Para obtener más información, consulte el problema conocido relacionado.
  • Las propiedades siguientes no se pueden establecer en la solicitud POST inicial y deben establecerse en una solicitud PATCH posterior: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.

Dado que el recurso del grupo admite extensiones, puede agregar propiedades personalizadas con sus propios datos al grupo mientras lo crea.

Opciones de groupTypes

Use la propiedad groupTypes para controlar el tipo de grupo y sus miembros, como se le muestra.

Tipo de grupo Pertenencia asignada Pertenencia dinámica
Microsoft 365 (también conocido como grupo unificado) ["Unified"] ["Unified","DynamicMembership"]
Dinámico [](null) ["DynamicMembership"]

Respuesta

Si no existe un objeto con uniqueName , este método devuelve un 201 Created código de respuesta y un nuevo objeto de grupo en el cuerpo de la respuesta.

Si no existe un objeto con uniqueName y no se especifica el Prefer: create-if-missing encabezado, este método devuelve un código de 404 Not Found error.

Si ya existe un objeto con uniqueName , este método actualiza el objeto de grupo y devuelve un 204 No Content código de respuesta.

Ejemplos

Ejemplo 1: Crear un grupo de Microsoft 365 si no existe

En el ejemplo siguiente se crea un grupo de Microsoft 365 porque no existe un grupo con el valor de uniqueName especificado. Dado que no se han especificado los propietarios, el usuario que llama se agrega automáticamente como propietario del grupo.

Solicitud

PATCH https://graph.microsoft.com/v1.0/groups(uniqueName='uniqueName')
Content-type: application/json
Prefer: create-if-missing

{
  "description": "Self help community for golf",
  "displayName": "Golf Assist",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "golfassist",
  "securityEnabled": false
}

Respuesta

En el ejemplo siguiente se muestra la respuesta. El valor de la propiedad preferredDataLocation se hereda de la ubicación de datos preferida del creador del grupo.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2018-12-22T02:21:05Z",
    "description": "Self help community for golf",
    "displayName": "Golf Assist",
    "expirationDateTime": null,
    "groupTypes": [
        "Unified"
    ],
    "isAssignableToRole": null,
    "mail": "golfassist@contoso.com",
    "mailEnabled": true,
    "mailNickname": "golfassist",
    "membershipRule": null,
    "membershipRuleProcessingState": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": "CAN",
    "preferredLanguage": null,
    "proxyAddresses": [
        "SMTP:golfassist@contoso.onmicrosoft.com"
    ],
    "renewedDateTime": "2018-12-22T02:21:05Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": false,
    "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555",
    "theme": null,
    "visibility": "Public",
    "uniqueName": "uniqueName",
    "onPremisesProvisioningErrors": []
}

Ejemplo 2: Creación de un grupo de seguridad con un propietario y miembros si no existe

En el ejemplo siguiente se crea un grupo de seguridad con un propietario y miembros especificados porque no existe un grupo con el valor uniqueName especificado. Es necesario tener en cuenta que se puede agregar un máximo de 20 relaciones, como propietarios y miembros, como parte de la creación del grupo. Posteriormente, puede agregar varios miembros adicionales mediante la API de miembros o el procesamiento por lotes JSON.

Un usuario que no es administrador no puede agregarse a la colección de propietarios del grupo. Para obtener más información, consulte el problema conocido relacionado.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/v1.0/groups(uniqueName='uniqueName')
Content-Type: application/json

{
  "description": "Group with designated owner and members",
  "displayName": "Operations group",
  "groupTypes": [
  ],
  "mailEnabled": false,
  "mailNickname": "operations2019",
  "securityEnabled": true,
  "owners@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2"
  ],
  "members@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/ff7cb387-6688-423c-8188-3da9532a73cc",
    "https://graph.microsoft.com/v1.0/users/69456242-0067-49d3-ba96-9de6f2728e14"
  ]
}

Respuesta

Aquí se muestra el ejemplo de una respuesta correcta. Incluye solo propiedades predeterminadas. Luego, puede obtener las propiedades de navegación propietarios o miembros del grupo para comprobar los detalles del propietario y los miembros. El valor de la propiedad preferredDataLocation se hereda de la ubicación de datos preferida del creador del grupo.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/1226170d-83d5-49b8-99ab-d1ab3d91333e/Microsoft.DirectoryServices.Group",
    "id": "1226170d-83d5-49b8-99ab-d1ab3d91333e",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2021-09-21T07:14:44Z",
    "createdByAppId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
    "organizationId": "84841066-274d-4ec0-a5c1-276be684bdd3",
    "description": "Group with designated owner and members",
    "displayName": "Operations group",
    "expirationDateTime": null,
    "groupTypes": [],
    "infoCatalogs": [],
    "isAssignableToRole": null,
    "isManagementRestricted": null,
    "mail": null,
    "mailEnabled": false,
    "mailNickname": "operations2019",
    "membershipRule": null,
    "membershipRuleProcessingState": null,
    "onPremisesDomainName": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesNetBiosName": null,
    "onPremisesSamAccountName": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": null,
    "preferredLanguage": null,
    "proxyAddresses": [],
    "renewedDateTime": "2021-09-21T07:14:44Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": true,
    "securityIdentifier": "S-1-12-1-304486157-1236829141-2882644889-1043566909",
    "theme": null,
    "uniqueName": "uniqueName",
    "visibility": null,
    "writebackConfiguration": {
        "isEnabled": null,
        "onPremisesGroupType": null
    },
    "onPremisesProvisioningErrors": []
}

Ejemplo 3: Actualización de un grupo existente

En este ejemplo, el grupo especificado ya existe, por lo que la operación se trata como una actualización.

Un usuario que no es administrador no puede agregarse a la colección de propietarios del grupo. Para obtener más información, consulte el problema conocido relacionado.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/v1.0/groups
Content-Type: application/json

{
    "description": "Group assignable to a role",
    "displayName": "Role assignable group",
    "groupTypes": [
        "Unified"
    ],
    "isAssignableToRole": true,
    "mailEnabled": true,
    "securityEnabled": true,
    "mailNickname": "contosohelpdeskadministrators",
    "owners@odata.bind": [
        "https://graph.microsoft.com/v1.0/users/99e44b05-c10b-4e95-a523-e2732bbaba1e"
    ],
    "members@odata.bind": [
        "https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0",
        "https://graph.microsoft.com/v1.0/users/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e"
    ]
}

Respuesta

En el ejemplo siguiente se muestra la respuesta. El valor de la propiedad preferredDataLocation se hereda de la ubicación de datos preferida del creador del grupo.

HTTP/1.1 204 No Content