Skip to content

Commit b8b5607

Browse files
authored
Merge pull request #2940 from microsoftgraph/WeeklyApiRefresh/202409031211
[v2] Weekly OpenApiDocs Refresh
2 parents af3621a + 032deb1 commit b8b5607

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+183978
-182188
lines changed

openApiDocs/beta/Applications.yml

+43-7
Original file line numberDiff line numberDiff line change
@@ -12069,14 +12069,49 @@ paths:
1206912069
default:
1207012070
$ref: '#/components/responses/error'
1207112071
x-ms-docs-operation-type: operation
12072+
put:
12073+
tags:
12074+
- servicePrincipals.customClaimsPolicy
12075+
summary: Update customClaimsPolicy
12076+
description: Update a customClaimsPolicy object.
12077+
externalDocs:
12078+
description: Find more info here
12079+
url: https://learn.microsoft.com/graph/api/customclaimspolicy-update?view=graph-rest-beta
12080+
operationId: servicePrincipal_SetClaimsPolicy
12081+
parameters:
12082+
- name: servicePrincipal-id
12083+
in: path
12084+
description: The unique identifier of servicePrincipal
12085+
required: true
12086+
style: simple
12087+
schema:
12088+
type: string
12089+
x-ms-docs-key-type: servicePrincipal
12090+
requestBody:
12091+
description: New navigation property values
12092+
content:
12093+
application/json:
12094+
schema:
12095+
$ref: '#/components/schemas/microsoft.graph.customClaimsPolicy'
12096+
required: true
12097+
responses:
12098+
2XX:
12099+
description: Success
12100+
content:
12101+
application/json:
12102+
schema:
12103+
$ref: '#/components/schemas/microsoft.graph.customClaimsPolicy'
12104+
default:
12105+
$ref: '#/components/responses/error'
12106+
x-ms-docs-operation-type: operation
1207212107
patch:
1207312108
tags:
1207412109
- servicePrincipals.customClaimsPolicy
12075-
summary: Create or replace claimsPolicy
12076-
description: 'Create a new customClaimsPolicy object if it doesn''t exist, or replace an existing one.'
12110+
summary: Update customClaimsPolicy
12111+
description: Update a customClaimsPolicy object.
1207712112
externalDocs:
1207812113
description: Find more info here
12079-
url: https://learn.microsoft.com/graph/api/serviceprincipal-put-claimspolicy?view=graph-rest-beta
12114+
url: https://learn.microsoft.com/graph/api/customclaimspolicy-update?view=graph-rest-beta
1208012115
operationId: servicePrincipal_UpdateClaimsPolicy
1208112116
parameters:
1208212117
- name: servicePrincipal-id
@@ -29471,11 +29506,11 @@ components:
2947129506
properties:
2947229507
key:
2947329508
type: string
29474-
description: Contains the name of the field that a value is associated with.
29509+
description: Key.
2947529510
nullable: true
2947629511
value:
2947729512
type: string
29478-
description: Contains the corresponding value for the specified key.
29513+
description: Value.
2947929514
nullable: true
2948029515
additionalProperties:
2948129516
type: object
@@ -36337,11 +36372,11 @@ components:
3633736372
properties:
3633836373
displayName:
3633936374
type: string
36340-
description: The display name of the identity. This property is read-only.
36375+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
3634136376
nullable: true
3634236377
id:
3634336378
type: string
36344-
description: The identifier of the identity. This property is read-only.
36379+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
3634536380
nullable: true
3634636381
additionalProperties:
3634736382
type: object
@@ -43931,6 +43966,7 @@ components:
4393143966
properties:
4393243967
clientAppId:
4393343968
type: string
43969+
description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
4393443970
nullable: true
4393543971
requiredPermissionSet:
4393643972
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'

openApiDocs/beta/BackupRestore.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6158,11 +6158,11 @@ components:
61586158
properties:
61596159
displayName:
61606160
type: string
6161-
description: The display name of the identity. This property is read-only.
6161+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
61626162
nullable: true
61636163
id:
61646164
type: string
6165-
description: The identifier of the identity. This property is read-only.
6165+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
61666166
nullable: true
61676167
additionalProperties:
61686168
type: object

