File size: 49,498 Bytes
065fee7 |
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 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 |
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://accessapproval.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Access Approval",
"description": "An API for controlling access to data by Google personnel.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "accessapproval:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://accessapproval.mtls.googleapis.com/",
"name": "accessapproval",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"folders": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.folders.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.folders.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/folders/{foldersId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.folders.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^folders/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.folders.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.folders.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/folders/{foldersId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.folders.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.organizations.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.organizations.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/organizations/{organizationsId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.organizations.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^organizations/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.organizations.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.organizations.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.organizations.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"projects": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.projects.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.projects.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/projects/{projectsId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.projects.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.projects.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.projects.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/projects/{projectsId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.projects.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20240705",
"rootUrl": "https://accessapproval.googleapis.com/",
"schemas": {
"AccessApprovalServiceAccount": {
"description": "Access Approval service account related to a project/folder/organization.",
"id": "AccessApprovalServiceAccount",
"properties": {
"accountEmail": {
"description": "Email address of the service account.",
"type": "string"
},
"name": {
"description": "The resource name of the Access Approval service account. Format is one of: * \"projects/{project}/serviceAccount\" * \"folders/{folder}/serviceAccount\" * \"organizations/{organization}/serviceAccount\"",
"type": "string"
}
},
"type": "object"
},
"AccessApprovalSettings": {
"description": "Settings on a Project/Folder/Organization related to Access Approval.",
"id": "AccessApprovalSettings",
"properties": {
"activeKeyVersion": {
"description": "The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.",
"type": "string"
},
"ancestorHasActiveKeyVersion": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).",
"readOnly": true,
"type": "boolean"
},
"enrolledAncestor": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).",
"readOnly": true,
"type": "boolean"
},
"enrolledServices": {
"description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.",
"items": {
"$ref": "EnrolledService"
},
"type": "array"
},
"invalidKeyVersion": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"type": "string"
},
"notificationEmails": {
"description": "A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"notificationPubsubTopic": {
"description": "Optional. A pubsub topic to which notifications relating to approval requests should be sent.",
"type": "string"
},
"preferNoBroadApprovalRequests": {
"description": "This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.",
"type": "boolean"
},
"preferredRequestExpirationDays": {
"description": "This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.",
"format": "int32",
"type": "integer"
},
"requestScopeMaxWidthPreference": {
"description": "Optional. A setting to indicate the maximum width of an Access Approval request.",
"enum": [
"REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED",
"ORGANIZATION",
"FOLDER",
"PROJECT"
],
"enumDescriptions": [
"Default value for proto, shouldn't be used.",
"This is the widest scope possible. It means the customer has no scope restriction when it comes to Access Approval requests.",
"Customer allows the scope of Access Approval requests as broad as the Folder level.",
"Customer allows the scope of Access Approval requests as broad as the Project level."
],
"type": "string"
},
"requireCustomerVisibleJustification": {
"description": "Optional. A setting to require approval request justifications to be customer visible.",
"type": "boolean"
}
},
"type": "object"
},
"AccessLocations": {
"description": "Home office and physical location of the principal.",
"id": "AccessLocations",
"properties": {
"principalOfficeCountry": {
"description": "The \"home office\" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
"type": "string"
},
"principalPhysicalLocationCountry": {
"description": "Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
"type": "string"
}
},
"type": "object"
},
"AccessReason": {
"id": "AccessReason",
"properties": {
"detail": {
"description": "More detail about certain reason types. See comments for each type above.",
"type": "string"
},
"type": {
"description": "Type of access justification.",
"enum": [
"TYPE_UNSPECIFIED",
"CUSTOMER_INITIATED_SUPPORT",
"GOOGLE_INITIATED_SERVICE",
"GOOGLE_INITIATED_REVIEW",
"THIRD_PARTY_DATA_REQUEST",
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT",
"CLOUD_INITIATED_ACCESS"
],
"enumDescriptions": [
"Default value for proto, shouldn't be used.",
"Customer made a request or raised an issue that required the principal to access customer data. `detail` is of the form (\"#####\" is the issue ID): * \"Feedback Report: #####\" * \"Case Number: #####\" * \"Case ID: #####\" * \"E-PIN Reference: #####\" * \"Google-#####\" * \"T-#####\"",
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services. Often this access is used to confirm that customers are not affected by a suspected service issue or to remediate a reversible system issue.",
"Google initiated service for security, fraud, abuse, or compliance purposes.",
"The principal was compelled to access customer data in order to respond to a legal third party data request or process, including legal processes from customers themselves.",
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage.",
"Similar to 'GOOGLE_INITIATED_SERVICE' or 'GOOGLE_INITIATED_REVIEW', but with universe agnostic naming. The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage, or for security, fraud, abuse, or compliance review purposes."
],
"type": "string"
}
},
"type": "object"
},
"ApprovalRequest": {
"description": "A request for the customer to approve access to a resource.",
"id": "ApprovalRequest",
"properties": {
"approve": {
"$ref": "ApproveDecision",
"description": "Access was approved."
},
"dismiss": {
"$ref": "DismissDecision",
"description": "The request was dismissed."
},
"name": {
"description": "The resource name of the request. Format is \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\".",
"type": "string"
},
"requestTime": {
"description": "The time at which approval was requested.",
"format": "google-datetime",
"type": "string"
},
"requestedDuration": {
"description": "The requested access duration.",
"format": "google-duration",
"type": "string"
},
"requestedExpiration": {
"description": "The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.",
"format": "google-datetime",
"type": "string"
},
"requestedLocations": {
"$ref": "AccessLocations",
"description": "The locations for which approval is being requested."
},
"requestedReason": {
"$ref": "AccessReason",
"description": "The justification for which approval is being requested."
},
"requestedResourceName": {
"description": "The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a \"full\" resource name (e.g. \"//library.googleapis.com/shelves/shelf1/books/book2\") or a \"relative\" resource name (e.g. \"shelves/shelf1/books/book2\") as described in the resource name specification.",
"type": "string"
},
"requestedResourceProperties": {
"$ref": "ResourceProperties",
"description": "Properties related to the resource represented by requested_resource_name."
}
},
"type": "object"
},
"ApproveApprovalRequestMessage": {
"description": "Request to approve an ApprovalRequest.",
"id": "ApproveApprovalRequestMessage",
"properties": {
"expireTime": {
"description": "The expiration time of this approval.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ApproveDecision": {
"description": "A decision that has been made to approve access to a resource.",
"id": "ApproveDecision",
"properties": {
"approveTime": {
"description": "The time at which approval was granted.",
"format": "google-datetime",
"type": "string"
},
"autoApproved": {
"description": "True when the request has been auto-approved.",
"type": "boolean"
},
"expireTime": {
"description": "The time at which the approval expires.",
"format": "google-datetime",
"type": "string"
},
"invalidateTime": {
"description": "If set, denotes the timestamp at which the approval is invalidated.",
"format": "google-datetime",
"type": "string"
},
"signatureInfo": {
"$ref": "SignatureInfo",
"description": "The signature for the ApprovalRequest and details on how it was signed."
}
},
"type": "object"
},
"DismissApprovalRequestMessage": {
"description": "Request to dismiss an approval request.",
"id": "DismissApprovalRequestMessage",
"properties": {},
"type": "object"
},
"DismissDecision": {
"description": "A decision that has been made to dismiss an approval request.",
"id": "DismissDecision",
"properties": {
"dismissTime": {
"description": "The time at which the approval request was dismissed.",
"format": "google-datetime",
"type": "string"
},
"implicit": {
"description": "This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).",
"type": "boolean"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EnrolledService": {
"description": "Represents the enrollment of a cloud resource into a specific service.",
"id": "EnrolledService",
"properties": {
"cloudProduct": {
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
"type": "string"
},
"enrollmentLevel": {
"description": "The enrollment level of the service.",
"enum": [
"ENROLLMENT_LEVEL_UNSPECIFIED",
"BLOCK_ALL"
],
"enumDescriptions": [
"Default value for proto, shouldn't be used.",
"Service is enrolled in Access Approval for all requests"
],
"type": "string"
}
},
"type": "object"
},
"InvalidateApprovalRequestMessage": {
"description": "Request to invalidate an existing approval.",
"id": "InvalidateApprovalRequestMessage",
"properties": {},
"type": "object"
},
"ListApprovalRequestsResponse": {
"description": "Response to listing of ApprovalRequest objects.",
"id": "ListApprovalRequestsResponse",
"properties": {
"approvalRequests": {
"description": "Approval request details.",
"items": {
"$ref": "ApprovalRequest"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more.",
"type": "string"
}
},
"type": "object"
},
"ResourceProperties": {
"description": "The properties associated with the resource of the request.",
"id": "ResourceProperties",
"properties": {
"excludesDescendants": {
"description": "Whether an approval will exclude the descendants of the resource being requested.",
"type": "boolean"
}
},
"type": "object"
},
"SignatureInfo": {
"description": "Information about the digital signature of the resource.",
"id": "SignatureInfo",
"properties": {
"customerKmsKeyVersion": {
"description": "The resource name of the customer CryptoKeyVersion used for signing.",
"type": "string"
},
"googleKeyAlgorithm": {
"description": "The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.",
"enum": [
"CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED",
"GOOGLE_SYMMETRIC_ENCRYPTION",
"AES_128_GCM",
"AES_256_GCM",
"AES_128_CBC",
"AES_256_CBC",
"AES_128_CTR",
"AES_256_CTR",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
"RSA_SIGN_PKCS1_4096_SHA512",
"RSA_SIGN_RAW_PKCS1_2048",
"RSA_SIGN_RAW_PKCS1_3072",
"RSA_SIGN_RAW_PKCS1_4096",
"RSA_DECRYPT_OAEP_2048_SHA256",
"RSA_DECRYPT_OAEP_3072_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA512",
"RSA_DECRYPT_OAEP_2048_SHA1",
"RSA_DECRYPT_OAEP_3072_SHA1",
"RSA_DECRYPT_OAEP_4096_SHA1",
"EC_SIGN_P256_SHA256",
"EC_SIGN_P384_SHA384",
"EC_SIGN_SECP256K1_SHA256",
"EC_SIGN_ED25519",
"HMAC_SHA256",
"HMAC_SHA1",
"HMAC_SHA384",
"HMAC_SHA512",
"HMAC_SHA224",
"EXTERNAL_SYMMETRIC_ENCRYPTION"
],
"enumDescriptions": [
"Not specified.",
"Creates symmetric encryption keys.",
"AES-GCM (Galois Counter Mode) using 128-bit keys.",
"AES-GCM (Galois Counter Mode) using 256-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.",
"AES-CTR (Counter Mode) using 128-bit keys.",
"AES-CTR (Counter Mode) using 256-bit keys.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 2048 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 3072 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 4096 bit key.",
"RSAES-OAEP 2048 bit key with a SHA256 digest.",
"RSAES-OAEP 3072 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
"RSAES-OAEP 2048 bit key with a SHA1 digest.",
"RSAES-OAEP 3072 bit key with a SHA1 digest.",
"RSAES-OAEP 4096 bit key with a SHA1 digest.",
"ECDSA on the NIST P-256 curve with a SHA256 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the non-NIST secp256k1 curve. This curve is only supported for HSM protection level. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"EdDSA on the Curve25519 in pure mode (taking data as input).",
"HMAC-SHA256 signing with a 256 bit key.",
"HMAC-SHA1 signing with a 160 bit key.",
"HMAC-SHA384 signing with a 384 bit key.",
"HMAC-SHA512 signing with a 512 bit key.",
"HMAC-SHA224 signing with a 224 bit key.",
"Algorithm representing symmetric encryption by an external key manager."
],
"type": "string"
},
"googlePublicKeyPem": {
"description": "The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.",
"type": "string"
},
"serializedApprovalRequest": {
"description": "The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.",
"format": "byte",
"type": "string"
},
"signature": {
"description": "The digital signature.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Access Approval API",
"version": "v1",
"version_module": true
} |