Obtener grupo
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Obtiene las propiedades y relaciones de un objeto group.
Esta operación devuelve de forma predeterminada solo un subconjunto de todas las propiedades disponibles, como se indica en la sección Propiedades. Para obtener propiedades que no se t_ de forma predeterminada, especifíquelas en una $select
opción de consulta de OData. Las propiedades hasMembersWithLicenseErrors e isArchived son una excepción y no se devuelven en la $select
consulta. Como el recurso de group admite extensiones, también puede utilizar la operación GET
para obtener propiedades personalizadas y datos de extensión en una instancia de group.
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) | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
Aplicación | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Solicitud HTTP
GET /groups/{id}
Parámetros de consulta opcionales
Puede usar $select
para obtener propiedades de grupo específicas, incluidas las propiedades que no se devuelven de forma predeterminada. Las propiedades de extensión también admiten parámetros de consulta como se indica a continuación:
Tipo de extensión | Comentarios |
---|---|
Extensiones de esquema | Solo se devuelve con $select . |
Extensiones abiertas | Se devuelve a través de la operación Obtener extensión abierta. |
Extensiones de directorio | Se devuelve de forma predeterminada. |
Para más información sobre las opciones de consulta de OData, vea Parámetros de consulta de OData.
Encabezados de solicitud
Nombre | Tipo | Descripción |
---|---|---|
Authorization | string | {token} de portador. Obligatorio. |
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK
y el objeto group en el cuerpo de la respuesta. Devuelve las propiedades predeterminadas a menos que se use $select
para especificar propiedades específicas.
Ejemplo
Ejemplo 1: Devolver todas las propiedades predeterminadas
Solicitud
Este es un ejemplo de una solicitud GET.
GET https://graph.microsoft.com/beta/groups/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4
Respuesta
Este es un ejemplo de la respuesta: Incluye sólo las propiedades predeterminadas.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad. Se devolverán las propiedades predeterminadas en una llamada real.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups/$entity",
"@odata.id": "https://graph.microsoft.com/v2/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4/directoryObjects/4de51a22-3289-4ea5-bbdb-8503ea644f1b/Microsoft.DirectoryServices.Group",
"id": "4de51a22-3289-4ea5-bbdb-8503ea644f1b",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2021-09-13T10:07:01Z",
"createdByAppId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
"organizationId": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
"description": "Self help community for library",
"displayName": "Library Assist",
"expirationDateTime": "2022-01-11T10:07:01Z",
"groupTypes": [
"Unified"
],
"infoCatalogs": [],
"isAssignableToRole": null,
"isManagementRestricted": null,
"mail": "library@contoso.com",
"mailEnabled": true,
"mailNickname": "library",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesDomainName": null,
"onPremisesLastSyncDateTime": null,
"onPremisesNetBiosName": null,
"onPremisesSamAccountName": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": "EU",
"preferredLanguage": null,
"proxyAddresses": [
"SPO:SPO_0dbffe23-f6fb-4478-adcd-880daf88bb12@SPO_45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
"SMTP:library@contoso.com"
],
"renewedDateTime": "2021-09-13T10:07:01Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-1306860066-1319449225-59104187-458188010",
"serviceProvisioningErrors": [],
"theme": null,
"visibility": "Public",
"writebackConfiguration": {
"isEnabled": null,
"onPremisesGroupType": null
},
"onPremisesProvisioningErrors": []
}
Ejemplo 2: Devolver propiedades mediante $select
Solicitud
Este es un ejemplo de una solicitud GET.
GET https://graph.microsoft.com/beta/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount
Respuesta
Este es un ejemplo de la respuesta que incluye las propiedades no predeterminadas solicitadas.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
"id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
"allowExternalSenders": false,
"autoSubscribeNewMembers": false,
"isSubscribedByMail": false,
"unseenCount": 0
}
Ejemplo 3: leer un grupo dinámico específico
Solicitud
Este es un ejemplo de la solicitud.
GET https://graph.microsoft.com/beta/groups/1cdf9c18-a7dc-46b1-b47f-094d5656376d?$select=id,membershipRule,membershipRuleProcessingState,membershipRuleProcessingStatus
Respuesta
Este es un ejemplo de la respuesta:
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,membershipRule,membershipRuleProcessingState,membershipRuleProcessingStatus)/$entity",
"id": "1cdf9c18-a7dc-46b1-b47f-094d5656376d",
"membershipRule": "accountEnabled eq true",
"membershipRuleProcessingState": "On",
"membershipRuleProcessingStatus": {
"status" : "NotStarted",
"lastMembershipUpdated" : null,
"errorMessage" : null
}
}
Ejemplo 4: Comprobar si la administración de un grupo está restringida
Solicitud
GET https://graph.microsoft.com/beta/groups/aed0b780-965f-4149-85c5-a8c73e58brt6?$select=isManagementRestricted
Respuesta
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"isManagementRestricted": true
}
Contenido relacionado
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: a lo largo de 2024, eliminaremos gradualmente los problemas de GitHub como mecanismo de comentarios para el contenido y lo reemplazaremos por un nuevo sistema de comentarios. Para obtener más información, consulte:Enviar y ver comentarios de