Skip to content

Commit 933ee59

Browse files
LauragraLauragra
authored
Merge pull request #25325 from skashyap7/dev/skashyap/graph-docs-uxsettings
Dev/skashyap/graph docs uxsettings
2 parents f2e69b0 + ca0d6de commit 933ee59

File tree

12 files changed

+380
-1
lines changed

12 files changed

+380
-1
lines changed

‎api-reference/beta/api/uxsetting-get.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: "Get uxSetting"
3+
description: "Get the properties and relationships of a uxSetting object."
4+
author: "skashyap7"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-directory-management"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get uxSetting
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get the properties and relationships of a [uxSetting](../resources/uxsetting.md) object.
17+
18+
## Permissions
19+
20+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- {
23+
"blockType": "permissions",
24+
"name": "uxsetting-get-permissions"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/uxsetting-get-permissions.md)]
28+
29+
[!INCLUDE [rbac-rbac-uxsetting-apis](../includes/rbac-for-apis/rbac-uxsetting-apis.md)]
30+
31+
## HTTP request
32+
33+
<!-- {
34+
"blockType": "ignored"
35+
}
36+
-->
37+
``` http
38+
GET /admin/entra/uxSetting
39+
```
40+
41+
## Optional query parameters
42+
43+
This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
53+
Don't supply a request body for this method.
54+
55+
## Response
56+
57+
If successful, this method returns a `200 OK` response code and a [uxSetting](../resources/uxsetting.md) object in the response body.
58+
59+
## Examples
60+
61+
### Request
62+
63+
The following example shows a request.
64+
65+
<!-- {
66+
"blockType": "request",
67+
"name": "get_uxsetting"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/admin/entra/uxSetting
72+
```
73+
74+
### Response
75+
76+
The following example shows the response.
77+
78+
>**Note:** The response object shown here might be shortened for readability.
79+
<!-- {
80+
"blockType": "response",
81+
"truncated": true,
82+
"@odata.type": "microsoft.graph.uxSetting"
83+
}
84+
-->
85+
``` http
86+
HTTP/1.1 200 OK
87+
Content-Type: application/json
88+
89+
{
90+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/entra/uxSetting/$entity",
91+
"restrictNonAdminAccess": "false",
92+
"id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
93+
}
94+
```

‎api-reference/beta/api/uxsetting-update.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: "Update uxSetting"
3+
description: "Update the properties of a uxSetting object."
4+
author: "skashyap7"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-directory-management"
7+
doc_type: apiPageType
8+
---
9+
10+
# Update uxSetting
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Update the properties of a [uxSetting](../resources/uxsetting.md) object.
17+
18+
## Permissions
19+
20+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/
21+
graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "uxsetting-update-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/uxsetting-update-permissions.md)]
29+
30+
[!INCLUDE [rbac-rbac-uxsetting-apis](../includes/rbac-for-apis/rbac-uxsetting-apis.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
PATCH /admin/entra/uxSetting
40+
```
41+
42+
## Request headers
43+
|Name|Description|
44+
|:---|:---|
45+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
46+
|Content-Type|application/json. Required.|
47+
48+
## Request body
49+
50+
[!INCLUDE [table-intro](../../includes/update-property-table-intro.md)]
51+
52+
|Property|Type|Description|
53+
|:---|:---|:---|
54+
|restrictNonAdminAccess|nonAdminSetting|If set to `true`, nonadministrators can't browse the Microsoft Entra admin center. Nonadministrators who are owners of groups or applications are unable to use the Azure portal to manage their owned resources. If set to `false`, nonadministrators can browse the Microsoft Entra admin center. The possible values are: `false`, `true`, `unknownFutureValue`.|
55+
56+
## Response
57+
58+
If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
59+
60+
## Examples
61+
62+
### Request
63+
64+
The following example shows a request.
65+
66+
<!-- {
67+
"blockType": "request",
68+
"name": "update_uxsetting"
69+
}
70+
-->
71+
``` http
72+
PATCH https://graph.microsoft.com/beta/admin/entra/uxSetting
73+
Content-Type: application/json
74+
75+
{
76+
"restrictNonAdminAccess": "true"
77+
}
78+
```
79+
80+
### Response
81+
82+
The following example shows the response.
83+
84+
<!-- {
85+
"blockType": "response",
86+
"truncated": true
87+
}
88+
-->
89+
``` http
90+
HTTP/1.1 204 No Content
91+
```
92+

‎api-reference/beta/includes/permissions/uxsetting-get-permissions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Not supported.|Not supported.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Not supported.|Not supported.|

‎api-reference/beta/includes/permissions/uxsetting-update-permissions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Not supported.|Not supported.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Not supported.|Not supported.|

‎api-reference/beta/includes/rbac-for-apis/rbac-uxsetting-apis.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
author: skashyap7
3+
ms.topic: include
4+
---
5+
6+
> [!IMPORTANT]
7+
>
8+
> In delegated scenarios with work or school accounts, the signed-in user must be assigned the *Global Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).

