Skip to content

Commit a7b2cff

Browse files
shubhamguptacalshubhamguptacal
committed
Exposing reviewers properties on accessReviewInstance model
1 parent 2fceaff commit a7b2cff

File tree

4 files changed

+361
-1
lines changed

4 files changed

+361
-1
lines changed

‎specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json

Lines changed: 254 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,63 @@
376376
}
377377
}
378378
}
379+
},
380+
"put": {
381+
"tags": [
382+
"PutAccessReviewInstance"
383+
],
384+
"operationId": "AccessReviewInstances_Create",
385+
"x-ms-examples": {
386+
"GetAccessReviews": {
387+
"$ref": "./examples/PutAccessReviewInstance.json"
388+
}
389+
},
390+
"description": "Update access review instance.",
391+
"parameters": [
392+
{
393+
"name": "scheduleDefinitionId",
394+
"in": "path",
395+
"required": true,
396+
"type": "string",
397+
"description": "The id of the access review schedule definition."
398+
},
399+
{
400+
"name": "id",
401+
"in": "path",
402+
"required": true,
403+
"type": "string",
404+
"description": "The id of the access review instance."
405+
},
406+
{
407+
"name": "properties",
408+
"in": "body",
409+
"required": true,
410+
"schema": {
411+
"$ref": "#/definitions/AccessReviewInstanceProperties"
412+
},
413+
"description": "Access review instance properties."
414+
},
415+
{
416+
"$ref": "#/parameters/ApiVersionParameter"
417+
},
418+
{
419+
"$ref": "#/parameters/SubscriptionIdParameter"
420+
}
421+
],
422+
"responses": {
423+
"200": {
424+
"description": "Successful update",
425+
"schema": {
426+
"$ref": "#/definitions/AccessReviewInstance"
427+
}
428+
},
429+
"default": {
430+
"description": "Unexpected error",
431+
"schema": {
432+
"$ref": "#/definitions/ErrorDefinition"
433+
}
434+
}
435+
}
379436
}
380437
},
381438
"/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/stop": {
@@ -622,6 +679,59 @@
622679
}
623680
}
624681
},
682+
"/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/contactedReviewers": {
683+
"get": {
684+
"tags": [
685+
"GetAccessReviewInstanceContactedReviewers"
686+
],
687+
"operationId": "AccessReviewInstanceContactedReviewers_List",
688+
"x-ms-examples": {
689+
"GetAccessReviews": {
690+
"$ref": "./examples/GetAccessReviewInstanceContactedReviewers.json"
691+
}
692+
},
693+
"description": "Get access review instance contacted reviewers",
694+
"parameters": [
695+
{
696+
"name": "scheduleDefinitionId",
697+
"in": "path",
698+
"required": true,
699+
"type": "string",
700+
"description": "The id of the access review schedule definition."
701+
},
702+
{
703+
"name": "id",
704+
"in": "path",
705+
"required": true,
706+
"type": "string",
707+
"description": "The id of the access review instance."
708+
},
709+
{
710+
"$ref": "#/parameters/ApiVersionParameter"
711+
},
712+
{
713+
"$ref": "#/parameters/SubscriptionIdParameter"
714+
}
715+
],
716+
"responses": {
717+
"200": {
718+
"description": "Describe the result of a successful operation.",
719+
"schema": {
720+
"$ref": "#/definitions/AccessReviewContactedReviewerListResult"
721+
}
722+
},
723+
"default": {
724+
"description": "Unexpected error",
725+
"schema": {
726+
"$ref": "#/definitions/ErrorDefinition"
727+
}
728+
}
729+
},
730+
"x-ms-pageable": {
731+
"nextLinkName": "nextLink"
732+
}
733+
}
734+
},
625735
"/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleSettings/default": {
626736
"get": {
627737
"tags": [
@@ -930,6 +1040,56 @@
9301040
}
9311041
}
9321042
},
1043+
"/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/contactedReviewers": {
1044+
"get": {
1045+
"tags": [
1046+
"TenantLevelGetAccessReviewInstanceContactedReviewers"
1047+
],
1048+
"operationId": "TenantLevelAccessReviewInstanceContactedReviewers_List",
1049+
"x-ms-examples": {
1050+
"GetAccessReviews": {
1051+
"$ref": "./examples/TenantLevelGetAccessReviewInstanceContactedReviewers.json"
1052+
}
1053+
},
1054+
"description": "Get access review instance contacted reviewers",
1055+
"parameters": [
1056+
{
1057+
"name": "scheduleDefinitionId",
1058+
"in": "path",
1059+
"required": true,
1060+
"type": "string",
1061+
"description": "The id of the access review schedule definition."
1062+
},
1063+
{
1064+
"name": "id",
1065+
"in": "path",
1066+
"required": true,
1067+
"type": "string",
1068+
"description": "The id of the access review instance."
1069+
},
1070+
{
1071+
"$ref": "#/parameters/ApiVersionParameter"
1072+
}
1073+
],
1074+
"responses": {
1075+
"200": {
1076+
"description": "Describe the result of a successful operation.",
1077+
"schema": {
1078+
"$ref": "#/definitions/AccessReviewContactedReviewerListResult"
1079+
}
1080+
},
1081+
"default": {
1082+
"description": "Unexpected error",
1083+
"schema": {
1084+
"$ref": "#/definitions/ErrorDefinition"
1085+
}
1086+
}
1087+
},
1088+
"x-ms-pageable": {
1089+
"nextLinkName": "nextLink"
1090+
}
1091+
}
1092+
},
9331093
"/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/decisions/{decisionId}": {
9341094
"get": {
9351095
"tags": [
@@ -1225,6 +1385,34 @@
12251385
"format": "date-time",
12261386
"description": "The DateTime when the review instance is scheduled to end.",
12271387
"x-nullable": false
1388+
},
1389+
"reviewers": {
1390+
"type": "array",
1391+
"items": {
1392+
"$ref": "#/definitions/AccessReviewReviewer"
1393+
},
1394+
"description": "This is the collection of reviewers."
1395+
},
1396+
"backupReviewers": {
1397+
"type": "array",
1398+
"items": {
1399+
"$ref": "#/definitions/AccessReviewReviewer"
1400+
},
1401+
"description": "This is the collection of backup reviewers."
1402+
},
1403+
"reviewersType": {
1404+
"type": "string",
1405+
"readOnly": true,
1406+
"description": "This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.",
1407+
"enum": [
1408+
"Assigned",
1409+
"Self",
1410+
"Managers"
1411+
],
1412+
"x-ms-enum": {
1413+
"name": "AccessReviewInstanceReviewersType",
1414+
"modelAsString": true
1415+
}
12281416
}
12291417
},
12301418
"description": "Access Review Instance properties."
@@ -1404,7 +1592,8 @@
14041592
"user",
14051593
"guestUser",
14061594
"servicePrincipal",
1407-
"user,group"
1595+
"user,group",
1596+
"redeemedGuestUser"
14081597
],
14091598
"x-ms-enum": {
14101599
"name": "AccessReviewScopePrincipalType",
@@ -1715,6 +1904,54 @@
17151904
},
17161905
"description": "Details of the actor identity"
17171906
},
1907+
"AccessReviewContactedReviewer": {
1908+
"x-ms-azure-resource": true,
1909+
"properties": {
1910+
"id": {
1911+
"type": "string",
1912+
"readOnly": true,
1913+
"description": "The access review reviewer id."
1914+
},
1915+
"name": {
1916+
"type": "string",
1917+
"readOnly": true,
1918+
"description": "The access review reviewer id."
1919+
},
1920+
"type": {
1921+
"type": "string",
1922+
"readOnly": true,
1923+
"description": "The resource type."
1924+
},
1925+
"properties": {
1926+
"x-ms-client-flatten": true,
1927+
"$ref": "#/definitions/AccessReviewContactedReviewerProperties",
1928+
"description": "Access Review Contacted Reviewer properties."
1929+
}
1930+
},
1931+
"description": "Access Review Contacted Reviewer."
1932+
},
1933+
"AccessReviewContactedReviewerProperties": {
1934+
"properties": {
1935+
"userDisplayName": {
1936+
"type": "string",
1937+
"description": "The display name of the reviewer",
1938+
"readOnly": true
1939+
},
1940+
"userPrincipalName": {
1941+
"type": "string",
1942+
"description": "The user principal name of the reviewer",
1943+
"readOnly": true
1944+
},
1945+
"createdDateTime": {
1946+
"type": "string",
1947+
"readOnly": true,
1948+
"format": "date-time",
1949+
"description": "Date Time when the reviewer was contacted.",
1950+
"x-nullable": true
1951+
}
1952+
},
1953+
"description": "Properties of access review contacted reviewer."
1954+
},
17181955
"AccessReviewScheduleDefinitionListResult": {
17191956
"properties": {
17201957
"value": {
@@ -1763,6 +2000,22 @@
17632000
},
17642001
"description": "List of access review decisions."
17652002
},
2003+
"AccessReviewContactedReviewerListResult": {
2004+
"properties": {
2005+
"value": {
2006+
"type": "array",
2007+
"items": {
2008+
"$ref": "#/definitions/AccessReviewContactedReviewer"
2009+
},
2010+
"description": "Access Review Contacted Reviewer."
2011+
},
2012+
"nextLink": {
2013+
"type": "string",
2014+
"description": "The URL to use for getting the next set of results."
2015+
}
2016+
},
2017+
"description": "List of access review contacted reviewers."
2018+
},
17662019
"ErrorDefinition": {
17672020
"type": "object",
17682021
"title": "Error",

‎specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceContactedReviewers.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parameters": {
3+
"api-version": "2021-07-01-preview",
4+
"scheduleDefinitionId": "265785a7-a81f-4201-8a18-bb0db95982b7",
5+
"id": "f25ed880-9c31-4101-bc57-825d8df3b58c"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"value": [
11+
{
12+
"id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/f8882fec-7d56-4e97-ad6d-5e3f4557971d/contactedReviewers/fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
13+
"type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/contactedReviewers",
14+
"name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
15+
"properties": {
16+
"userDisplayName": "Bob",
17+
"userPrincipalName": "[email protected]",
18+
"createdDateTime": "2018-08-03T21:02:30.667Z"
19+
}
20+
}
21+
]
22+
}
23+
}
24+
}
25+
}

