-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
RoleEligibilityScheduleRequest.json
577 lines (577 loc) · 19.3 KB
/
RoleEligibilityScheduleRequest.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
{
"swagger": "2.0",
"info": {
"title": "AuthorizationManagementClient",
"version": "2020-10-01-preview",
"description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role eligibility grants access to Azure Active Directory users."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}": {
"put": {
"tags": [
"RoleEligibilityScheduleRequests"
],
"operationId": "RoleEligibilityScheduleRequests_Create",
"description": "Creates a role eligibility schedule request.",
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.",
"x-ms-skip-url-encoding": true
},
{
"name": "roleEligibilityScheduleRequestName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the role eligibility to create. It can be any valid GUID."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RoleEligibilityScheduleRequest"
},
"description": "Parameters for the role eligibility schedule request."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Created - Returns information about the role eligibility schedule request.",
"schema": {
"$ref": "#/definitions/RoleEligibilityScheduleRequest"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"PutRoleEligibilityScheduleRequest": {
"$ref": "./examples/PutRoleEligibilityScheduleRequest.json"
}
}
},
"get": {
"tags": [
"RoleEligibilityScheduleRequests"
],
"operationId": "RoleEligibilityScheduleRequests_Get",
"description": "Get the specified role eligibility schedule request.",
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the role eligibility schedule request.",
"x-ms-skip-url-encoding": true
},
{
"name": "roleEligibilityScheduleRequestName",
"in": "path",
"required": true,
"type": "string",
"description": "The name (guid) of the role eligibility schedule request to get."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns information about the role eligibility schedule request.",
"schema": {
"$ref": "#/definitions/RoleEligibilityScheduleRequest"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"GetRoleEligibilityScheduleRequestByName": {
"$ref": "./examples/GetRoleEligibilityScheduleRequestByName.json"
}
}
}
},
"/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests": {
"get": {
"tags": [
"RoleEligibilityScheduleRequests"
],
"operationId": "RoleEligibilityScheduleRequests_ListForScope",
"description": "Gets role eligibility schedule requests for a scope.",
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the role eligibility schedule requests.",
"x-ms-skip-url-encoding": true
},
{
"name": "$filter",
"in": "query",
"required": false,
"type": "string",
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of role eligibility schedule requests.",
"schema": {
"$ref": "#/definitions/RoleEligibilityScheduleRequestListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/RoleEligibilityScheduleRequestFilter",
"x-ms-examples": {
"GetRoleEligibilityScheduleRequestByScope": {
"$ref": "./examples/GetRoleEligibilityScheduleRequestByScope.json"
}
}
}
},
"/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/cancel": {
"post": {
"tags": [
"RoleEligibilityScheduleRequests"
],
"operationId": "RoleEligibilityScheduleRequests_Cancel",
"description": "Cancels a pending role eligibility schedule request.",
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the role eligibility request to cancel.",
"x-ms-skip-url-encoding": true
},
{
"name": "roleEligibilityScheduleRequestName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the role eligibility request to cancel."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns success."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"CancelRoleEligibilityScheduleRequestByName": {
"$ref": "./examples/CancelRoleEligibilityScheduleRequestByName.json"
}
}
}
}
},
"definitions": {
"RoleEligibilityScheduleRequestFilter": {
"properties": {
"principalId": {
"type": "string",
"description": "Returns role eligibility requests of the specific principal."
},
"roleDefinitionId": {
"type": "string",
"description": "Returns role eligibility requests of the specific role definition."
},
"requestorId": {
"type": "string",
"description": "Returns role eligibility requests created by specific principal."
},
"status": {
"type": "string",
"description": "Returns role eligibility requests of specific status."
}
},
"description": "Role eligibility schedule request filter"
},
"RoleEligibilityScheduleRequestProperties": {
"properties": {
"scope": {
"type": "string",
"readOnly": true,
"description": "The role eligibility schedule request scope."
},
"roleDefinitionId": {
"type": "string",
"description": "The role definition ID."
},
"principalId": {
"type": "string",
"description": "The principal ID."
},
"principalType": {
"type": "string",
"readOnly": true,
"description": "The principal type of the assigned principal ID.",
"enum": [
"User",
"Group",
"ServicePrincipal"
],
"x-ms-enum": {
"name": "PrincipalType",
"modelAsString": true
}
},
"requestType": {
"type": "string",
"description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc",
"enum": [
"AdminAssign",
"AdminRemove",
"AdminUpdate",
"AdminExtend",
"AdminRenew",
"SelfActivate",
"SelfDeactivate",
"SelfExtend",
"SelfRenew"
],
"x-ms-enum": {
"name": "RequestType",
"modelAsString": true
}
},
"status": {
"type": "string",
"readOnly": true,
"description": "The status of the role eligibility schedule request.",
"enum": [
"Accepted",
"PendingEvaluation",
"Granted",
"Denied",
"PendingProvisioning",
"Provisioned",
"PendingRevocation",
"Revoked",
"Canceled",
"Failed",
"PendingApprovalProvisioning",
"PendingApproval",
"FailedAsResourceIsLocked",
"PendingAdminDecision",
"AdminApproved",
"AdminDenied",
"TimedOut",
"ProvisioningStarted",
"Invalid",
"PendingScheduleCreation",
"ScheduleCreated",
"PendingExternalProvisioning"
],
"x-ms-enum": {
"name": "Status",
"modelAsString": true
}
},
"approvalId": {
"type": "string",
"readOnly": true,
"description": "The approvalId of the role eligibility schedule request."
},
"scheduleInfo": {
"properties": {
"startDateTime": {
"type": "string",
"format": "date-time",
"description": "Start DateTime of the role eligibility schedule."
},
"expiration": {
"properties": {
"type": {
"type": "string",
"description": "Type of the role eligibility schedule expiration",
"enum": [
"AfterDuration",
"AfterDateTime",
"NoExpiration"
],
"x-ms-enum": {
"name": "Type",
"modelAsString": true
}
},
"endDateTime": {
"type": "string",
"format": "date-time",
"description": "End DateTime of the role eligibility schedule."
},
"duration": {
"type": "string",
"description": "Duration of the role eligibility schedule in TimeSpan."
}
},
"description": "Expiration of the role eligibility schedule"
}
},
"description": "Schedule info of the role eligibility schedule"
},
"targetRoleEligibilityScheduleId": {
"type": "string",
"description": "The resultant role eligibility schedule id or the role eligibility schedule id being updated"
},
"targetRoleEligibilityScheduleInstanceId": {
"type": "string",
"description": "The role eligibility schedule instance id being updated"
},
"justification": {
"type": "string",
"description": "Justification for the role eligibility"
},
"ticketInfo": {
"properties": {
"ticketNumber": {
"type": "string",
"description": "Ticket number for the role eligibility"
},
"ticketSystem": {
"type": "string",
"description": "Ticket system name for the role eligibility"
}
},
"description": "Ticket Info of the role eligibility"
},
"condition": {
"type": "string",
"description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'"
},
"conditionVersion": {
"type": "string",
"description": "Version of the condition. Currently accepted value is '2.0'"
},
"createdOn": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "DateTime when role eligibility schedule request was created"
},
"requestorId": {
"type": "string",
"readOnly": true,
"description": "Id of the user who created this request"
},
"expandedProperties": {
"readOnly": true,
"type": "object",
"description": "Additional properties of principal, scope and role definition",
"$ref": "#/definitions/ExpandedProperties"
}
},
"required": [
"roleDefinitionId",
"principalId",
"requestType"
],
"description": "Role eligibility schedule request properties with scope."
},
"RoleEligibilityScheduleRequest": {
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The role eligibility schedule request ID."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The role eligibility schedule request name."
},
"type": {
"type": "string",
"readOnly": true,
"description": "The role eligibility schedule request type."
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/RoleEligibilityScheduleRequestProperties",
"description": "Role eligibility schedule request properties."
}
},
"description": "Role Eligibility schedule request"
},
"RoleEligibilityScheduleRequestListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleEligibilityScheduleRequest"
},
"description": "Role eligibility schedule request list."
},
"nextLink": {
"type": "string",
"description": "The URL to use for getting the next set of results."
}
},
"description": "Role eligibility schedule request list operation result."
},
"CloudError": {
"x-ms-external": true,
"properties": {
"error": {
"$ref": "#/definitions/CloudErrorBody"
}
},
"description": "An error response from the service."
},
"CloudErrorBody": {
"x-ms-external": true,
"properties": {
"code": {
"type": "string",
"description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
},
"message": {
"type": "string",
"description": "A message describing the error, intended to be suitable for display in a user interface."
}
},
"description": "An error response from the service."
},
"ExpandedProperties": {
"properties": {
"scope": {
"type": "object",
"description": "Details of the resource scope",
"properties": {
"id": {
"type": "string",
"description": "Scope id of the resource"
},
"displayName": {
"type": "string",
"description": "Display name of the resource"
},
"type": {
"type": "string",
"description": "Type of the resource"
}
}
},
"roleDefinition": {
"type": "object",
"description": "Details of role definition",
"properties": {
"id": {
"type": "string",
"description": "Id of the role definition"
},
"displayName": {
"type": "string",
"description": "Display name of the role definition"
},
"type": {
"type": "string",
"description": "Type of the role definition"
}
}
},
"principal": {
"type": "object",
"description": "Details of the principal",
"properties": {
"id": {
"type": "string",
"description": "Id of the principal"
},
"displayName": {
"type": "string",
"description": "Display name of the principal"
},
"email": {
"type": "string",
"description": "Email id of the principal"
},
"type": {
"type": "string",
"description": "Type of the principal"
}
}
}
}
}
},
"parameters": {
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The API version to use for this operation."
}
}
}