Skip to content

administrativeunit-get.md

Latest commit

 

History

History
216 lines (170 loc) · 8.26 KB

administrativeunit-get.md

File metadata and controls

216 lines (170 loc) · 8.26 KB
title Get administrativeUnit
description Retrieve the properties and relationships of an administrativeUnit object.
author DougKirschner
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 10/29/2024

Get administrativeUnit

Namespace: microsoft.graph

Retrieve the properties and relationships of an administrativeUnit object.

The administrativeUnit resource supports extensions, which also allows you to use the GET operation to get custom properties and extension data in an administrativeUnit instance.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-admin-units-apis-read]

HTTP request

GET /directory/administrativeUnits/{id}

Optional query parameters

This method supports the $select OData query parameter to help customize the response. Extension properties also support query parameters as follows:

Extension type Comments
Schema extensions Returned only with $select. Supports $filter (eq).
Directory extensions Returned by default. Supports $filter (eq).

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and administrativeUnit object in the response body.

Examples

Example 1: Get an administrative unit

The following example shows how to get an administrative unit.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/8a07f5a8-edc9-4847-bbf2-dde106594bf4

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directory/administrativeUnits/$entity",
    "id": "4d7ea995-bc0f-45c0-8c3e-132e93bf95f8",
    "deletedDateTime": null,
    "displayName": "Seattle District Technical Schools",
    "description": "Seattle district technical schools administration",
    "isMemberManagementRestricted": false,
    "membershipRule": "(user.country -eq \"United States\")",
    "membershipType": "Dynamic",
    "membershipRuleProcessingState": "On",
    "visibility": "HiddenMembership"
}

Example 2: Get a restricted management administrative unit

The following example shows a restricted management administrative unit ("isMemberManagementRestricted": true).

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/2sd35b05-ae71-48ab-9e7d-4r41a28te37d

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directory/administrativeUnits/$entity",
    "id": "2sd35b05-ae71-48ab-9e7d-4r41a28te37d",
    "deletedDateTime": null,
    "displayName": "Executive Division",
    "description": "Executive division administration",
    "isMemberManagementRestricted": true
}

Related content