Skip to content

Commit 4def623

Browse files
authored
Merge branch 'main' into davidk-educationdatasync-remove-syncprofiles
2 parents cee16c8 + 3bba56a commit 4def623

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

api-reference/beta/api/schemaextension-post-schemaextensions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.localizationpriority: medium
55
author: "dkershaw10"
66
doc_type: apiPageType
77
ms.subservice: extensions
8-
ms.date: 07/29/2024
8+
ms.date: 01/17/2025
99
---
1010

1111
# Create schemaExtension
@@ -54,11 +54,11 @@ The following table shows the properties that are available when you create a sc
5454

5555
| Parameter | Type | Description|
5656
|:---------------|:--------|:----------|
57-
|description|String|Description for the schema extension.|
58-
|id|String|The unique identifier for the schema extension definition. <br>You can assign a value in one of two ways: <ul><li>Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. As an example, `contoso_mySchema`. NOTE: Only verified domains under the following top-level domains are supported: `.com`,`.net`, `.gov`, `.edu` or `.org`. </li><li>Provide a schema name, and let Microsoft Graph use that schema name to complete the **id** assignment in this format: ext\{_&#65279;8-random-alphanumeric-chars_\}\_\{_&#65279;schema-name_\}. An example would be `extkvbmkofy_mySchema`.</li></ul>This property cannot be changed after creation. |
59-
|owner|String|(Optional) The `appId` of the application that is the owner of the schema extension. This property can be supplied on creation, to set the owner. If not supplied, then the calling application's `appId` will be set as the owner. So, for example, if creating a new schema extension definition using Graph Explorer, you **must** supply the owner property. Once set, this property is read-only and cannot be changed.|
60-
|properties|[extensionSchemaProperty](../resources/extensionschemaproperty.md) collection|The collection of property names and types that make up the schema extension definition.|
61-
|targetTypes|String collection|Set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to.|
57+
|description|String|Optional. Description for the schema extension.|
58+
|id|String|Required. The unique identifier for the schema extension definition. <br>You can assign a value in one of two ways: <ul><li>Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. As an example, `contoso_mySchema`. NOTE: Only verified domains under the following top-level domains are supported: `.com`,`.net`, `.gov`, `.edu` or `.org`. </li><li>Provide a schema name, and let Microsoft Graph use that schema name to complete the **id** assignment in this format: ext\{_&#65279;8-random-alphanumeric-chars_\}\_\{_&#65279;schema-name_\}. An example would be `extkvbmkofy_mySchema`.</li></ul>This property cannot be changed after creation. |
59+
|owner|String|Conditional. The `appId` of the application that is the owner of the schema extension. This property can be supplied on creation, to set the owner. If not supplied, then the calling application's `appId` will be set as the owner. So, for example, if creating a new schema extension definition using Graph Explorer, you **must** supply the owner property. Once set, this property is read-only and cannot be changed.|
60+
|properties|[extensionSchemaProperty](../resources/extensionschemaproperty.md) collection|Required. The collection of property names and types that make up the schema extension definition.|
61+
|targetTypes|String collection|Required. Set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to.|
6262

6363
## Response
6464

@@ -70,7 +70,7 @@ If successful, this method returns `201 Created` response code and [schemaExtens
7070

7171
#### Request
7272

73-
The following example shows using a verified domain name, `graphlearn`, and a schema name, `courses`, to form a unique string for the **id** property of the schema extension definition. The unique string is based on this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}.
73+
The following example shows using a verified domain name, `graphlearn`, and a schema name, `courses`, to form a unique string for the **id** property of the schema extension definition. The unique string is based on this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. With the exclusion of the **owner** from the request body, Microsoft Graph expects the caller to be the owner of the app making this request.
7474

7575
In the request body, supply a JSON representation of the [schemaExtension](../resources/schemaextension.md) object.
7676

@@ -182,7 +182,7 @@ Content-type: application/json
182182

183183
#### Request
184184

185-
The following example shows specifying just a schema name, `courses`, in the **id** property in the request, together with the JSON representation of the rest of the properties in the [schemaExtension](../resources/schemaextension.md) object. Microsoft Graph will assign and return a unique string value in the response.
185+
The following example shows specifying just a schema name, `courses`, in the **id** property in the request, together with the JSON representation of the rest of the properties in the [schemaExtension](../resources/schemaextension.md) object. Microsoft Graph will assign and return a unique string value in the response. With the exclusion of the **owner** from the request body, Microsoft Graph expects the caller to be the owner of the app making this request.
186186

187187

188188
# [HTTP](#tab/http)

api-reference/v1.0/api/schemaextension-post-schemaextensions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.localizationpriority: high
55
author: "dkershaw10"
66
ms.subservice: extensions
77
doc_type: apiPageType
8-
ms.date: 07/30/2024
8+
ms.date: 01/17/2025
99
---
1010

1111
# Create schemaExtension
@@ -52,11 +52,11 @@ The following table shows the properties that are required when you create a sch
5252

5353
| Parameter | Type | Description|
5454
|:---------------|:--------|:----------|
55-
|description|String|Description for the schema extension.|
56-
|id|String|The unique identifier for the schema extension definition. <br>You can assign a value in one of two ways: <ul><li>Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. As an example, `contoso_mySchema`. NOTE: Only verified domains under the following top-level domains are supported: `.com`,`.net`, `.gov`, `.edu` or `.org`. </li><li>Provide a schema name, and let Microsoft Graph use that schema name to complete the **id** assignment in this format: ext\{_&#65279;8-random-alphanumeric-chars_\}\_\{_&#65279;schema-name_\}. An example would be `extkvbmkofy_mySchema`.</li></ul>This property cannot be changed after creation. |
57-
|owner|String|(Optional) The `appId` of the application that is the owner of the schema extension. By default, the calling application's `appId` will be set as the owner. However, the property may be supplied on creation, to set the owner appId to something different from the calling app. In all cases, in the delegated flow, the signed-in user **must** be the owner of the application being set as the schema extension's owner. So, for example, if creating a new schema extension definition using Graph Explorer, you **must** supply the owner property, for an appId you own. Once set, this property is read-only and cannot be changed.|
58-
|properties|[extensionSchemaProperty](../resources/extensionschemaproperty.md) collection|The collection of property names and types that make up the schema extension definition.|
59-
|targetTypes|String collection|Set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to.|
55+
|description|String|Optional. Description for the schema extension.|
56+
|id|String|Required. The unique identifier for the schema extension definition. <br>You can assign a value in one of two ways: <ul><li>Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. As an example, `contoso_mySchema`. NOTE: Only verified domains under the following top-level domains are supported: `.com`,`.net`, `.gov`, `.edu` or `.org`. </li><li>Provide a schema name, and let Microsoft Graph use that schema name to complete the **id** assignment in this format: ext\{_&#65279;8-random-alphanumeric-chars_\}\_\{_&#65279;schema-name_\}. An example would be `extkvbmkofy_mySchema`.</li></ul>This property cannot be changed after creation. |
57+
|owner|String|Conditional. The `appId` of the application that is the owner of the schema extension. By default, the calling application's `appId` will be set as the owner. However, the property may be supplied on creation, to set the owner appId to something different from the calling app. In all cases, in the delegated flow, the signed-in user **must** be the owner of the application being set as the schema extension's owner. So, for example, if creating a new schema extension definition using Graph Explorer, you **must** supply the owner property, for an appId you own. Once set, this property is read-only and cannot be changed.|
58+
|properties|[extensionSchemaProperty](../resources/extensionschemaproperty.md) collection|Required. The collection of property names and types that make up the schema extension definition.|
59+
|targetTypes|String collection|Required. Set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to.|
6060

6161
## Response
6262

@@ -68,7 +68,7 @@ If successful, this method returns `201 Created` response code and [schemaExtens
6868

6969
#### Request
7070

71-
This example shows using a verified domain name, `graphlearn`, and a schema name, `courses`, to form a unique string for the **id** property of the schema extension definition. The unique string is based on this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}.
71+
This example shows using a verified domain name, `graphlearn`, and a schema name, `courses`, to form a unique string for the **id** property of the schema extension definition. The unique string is based on this format, \{_&#65279;domainName_\}\_\{_&#65279;schemaName_\}. With the exclusion of the **owner** from the request body, Microsoft Graph expects the caller to be the owner of the app making this request.
7272

7373
# [HTTP](#tab/http)
7474
<!-- {
@@ -178,7 +178,7 @@ Content-type: application/json
178178

179179
#### Request
180180

181-
The following example shows specifying just a schema name, `courses`, in the **id** property in the request, together with the JSON representation of the rest of the properties in the [schemaExtension](../resources/schemaextension.md) object. Microsoft Graph will assign and return a unique string value in the response.
181+
The following example shows specifying just a schema name, `courses`, in the **id** property in the request, together with the JSON representation of the rest of the properties in the [schemaExtension](../resources/schemaextension.md) object. Microsoft Graph will assign and return a unique string value in the response. With the exclusion of the **owner** from the request body, Microsoft Graph expects the caller to be the owner of the app making this request.
182182

183183

184184
# [HTTP](#tab/http)

concepts/extensibility-schema-groups.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.subservice: extensions
88
ms.localizationpriority: high
99
ms.custom: graphiamtop20
1010
ms.topic: tutorial
11-
ms.date: 01/25/2024
11+
ms.date: 01/17/2025
1212
#Customer intent: As a developer, I want to learn how to store lightweight data to Microsoft Entra groups through Microsoft Graph, and avoid using an external database system.
1313
---
1414

@@ -113,15 +113,16 @@ You can also query by the **id** as a path parameter as follows: `GET https://gr
113113

114114
You want to create and register a new extension definition for training courses on the **group** resource. Specify the following properties:
115115

116-
- **id**: Provide a string for this property following one of two ways:
117-
- Option 1: Concatenate a *verified* vanity domain name for your tenant with a name for the schema extension. For example, if the domain is `bellowscollege.com`, and the name of the schema extension is `courses`, then you can use the **id** `bellowscollege_courses`.
116+
- **id**: *Required.* Provide a string for this property following one of two ways:
117+
- Option 1: Concatenate a *verified* vanity domain name for your tenant with a name for the schema extension. For example, if the domain is `bellowscollege.com`, and the name of the schema extension is `courses`, then you can use the **id** `bellowscollege_courses`. The request fails if you use a domain name that isn't verified with your tenant.
118118
- Option 2: An alternative way is to provide only a schema name, such as `courses`, and let Microsoft Graph automatically generate the **id** for you by prefixing the provided name with a random alphanumeric string.
119119

120120
This **id** becomes the name of the schema extension property on a group.
121-
- **description**
122-
- **targetTypes**: Specify the resource types that the schema extension can be applied to. In this example, the resource type is `Group`. You can add more resource types by updating the schema extension definition later.
123-
- **properties**: Specify the custom properties that make up the schema. In this example, specify the `courseId`, `courseName` and `courseType` custom properties and their types. Only additive changes are permitted after you create the schema extension definition.
124-
- **owner**: Specify the application that owns the schema extension definition. If you're running this example from an app that you're not assigned as owner, specify the **appId** of the application that you're assigned in the **owner** property.
121+
122+
- **description**: *Optional.*
123+
- **targetTypes**: *Required*. Specify the resource types that the schema extension can be applied to. In this example, the resource type is `Group`. You can add more resource types by updating the schema extension definition later. Only additive changes are permitted after you create the schema extension definition.
124+
- **properties**: *Required*. Specify the custom properties that make up the schema. In this example, specify the `courseId`, `courseName`, and `courseType` custom properties and their types. Only additive changes are permitted after you create the schema extension definition.
125+
- **owner**: *Conditional*. Specify the application that owns the schema extension definition. If you're running this example from an app that you're not assigned as owner, specify the **appId** of the application that you're assigned in the **owner** property.
125126

126127
### Request
127128

0 commit comments

Comments
 (0)