openApiDocs/beta/Bookings.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -2164,7 +2164,7 @@ paths:
21642164
tags:
21652165
- solutions.Actions
21662166
summary: Invoke action enable
2167-
description: Enable the Microsoft 365 Backup Storage service for a tenant.
2167+
description: 'Enable the Microsoft 365 Backup Storage service for a tenant. Before you call this API, call List protection policies to initialize the data store in the tenant. Data store initialization takes about 5 minutes. If you call this API before the data store is initialized, the call results in an error.'
21682168
externalDocs:
21692169
description: Find more info here
21702170
url: https://learn.microsoft.com/graph/api/backuprestoreroot-enable?view=graph-rest-beta
@@ -2196,7 +2196,7 @@ paths:
21962196
tags:
21972197
- solutions.Actions
21982198
summary: Invoke action activate
2199-
description: Activate a protectionPolicyBase.
2199+
description: 'Activate a protectionPolicyBase. Currently, only one active backup policy per underlying service is supported (that is, one for OneDrive accounts, one for SharePoint sites, and one for Exchange Online users). You can add or remove artifacts (sites or user accounts) to or from each active policy.'
22002200
externalDocs:
22012201
description: Find more info here
22022202
url: https://learn.microsoft.com/graph/api/protectionpolicybase-activate?view=graph-rest-beta
@@ -2297,7 +2297,7 @@ paths:
22972297
tags:
22982298
- solutions.Actions
22992299
summary: Invoke action activate
2300-
description: Activate a draft restoreSessionBase object.
2300+
description: 'Activate a draft restoreSessionBase object to restore a protection unit. The following points apply to restoring a protection unit:'
23012301
externalDocs:
23022302
description: Find more info here
23032303
url: https://learn.microsoft.com/graph/api/restoresessionbase-activate?view=graph-rest-beta
@@ -14128,11 +14128,11 @@ components:
1412814128
properties:
1412914129
displayName:
1413014130
type: string
14131-
description: The display name of the identity. This property is read-only.
14131+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
1413214132
nullable: true
1413314133
id:
1413414134
type: string
14135-
description: The identifier of the identity. This property is read-only.
14135+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
1413614136
nullable: true
1413714137
additionalProperties:
1413814138
type: object

openApiDocs/beta/BusinessScenario.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2245,11 +2245,11 @@ components:
22452245
properties:
22462246
displayName:
22472247
type: string
2248-
description: The display name of the identity. This property is read-only.
2248+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
22492249
nullable: true
22502250
id:
22512251
type: string
2252-
description: The identifier of the identity. This property is read-only.
2252+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
22532253
nullable: true
22542254
additionalProperties:
22552255
type: object

openApiDocs/beta/CloudCommunications.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -3409,10 +3409,10 @@ paths:
34093409
tags:
34103410
- communications.Actions
34113411
summary: Invoke action invite
3412-
description: 'Invite participants to the active call. For more information about how to handle operations, see commsOperation.'
3412+
description: 'Delete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled.'
34133413
externalDocs:
34143414
description: Find more info here
3415-
url: https://learn.microsoft.com/graph/api/participant-invite?view=graph-rest-beta
3415+
url: https://learn.microsoft.com/graph/api/participant-delete?view=graph-rest-beta
34163416
operationId: communication.call.participant_invite
34173417
parameters:
34183418
- name: call-id
@@ -11381,11 +11381,11 @@ paths:
1138111381
get:
1138211382
tags:
1138311383
- users.presence
11384-
summary: 'presence: setStatusMessage'
11385-
description: Set a presence status message for a user. An optional expiration date and time can be supplied.
11384+
summary: Get presence
11385+
description: Get a user's presence information.
1138611386
externalDocs:
1138711387
description: Find more info here
11388-
url: https://learn.microsoft.com/graph/api/presence-setstatusmessage?view=graph-rest-beta
11388+
url: https://learn.microsoft.com/graph/api/presence-get?view=graph-rest-beta
1138911389
operationId: user_GetPresence
1139011390
parameters:
1139111391
- name: user-id
@@ -13447,11 +13447,11 @@ components:
1344713447
properties:
1344813448
displayName:
1344913449
type: string
13450-
description: The display name of the identity. This property is read-only.
13450+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
1345113451
nullable: true
1345213452
id:
1345313453
type: string
13454-
description: The identifier of the identity. This property is read-only.
13454+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
1345513455
nullable: true
1345613456
additionalProperties:
1345713457
type: object

openApiDocs/beta/Compliance.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -12854,11 +12854,11 @@ components:
1285412854
properties:
1285512855
displayName:
1285612856
type: string
12857-
description: The display name of the identity. This property is read-only.
12857+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
1285812858
nullable: true
1285912859
id:
1286012860
type: string
12861-
description: The identifier of the identity. This property is read-only.
12861+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
1286212862
nullable: true
1286312863
additionalProperties:
1286412864
type: object
@@ -26112,11 +26112,11 @@ components:
2611226112
properties:
2611326113
key:
2611426114
type: string
26115-
description: Contains the name of the field that a value is associated with.
26115+
description: Key.
2611626116
nullable: true
2611726117
value:
2611826118
type: string
26119-
description: Contains the corresponding value for the specified key.
26119+
description: Value.
2612026120
nullable: true
2612126121
additionalProperties:
2612226122
type: object
@@ -29997,6 +29997,7 @@ components:
2999729997
properties:
2999829998
clientAppId:
2999929999
type: string
30000+
description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
3000030001
nullable: true
3000130002
requiredPermissionSet:
3000230003
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'