‎api-reference/beta/resources/admin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Represents an entity that acts as a container for administrator functionality.
2424
|Relationship|Type|Description|
2525
|:---|:---|:---|
2626
| edge | [edge](edge.md) | A container for Microsoft Edge resources. Read-only. |
27+
| entra | [entra](entra.md) | A container for Microsoft Entra resources. Read-only. |
2728
| microsoft365Apps |[adminMicrosoft365Apps](../resources/adminmicrosoft365apps.md)|A container for the Microsoft 365 apps admin functionality.|
2829
| people | [peopleAdminSettings](../resources/peopleadminsettings.md) | Represents a setting to control people-related admin settings in the tenant. |
2930
| reportSettings |[microsoft.graph.adminReportSettings](../resources/adminreportsettings.md)|A container for administrative resources to manage reports.|

‎api-reference/beta/resources/entra.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "entra resource type"
3+
description: "Represents the entra resource related to access to Microsoft Entra settings."
4+
author: "skashyap7"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-directory-management"
7+
doc_type: resourcePageType
8+
---
9+
10+
# entra resource type
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Represents the entra resource related to access to Microsoft Entra settings.
17+
18+
Inherits from [entity](../resources/entity.md).
19+
20+
## Methods
21+
22+
None.
23+
24+
## Properties
25+
26+
None.
27+
28+
## Relationships
29+
30+
|Relationship|Type|Description|
31+
|:---|:---|:---|
32+
|uxSetting|[uxSetting](../resources/uxsetting.md)|Represents settings related to access to the Microsoft Entra admin center.|
33+
34+
## JSON representation
35+
The following JSON representation shows the resource type.
36+
<!-- {
37+
"blockType": "resource",
38+
"keyProperty": "id",
39+
"@odata.type": "microsoft.graph.entra",
40+
"baseType": "microsoft.graph.entity",
41+
"openType": false
42+
}
43+
-->
44+
``` json
45+
{
46+
"@odata.type": "#microsoft.graph.entra"
47+
}
48+
```

‎api-reference/beta/resources/enums.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4909,3 +4909,11 @@ Possible values for user account types (group membership), per Windows definitio
49094909
| none |
49104910
| all |
49114911
| unknownFutureValue |
4912+
4913+
### nonAdminSetting values
4914+
4915+
|Member|
4916+
|:---|
4917+
|false|
4918+
|true|
4919+
|unknownFutureValue|

‎api-reference/beta/resources/uxsetting.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "uxSetting resource type"
3+
description: "Represents settings related to access to the Microsoft Entra admin center."
4+
author: "skashyap7"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-directory-management"
7+
doc_type: resourcePageType
8+
---
9+
10+
# uxSetting resource type
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Represents settings related to access to the Microsoft Entra admin center.
17+
18+
Inherits from [entity](../resources/entity.md).
19+
20+
## Methods
21+
22+
|Method|Return type|Description|
23+
|:---|:---|:---|
24+
|[Get](../api/uxsetting-get.md)|[uxSetting](../resources/uxsetting.md)|Get the properties and relationships of a [uxSetting](../resources/uxsetting.md) object.|
25+
|[Update](../api/uxsetting-update.md)|None|Update the properties of a [uxSetting](../resources/uxsetting.md) object.|
26+
27+
## Properties
28+
29+
|Property|Type|Description|
30+
|:---|:---|:---|
31+
|id| String | The unique identifier for the tenant.|
32+
|restrictNonAdminAccess|nonAdminSetting|If set to `true`, nonadministrators can't browse the Microsoft Entra admin center. Nonadministrators who are owners of groups or applications are unable to use the Azure portal to manage their owned resources. If set to `false`, nonadministrators can browse the Microsoft Entra admin center. The possible values are: `false`, `true`, `unknownFutureValue`.|
33+
34+
## Relationships
35+
36+
None.
37+
38+
## JSON representation
39+
40+
The following JSON representation shows the resource type.
41+
42+
<!-- {
43+
"blockType": "resource",
44+
"keyProperty": "id",
45+
"@odata.type": "microsoft.graph.uxSetting",
46+
"openType": false
47+
}
48+
-->
49+
``` json
50+
{
51+
"@odata.type": "#microsoft.graph.uxSetting",
52+
"id": "String (identifier)",
53+
"restrictNonAdminAccess": "String"
54+
}
55+
```

‎api-reference/beta/toc/toc.mapping.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1007,7 +1007,8 @@
10071007
"deviceLocalCredentialInfo",
10081008
"featureRolloutPolicy",
10091009
"mobilityManagementPolicy",
1010-
"organizationSettings"
1010+
"organizationSettings",
1011+
"uxSetting"
10111012
],
10121013
"childNodes": [
10131014
{

0 commit comments

Comments
 (0)