‎specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewInstance.json

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{
2+
"parameters": {
3+
"api-version": "2021-07-01-preview",
4+
"subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
5+
"scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
6+
"id": "4135f961-be78-4005-8101-c72a5af307a2",
7+
"properties": {},
8+
"body": {
9+
"properties": {
10+
"status": "InProgress",
11+
"startDateTime": "2018-08-03T21:02:30.667Z",
12+
"endDateTime": "2018-08-03T21:17:30.513Z",
13+
"reviewers": [
14+
{
15+
"principalId": "89ff94f6-029c-429c-9037-6cf4fe2f4a13",
16+
"principalType": "group"
17+
}
18+
],
19+
"backupReviewers": [
20+
{
21+
"principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
22+
"principalType": "user"
23+
}
24+
],
25+
"reviewersType": "Assigned"
26+
}
27+
}
28+
},
29+
"responses": {
30+
"200": {
31+
"body": {
32+
"id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/4135f961-be78-4005-8101-c72a5af307a2",
33+
"type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances",
34+
"name": "4135f961-be78-4005-8101-c72a5af307a2",
35+
"properties": {
36+
"status": "InProgress",
37+
"startDateTime": "2018-08-03T21:02:30.667Z",
38+
"endDateTime": "2018-08-03T21:17:30.513Z",
39+
"reviewers": [
40+
{
41+
"principalId": "89ff94f6-029c-429c-9037-6cf4fe2f4a13",
42+
"principalType": "group"
43+
}
44+
],
45+
"backupReviewers": [
46+
{
47+
"principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
48+
"principalType": "user"
49+
}
50+
],
51+
"reviewersType": "Assigned"
52+
}
53+
}
54+
}
55+
}
56+
}

0 commit comments

Comments
 (0)