openApiDocs/beta/CrossDeviceExperiences.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -11371,11 +11371,11 @@ components:
1137111371
properties:
1137211372
displayName:
1137311373
type: string
11374-
description: The display name of the identity. This property is read-only.
11374+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
1137511375
nullable: true
1137611376
id:
1137711377
type: string
11378-
description: The identifier of the identity. This property is read-only.
11378+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
1137911379
nullable: true
1138011380
additionalProperties:
1138111381
type: object
@@ -13336,11 +13336,11 @@ components:
1333613336
properties:
1333713337
key:
1333813338
type: string
13339-
description: Contains the name of the field that a value is associated with.
13339+
description: Key.
1334013340
nullable: true
1334113341
value:
1334213342
type: string
13343-
description: Contains the corresponding value for the specified key.
13343+
description: Value.
1334413344
nullable: true
1334513345
additionalProperties:
1334613346
type: object
@@ -25802,6 +25802,7 @@ components:
2580225802
properties:
2580325803
clientAppId:
2580425804
type: string
25805+
description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
2580525806
nullable: true
2580625807
requiredPermissionSet:
2580725808
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'

openApiDocs/beta/DeviceManagement.Actions.yml

+12-11
Original file line numberDiff line numberDiff line change
@@ -20387,26 +20387,26 @@ components:
2038720387
nullable: true
2038820388
categoryId:
2038920389
type: string
20390-
description: Specify category in which the setting is under. Support $filters.
20390+
description: Specifies the area group under which the setting is configured in a specified configuration service provider (CSP)
2039120391
nullable: true
2039220392
description:
2039320393
type: string
20394-
description: Description of the setting.
20394+
description: Description of the item
2039520395
nullable: true
2039620396
displayName:
2039720397
type: string
20398-
description: 'Name of the setting. For example: Allow Toast.'
20398+
description: Display name of the item
2039920399
nullable: true
2040020400
helpText:
2040120401
type: string
20402-
description: Help text of the setting. Give more details of the setting.
20402+
description: Help text of the item
2040320403
nullable: true
2040420404
infoUrls:
2040520405
type: array
2040620406
items:
2040720407
type: string
2040820408
nullable: true
20409-
description: List of links more info for the setting can be found at.
20409+
description: List of links more info for the setting can be found at
2041020410
keywords:
2041120411
type: array
2041220412
items:
@@ -20430,7 +20430,7 @@ components:
2043020430
description: List of referred setting information.
2043120431
rootDefinitionId:
2043220432
type: string
20433-
description: Root setting definition id if the setting is a child setting.
20433+
description: Root setting definition if the setting is a child setting.
2043420434
nullable: true
2043520435
settingUsage:
2043620436
$ref: '#/components/schemas/microsoft.graph.deviceManagementConfigurationSettingUsage'
@@ -26185,7 +26185,7 @@ components:
2618526185
properties:
2618626186
settingDefinitionId:
2618726187
type: string
26188-
description: Setting definition id that is being referred to a setting. Applicable for reusable setting
26188+
description: Setting definition id that is being referred to a setting. Applicable for reusable setting.
2618926189
nullable: true
2619026190
additionalProperties:
2619126191
type: object
@@ -33771,11 +33771,11 @@ components:
3377133771
properties:
3377233772
displayName:
3377333773
type: string
33774-
description: The display name of the identity. This property is read-only.
33774+
description: 'The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
3377533775
nullable: true
3377633776
id:
3377733777
type: string
33778-
description: The identifier of the identity. This property is read-only.
33778+
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
3377933779
nullable: true
3378033780
additionalProperties:
3378133781
type: object
@@ -34267,11 +34267,11 @@ components:
3426734267
properties:
3426834268
key:
3426934269
type: string
34270-
description: Contains the name of the field that a value is associated with.
34270+
description: Key.
3427134271
nullable: true
3427234272
value:
3427334273
type: string
34274-
description: Contains the corresponding value for the specified key.
34274+
description: Value.
3427534275
nullable: true
3427634276
additionalProperties:
3427734277
type: object
@@ -41033,6 +41033,7 @@ components:
4103341033
properties:
4103441034
clientAppId:
4103541035
type: string
41036+
description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
4103641037
nullable: true
4103741038
requiredPermissionSet:
4103841039
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'

0 commit comments

Comments
 (0)