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 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudidentityV1beta1
# Cloud Identity API
#
# API for provisioning and managing identity resources.
#
# @example
# require 'google/apis/cloudidentity_v1beta1'
#
# Cloudidentity = Google::Apis::CloudidentityV1beta1 # Alias the module
# service = Cloudidentity::CloudIdentityService.new
#
# @see https://cloud.google.com/identity/
class CloudIdentityService < Google::Apis::Core::BaseService
# @return [String]
# 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.
attr_accessor :key
# @return [String]
# 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.
attr_accessor :quota_user
def initialize
super('https://cloudidentity.googleapis.com/', '')
@batch_path = 'batch'
end
# Cancels an unfinished device wipe. This operation can be used to cancel device
# wipe in the gap between the wipe operation returning success and the device
# being wiped.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id``, where device_id is the unique
# ID assigned to the Device.
# @param [Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest] cancel_wipe_device_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_wipe_device(name, cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest::Representation
command.request_object = cancel_wipe_device_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a device. Only company-owned device may be created. **Note**: This
# method is available only to customers who have one of the following SKUs:
# Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud
# Identity Premium
# @param [Google::Apis::CloudidentityV1beta1::CreateDeviceRequest] create_device_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_device(create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/devices', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::CreateDeviceRequest::Representation
command.request_object = create_device_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id``, where device_id is the unique
# ID assigned to the Device.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id``, where device_id is the unique
# ID assigned to the Device.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Customer in format: `customers/`customer_id``, where customer_id is the
# customer to whom the device belongs.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Device] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Device]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Device
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists/Searches devices.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer.
# @param [String] filter
# Optional. Additional restrictions when fetching list of devices. For a list of
# search fields, refer to [Mobile device search fields](https://developers.
# google.com/admin-sdk/directory/v1/search-operators). Multiple search fields
# are separated by the space character.
# @param [String] order_by
# Optional. Order specification for devices in the response. Only one of the
# following field names may be used to specify the order: `create_time`, `
# last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. `
# desc` may be specified optionally to specify results to be sorted in
# descending order. Default order is ascending.
# @param [Fixnum] page_size
# Optional. The maximum number of Devices to return. If unspecified, at most 20
# Devices will be returned. The maximum value is 100; values above 100 will be
# coerced to 100.
# @param [String] page_token
# Optional. A page token, received from a previous `ListDevices` call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to `ListDevices` must match the call that provided the page token.
# @param [String] view
# Optional. The view to use for the List request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListDevicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ListDevicesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_devices(customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/devices', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse
command.query['customer'] = customer unless customer.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Wipes all data on the specified device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1beta1::WipeDeviceRequest] wipe_device_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def wipe_device(name, wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceRequest::Representation
command.request_object = wipe_device_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Approves device to access user data.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest] approve_device_user_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def approve_device_user(name, approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:approve', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest::Representation
command.request_object = approve_device_user_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Blocks device from accessing user data
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest] block_device_user_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def block_device_user(name, block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:block', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest::Representation
command.request_object = block_device_user_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancels an unfinished user account wipe. This operation can be used to cancel
# device wipe in the gap between the wipe operation returning success and the
# device being wiped.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest] cancel_wipe_device_user_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_wipe_device_user(name, cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest::Representation
command.request_object = cancel_wipe_device_user_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified DeviceUser. This also revokes the user's access to
# device data.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified DeviceUser
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::DeviceUser] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::DeviceUser]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists/Searches DeviceUsers.
# @param [String] parent
# Required. To list all DeviceUsers, set this to "devices/-". To list all
# DeviceUsers owned by a device, set this to the resource name of the device.
# Format: devices/`device`
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] filter
# Optional. Additional restrictions when fetching list of devices. For a list of
# search fields, refer to [Mobile device search fields](https://developers.
# google.com/admin-sdk/directory/v1/search-operators). Multiple search fields
# are separated by the space character.
# @param [String] order_by
# Optional. Order specification for devices in the response.
# @param [Fixnum] page_size
# Optional. The maximum number of DeviceUsers to return. If unspecified, at most
# 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will
# be coerced to 20.
# @param [String] page_token
# Optional. A page token, received from a previous `ListDeviceUsers` call.
# Provide this to retrieve the subsequent page. When paginating, all other
# parameters provided to `ListBooks` must match the call that provided the page
# token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_device_device_users(parent, customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/deviceUsers', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse
command.params['parent'] = parent unless parent.nil?
command.query['customer'] = customer unless customer.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Looks up resource names of the DeviceUsers associated with the caller's
# credentials, as well as the properties provided in the request. This method
# must be called with end-user credentials with the scope: https://www.
# googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are
# provided, only DeviceUsers having all of these properties are considered as
# matches - i.e. the query behaves like an AND. Different platforms require
# different amounts of information from the caller to ensure that the DeviceUser
# is uniquely identified. - iOS: No properties need to be passed, the caller's
# credentials are sufficient to identify the corresponding DeviceUser. - Android:
# Specifying the 'android_id' field is required. - Desktop: Specifying the '
# raw_resource_id' field is required.
# @param [String] parent
# Must be set to "devices/-/deviceUsers" to search across all DeviceUser
# belonging to the user.
# @param [String] android_id
# Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.
# com/reference/android/provider/Settings.Secure.html#ANDROID_ID).
# @param [Fixnum] page_size
# The maximum number of DeviceUsers to return. If unspecified, at most 20
# DeviceUsers will be returned. The maximum value is 20; values above 20 will be
# coerced to 20.
# @param [String] page_token
# A page token, received from a previous `LookupDeviceUsers` call. Provide this
# to retrieve the subsequent page. When paginating, all other parameters
# provided to `LookupDeviceUsers` must match the call that provided the page
# token.
# @param [String] raw_resource_id
# Raw Resource Id used by Google Endpoint Verification. If the user is enrolled
# into Google Endpoint Verification, this id will be saved as the '
# device_resource_id' field in the following platform dependent files. Mac: ~/.
# secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.
# secureConnect\context_aware_config.json Linux: ~/.secureConnect/
# context_aware_config.json
# @param [String] user_id
# The user whose DeviceUser's resource name will be fetched. Must be set to 'me'
# to fetch the DeviceUser's resource name for the calling user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def lookup_device_device_user(parent, android_id: nil, page_size: nil, page_token: nil, raw_resource_id: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}:lookup', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse
command.params['parent'] = parent unless parent.nil?
command.query['androidId'] = android_id unless android_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['rawResourceId'] = raw_resource_id unless raw_resource_id.nil?
command.query['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Wipes the user's account on a device.
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
# where device_id is the unique ID assigned to the Device, and device_user_id is
# the unique ID assigned to the User.
# @param [Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest] wipe_device_user_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def wipe_device_user(name, wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest::Representation
command.request_object = wipe_device_user_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the client state for the device user
# @param [String] name
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the ClientState in format: `devices/`device_id`/deviceUsers/`device_user_id`
# /clientStates/`partner_id``, where device_id is the unique ID assigned to the
# Device, device_user_id is the unique ID assigned to the User and partner_id
# identifies the partner storing the data. To get the client state for devices
# belonging to your own organization, the `partnerId` is in the format: `
# customerId-*anystring*`. Where the `customerId` is your organization's
# customer ID and `anystring` is any suffix. This suffix is used in setting up
# Custom Access Levels in Context-Aware Access. You may use `my_customer`
# instead of the customer ID for devices managed by your own organization.
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ClientState] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ClientState]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_device_device_user_client_state(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ClientState
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the client state for the device user **Note**: This method is
# available only to customers who have one of the following SKUs: Enterprise
# Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity
# Premium
# @param [String] name
# Output only. [Resource name](https://cloud.google.com/apis/design/
# resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/
# `device_user_id`/clientState/`partner_id``, where partner_id corresponds to
# the partner storing the data.
# @param [Google::Apis::CloudidentityV1beta1::ClientState] client_state_object
# @param [String] customer
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the customer. If you're using this API for your own organization, use `
# customers/my_customer` If you're using this API to manage another organization,
# use `customers/`customer_id``, where customer_id is the customer to whom the
# device belongs.
# @param [String] update_mask
# Optional. Comma-separated list of fully qualified names of fields to be
# updated. If not specified, all updatable fields in ClientState are updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_device_device_user_client_state(name, client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation
command.request_object = client_state_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['customer'] = customer unless customer.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a `Group`.
# @param [Google::Apis::CloudidentityV1beta1::Group] group_object
# @param [String] initial_group_config
# Required. The initial configuration option for the `Group`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_group(group_object = nil, initial_group_config: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/groups', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.query['initialGroupConfig'] = initial_group_config unless initial_group_config.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a `Group`.
# @param [String] name
# Required. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Group` to retrieve. Must be of the form `groups/`
# group_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a `Group`.
# @param [String] name
# Required. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Group` to retrieve. Must be of the form `groups/`
# group_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_group(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Group
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the `Group`s under a customer or namespace.
# @param [Fixnum] page_size
# The maximum number of results to return. Note that the number of results
# returned may be less than this value even if there are more available results.
# To fetch all results, clients must continue calling this method repeatedly
# until the response no longer contains a `next_page_token`. If unspecified,
# defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be
# greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
# @param [String] page_token
# The `next_page_token` value returned from a previous list request, if any.
# @param [String] parent
# Required. The parent resource under which to list all `Group`s. Must be of the
# form `identitysources/`identity_source_id`` for external- identity-mapped
# groups or `customers/`customer_id`` for Google Groups.
# @param [String] view
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ListGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_groups(page_size: nil, page_token: nil, parent: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/groups', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::ListGroupsResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ListGroupsResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['parent'] = parent unless parent.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Looks up the [resource name](https://cloud.google.com/apis/design/
# resource_names) of a `Group` by its `EntityKey`.
# @param [String] group_key_id
# The ID of the entity. For Google-managed entities, the `id` must be the email
# address of an existing group or user. For external-identity-mapped entities,
# the `id` must be a string conforming to the Identity Source's requirements.
# Must be unique within a `namespace`.
# @param [String] group_key_namespace
# The namespace in which the entity exists. If not specified, the `EntityKey`
# represents a Google-managed entity such as a Google user or a Google Group. If
# specified, the `EntityKey` represents an external-identity-mapped group. The
# namespace must correspond to an identity source created in Admin Console and
# must be in the form of `identitysources/`identity_source_id`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def lookup_group(group_key_id: nil, group_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/groups:lookup', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::LookupGroupNameResponse
command.query['groupKey.id'] = group_key_id unless group_key_id.nil?
command.query['groupKey.namespace'] = group_key_namespace unless group_key_namespace.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Group`.
# @param [String] name
# Output only. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Group`. Shall be of the form `groups/`group_id``.
# @param [Google::Apis::CloudidentityV1beta1::Group] group_object
# @param [String] update_mask
# Required. The fully-qualified names of fields to update. May only contain the
# following fields: `display_name`, `description`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_group(name, group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for `Group`s matching a specified query.
# @param [Fixnum] page_size
# The maximum number of results to return. Note that the number of results
# returned may be less than this value even if there are more available results.
# To fetch all results, clients must continue calling this method repeatedly
# until the response no longer contains a `next_page_token`. If unspecified,
# defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not
# be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
# @param [String] page_token
# The `next_page_token` value returned from a previous search request, if any.
# @param [String] query
# Required. The search query. Must be specified in [Common Expression Language](
# https://opensource.google/projects/cel). May only contain equality operators
# on the parent and inclusion operators on labels (e.g., `parent == 'customers/`
# customer_id`' && 'cloudidentity.googleapis.com/groups.discussion_forum' in
# labels`).
# @param [String] view
# The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::SearchGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_groups(page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/groups:search', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['query'] = query unless query.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Check a potential member for membership in a group. **Note:** This feature is
# only available to Google Workspace Enterprise Standard, Enterprise Plus, and
# Enterprise for Education; and Cloud Identity Premium accounts. A member has
# membership to a group as long as there is a single viewable transitive
# membership between the group and the member. The actor must have view
# permissions to at least one transitive membership between the member and group.
# @param [String] parent
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
# group to check the transitive membership in. Format: `groups/`group_id``,
# where `group_id` is the unique id assigned to the Group to which the
# Membership belongs to.
# @param [String] query
# Required. A CEL expression that MUST include member specification. This is a `
# required` field. Certain groups are uniquely identified by both a '
# member_key_id' and a 'member_key_namespace', which requires an additional
# query input: 'member_key_namespace'. Example query: `member_key_id == '
# member_key_id_value'`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def check_group_membership_transitive_membership(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:checkTransitiveMembership', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::CheckTransitiveMembershipResponse
command.params['parent'] = parent unless parent.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a `Membership`.
# @param [String] parent
# Required. The parent `Group` resource under which to create the `Membership`.
# Must be of the form `groups/`group_id``.
# @param [Google::Apis::CloudidentityV1beta1::Membership] membership_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_group_membership(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/memberships', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
command.request_object = membership_object
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a `Membership`.
# @param [String] name
# Required. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Membership` to delete. Must be of the form `groups/`
# group_id`/memberships/`membership_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a `Membership`.
# @param [String] name
# Required. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Membership` to retrieve. Must be of the form `groups/`
# group_id`/memberships/`membership_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Membership] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Membership]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_group_membership(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Membership::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Membership
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a membership graph of just a member or both a member and a group. **Note:**
# This feature is only available to Google Workspace Enterprise Standard,
# Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium
# accounts. Given a member, the response will contain all membership paths from
# the member. Given both a group and a member, the response will contain all
# membership paths between the group and the member.
# @param [String] parent
# Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
# of the group to search transitive memberships in. Format: `groups/`group_id``,
# where `group_id` is the unique ID assigned to the Group to which the
# Membership belongs to. group_id can be a wildcard collection id "-". When a
# group_id is specified, the membership graph will be constrained to paths
# between the member (defined in the query) and the parent. If a wildcard
# collection is provided, all membership paths connected to the member will be
# returned.
# @param [String] query
# Required. A CEL expression that MUST include member specification AND label(s).
# Certain groups are uniquely identified by both a 'member_key_id' and a '
# member_key_namespace', which requires an additional query input: '
# member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' &
# & in labels`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_group_membership_membership_graph(parent, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:getMembershipGraph', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the `Membership`s within a `Group`.
# @param [String] parent
# Required. The parent `Group` resource under which to lookup the `Membership`
# name. Must be of the form `groups/`group_id``.
# @param [Fixnum] page_size
# The maximum number of results to return. Note that the number of results
# returned may be less than this value even if there are more available results.
# To fetch all results, clients must continue calling this method repeatedly
# until the response no longer contains a `next_page_token`. If unspecified,
# defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not
# be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
# @param [String] page_token
# The `next_page_token` value returned from a previous search request, if any.
# @param [String] view
# The level of detail to be returned. If unspecified, defaults to `
# MembershipView.BASIC`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ListMembershipsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ListMembershipsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_group_memberships(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ListMembershipsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Looks up the [resource name](https://cloud.google.com/apis/design/
# resource_names) of a `Membership` by its `EntityKey`.
# @param [String] parent
# Required. The parent `Group` resource under which to lookup the `Membership`
# name. Must be of the form `groups/`group_id``.
# @param [String] member_key_id
# The ID of the entity. For Google-managed entities, the `id` must be the email
# address of an existing group or user. For external-identity-mapped entities,
# the `id` must be a string conforming to the Identity Source's requirements.
# Must be unique within a `namespace`.
# @param [String] member_key_namespace
# The namespace in which the entity exists. If not specified, the `EntityKey`
# represents a Google-managed entity such as a Google user or a Google Group. If
# specified, the `EntityKey` represents an external-identity-mapped group. The
# namespace must correspond to an identity source created in Admin Console and
# must be in the form of `identitysources/`identity_source_id`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def lookup_group_membership(parent, member_key_id: nil, member_key_namespace: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:lookup', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::LookupMembershipNameResponse
command.params['parent'] = parent unless parent.nil?
command.query['memberKey.id'] = member_key_id unless member_key_id.nil?
command.query['memberKey.namespace'] = member_key_namespace unless member_key_namespace.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Modifies the `MembershipRole`s of a `Membership`.
# @param [String] name
# Required. The [resource name](https://cloud.google.com/apis/design/
# resource_names) of the `Membership` whose roles are to be modified. Must be of
# the form `groups/`group_id`/memberships/`membership_id``.
# @param [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest] modify_membership_roles_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def modify_membership_roles(name, modify_membership_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:modifyMembershipRoles', options)
command.request_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest::Representation
command.request_object = modify_membership_roles_request_object
command.response_representation = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Search transitive groups of a member. **Note:** This feature is only available
# to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for
# Education; and Cloud Identity Premium accounts. A transitive group is any
# group that has a direct or indirect membership to the member. Actor must have
# view permissions all transitive groups.
# @param [String] parent
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
# group to search transitive memberships in. Format: `groups/`group_id``, where `
# group_id` is always '-' as this API will search across all groups for a given
# member.
# @param [Fixnum] page_size
# The default page size is 200 (max 1000).
# @param [String] page_token
# The next_page_token value returned from a previous list request, if any.
# @param [String] query
# Required. A CEL expression that MUST include member specification AND label(s).
# This is a `required` field. Users can search on label attributes of groups.
# CONTAINS match ('in') is supported on labels. Certain groups are uniquely
# identified by both a 'member_key_id' and a 'member_key_namespace', which
# requires an additional query input: 'member_key_namespace'. Example query: `
# member_key_id == 'member_key_id_value' && in labels`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_group_membership_transitive_groups(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:searchTransitiveGroups', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::SearchTransitiveGroupsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Search transitive memberships of a group. **Note:** This feature is only
# available to Google Workspace Enterprise Standard, Enterprise Plus, and
# Enterprise for Education; and Cloud Identity Premium accounts. A transitive
# membership is any direct or indirect membership of a group. Actor must have
# view permissions to all transitive memberships.
# @param [String] parent
# [Resource name](https://cloud.google.com/apis/design/resource_names) of the
# group to search transitive memberships in. Format: `groups/`group_id``, where `
# group_id` is the unique ID assigned to the Group.
# @param [Fixnum] page_size
# The default page size is 200 (max 1000).
# @param [String] page_token
# The next_page_token value returned from a previous list request, if any.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_group_membership_transitive_memberships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/memberships:searchTransitiveMemberships', options)
command.response_representation = Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse::Representation
command.response_class = Google::Apis::CloudidentityV1beta1::SearchTransitiveMembershipsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|