google-apis-cloudidentity_v1beta1 0.35.0 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 52d10c8cb8a5dcc0c5db9aef9747fc73a3045bf7ca6c56191b230986307ca6b7
4
- data.tar.gz: ccc0d1cf1532878325eb6612d34a9c6ff87f5a6830a5da406be0bd5599723a10
3
+ metadata.gz: 9e8762a0d6636a30f623dd9cf13a95f4387904018427f3edea2e577b0db365ec
4
+ data.tar.gz: 636623122e77fb94c4602880455fa15816303ea7922eda9bc9a91fe1bcf0a2ef
5
5
  SHA512:
6
- metadata.gz: 81d92b7387ab97f45b98fd200eeaa2929ee14943d6d5faf9c6bed5aa953dccdb18d0c6f8d71d10a53caadc0363b9b3ecf08daf003d12d557075bac8a272d5527
7
- data.tar.gz: df59482d3980530bbf04139c66422069fd3905e96d18d4444edc81bd3264f4f51ff2e014036e7424501a0bdfd5528eaffc1f9455d1d66f1530b4e3e4db0f4ba9
6
+ metadata.gz: 5ff8a01d40ab1034c29446c85b36450bcb383e0c013893dca3ed325d096fc707147c9914b329ef2a018ad55512faee5549dff281fd5115d7f845a2fdb98d601e
7
+ data.tar.gz: 9db67e2075cd8193316c00c203921e1ad7fe6cae2c301575934bed9df66ce0a87e4f4d6c8e059c4d233bca753b98124b49d80efca0cd1ac25332e56873b80d13
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-cloudidentity_v1beta1
2
2
 
3
+ ### v0.36.0 (2022-12-31)
4
+
5
+ * Regenerated from discovery document revision 20221221
6
+
3
7
  ### v0.35.0 (2022-11-06)
4
8
 
5
9
  * Regenerated from discovery document revision 20221101
@@ -104,12 +104,22 @@ module Google
104
104
  class ApproveDeviceUserRequest
105
105
  include Google::Apis::Core::Hashable
106
106
 
107
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
108
+ # of the customer. If you're using this API for your own organization, use `
109
+ # customers/my_customer` If you're using this API to manage another organization,
110
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
111
+ # device belongs.
112
+ # Corresponds to the JSON property `customer`
113
+ # @return [String]
114
+ attr_accessor :customer
115
+
107
116
  def initialize(**args)
108
117
  update!(**args)
109
118
  end
110
119
 
111
120
  # Update properties of this object
112
121
  def update!(**args)
122
+ @customer = args[:customer] if args.key?(:customer)
113
123
  end
114
124
  end
115
125
 
@@ -137,12 +147,22 @@ module Google
137
147
  class BlockDeviceUserRequest
138
148
  include Google::Apis::Core::Hashable
139
149
 
150
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
151
+ # of the customer. If you're using this API for your own organization, use `
152
+ # customers/my_customer` If you're using this API to manage another organization,
153
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
154
+ # device belongs.
155
+ # Corresponds to the JSON property `customer`
156
+ # @return [String]
157
+ attr_accessor :customer
158
+
140
159
  def initialize(**args)
141
160
  update!(**args)
142
161
  end
143
162
 
144
163
  # Update properties of this object
145
164
  def update!(**args)
165
+ @customer = args[:customer] if args.key?(:customer)
146
166
  end
147
167
  end
148
168
 
@@ -183,12 +203,22 @@ module Google
183
203
  class CancelWipeDeviceRequest
184
204
  include Google::Apis::Core::Hashable
185
205
 
206
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
207
+ # of the customer. If you're using this API for your own organization, use `
208
+ # customers/my_customer` If you're using this API to manage another organization,
209
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
210
+ # device belongs.
211
+ # Corresponds to the JSON property `customer`
212
+ # @return [String]
213
+ attr_accessor :customer
214
+
186
215
  def initialize(**args)
187
216
  update!(**args)
188
217
  end
189
218
 
190
219
  # Update properties of this object
191
220
  def update!(**args)
221
+ @customer = args[:customer] if args.key?(:customer)
192
222
  end
193
223
  end
194
224
 
@@ -217,12 +247,22 @@ module Google
217
247
  class CancelWipeDeviceUserRequest
218
248
  include Google::Apis::Core::Hashable
219
249
 
250
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
251
+ # of the customer. If you're using this API for your own organization, use `
252
+ # customers/my_customer` If you're using this API to manage another organization,
253
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
254
+ # device belongs.
255
+ # Corresponds to the JSON property `customer`
256
+ # @return [String]
257
+ attr_accessor :customer
258
+
220
259
  def initialize(**args)
221
260
  update!(**args)
222
261
  end
223
262
 
224
263
  # Update properties of this object
225
264
  def update!(**args)
265
+ @customer = args[:customer] if args.key?(:customer)
226
266
  end
227
267
  end
228
268
 
@@ -465,6 +505,15 @@ module Google
465
505
  class CreateDeviceRequest
466
506
  include Google::Apis::Core::Hashable
467
507
 
508
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
509
+ # of the customer. If you're using this API for your own organization, use `
510
+ # customers/my_customer` If you're using this API to manage another organization,
511
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
512
+ # device belongs.
513
+ # Corresponds to the JSON property `customer`
514
+ # @return [String]
515
+ attr_accessor :customer
516
+
468
517
  # A Device within the Cloud Identity Devices API. Represents a Device known to
469
518
  # Google Cloud, independent of the device ownership, type, and whether it is
470
519
  # assigned or in use by a user.
@@ -478,6 +527,7 @@ module Google
478
527
 
479
528
  # Update properties of this object
480
529
  def update!(**args)
530
+ @customer = args[:customer] if args.key?(:customer)
481
531
  @device = args[:device] if args.key?(:device)
482
532
  end
483
533
  end
@@ -1887,9 +1937,11 @@ module Google
1887
1937
 
1888
1938
  # Required. Immutable. The resource name of the entity under which this `Group`
1889
1939
  # resides in the Cloud Identity resource hierarchy. Must be of the form `
1890
- # identitysources/`identity_source_id`` for external- identity-mapped groups or `
1891
- # customers/`customer_id`` for Google Groups. The `customer_id` must begin with "
1892
- # C" (for example, 'C046psxkn').
1940
+ # identitysources/`identity_source`` for external [identity-mapped groups](https:
1941
+ # //support.google.com/a/answer/9039510) or `customers/`customer_id`` for Google
1942
+ # Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [
1943
+ # Find your customer ID.] (https://support.google.com/cloudidentity/answer/
1944
+ # 10070793)
1893
1945
  # Corresponds to the JSON property `parent`
1894
1946
  # @return [String]
1895
1947
  attr_accessor :parent
@@ -2448,8 +2500,8 @@ module Google
2448
2500
  class LookupSelfDeviceUsersResponse
2449
2501
  include Google::Apis::Core::Hashable
2450
2502
 
2451
- # The obfuscated customer Id that may be passed back to other Devices API
2452
- # methods such as List, Get, etc.
2503
+ # The customer Id that may be passed back to other Devices API methods such as
2504
+ # List, Get, etc.
2453
2505
  # Corresponds to the JSON property `customer`
2454
2506
  # @return [String]
2455
2507
  attr_accessor :customer
@@ -3384,6 +3436,15 @@ module Google
3384
3436
  class WipeDeviceRequest
3385
3437
  include Google::Apis::Core::Hashable
3386
3438
 
3439
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
3440
+ # of the customer. If you're using this API for your own organization, use `
3441
+ # customers/my_customer` If you're using this API to manage another organization,
3442
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
3443
+ # device belongs.
3444
+ # Corresponds to the JSON property `customer`
3445
+ # @return [String]
3446
+ attr_accessor :customer
3447
+
3387
3448
  # Optional. Specifies if a user is able to factory reset a device after a Device
3388
3449
  # Wipe. On iOS, this is called "Activation Lock", while on Android, this is
3389
3450
  # known as "Factory Reset Protection". If true, this protection will be removed
@@ -3400,6 +3461,7 @@ module Google
3400
3461
 
3401
3462
  # Update properties of this object
3402
3463
  def update!(**args)
3464
+ @customer = args[:customer] if args.key?(:customer)
3403
3465
  @remove_reset_lock = args[:remove_reset_lock] if args.key?(:remove_reset_lock)
3404
3466
  end
3405
3467
  end
@@ -3429,12 +3491,22 @@ module Google
3429
3491
  class WipeDeviceUserRequest
3430
3492
  include Google::Apis::Core::Hashable
3431
3493
 
3494
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
3495
+ # of the customer. If you're using this API for your own organization, use `
3496
+ # customers/my_customer` If you're using this API to manage another organization,
3497
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
3498
+ # device belongs.
3499
+ # Corresponds to the JSON property `customer`
3500
+ # @return [String]
3501
+ attr_accessor :customer
3502
+
3432
3503
  def initialize(**args)
3433
3504
  update!(**args)
3434
3505
  end
3435
3506
 
3436
3507
  # Update properties of this object
3437
3508
  def update!(**args)
3509
+ @customer = args[:customer] if args.key?(:customer)
3438
3510
  end
3439
3511
  end
3440
3512
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CloudidentityV1beta1
18
18
  # Version of the google-apis-cloudidentity_v1beta1 gem
19
- GEM_VERSION = "0.35.0"
19
+ GEM_VERSION = "0.36.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.11.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20221101"
25
+ REVISION = "20221221"
26
26
  end
27
27
  end
28
28
  end
@@ -708,6 +708,7 @@ module Google
708
708
  class ApproveDeviceUserRequest
709
709
  # @private
710
710
  class Representation < Google::Apis::Core::JsonRepresentation
711
+ property :customer, as: 'customer'
711
712
  end
712
713
  end
713
714
 
@@ -722,6 +723,7 @@ module Google
722
723
  class BlockDeviceUserRequest
723
724
  # @private
724
725
  class Representation < Google::Apis::Core::JsonRepresentation
726
+ property :customer, as: 'customer'
725
727
  end
726
728
  end
727
729
 
@@ -742,6 +744,7 @@ module Google
742
744
  class CancelWipeDeviceRequest
743
745
  # @private
744
746
  class Representation < Google::Apis::Core::JsonRepresentation
747
+ property :customer, as: 'customer'
745
748
  end
746
749
  end
747
750
 
@@ -756,6 +759,7 @@ module Google
756
759
  class CancelWipeDeviceUserRequest
757
760
  # @private
758
761
  class Representation < Google::Apis::Core::JsonRepresentation
762
+ property :customer, as: 'customer'
759
763
  end
760
764
  end
761
765
 
@@ -821,6 +825,7 @@ module Google
821
825
  class CreateDeviceRequest
822
826
  # @private
823
827
  class Representation < Google::Apis::Core::JsonRepresentation
828
+ property :customer, as: 'customer'
824
829
  property :device, as: 'device', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation
825
830
 
826
831
  end
@@ -1665,6 +1670,7 @@ module Google
1665
1670
  class WipeDeviceRequest
1666
1671
  # @private
1667
1672
  class Representation < Google::Apis::Core::JsonRepresentation
1673
+ property :customer, as: 'customer'
1668
1674
  property :remove_reset_lock, as: 'removeResetLock'
1669
1675
  end
1670
1676
  end
@@ -1680,6 +1686,7 @@ module Google
1680
1686
  class WipeDeviceUserRequest
1681
1687
  # @private
1682
1688
  class Representation < Google::Apis::Core::JsonRepresentation
1689
+ property :customer, as: 'customer'
1683
1690
  end
1684
1691
  end
1685
1692
 
@@ -322,6 +322,12 @@ module Google
322
322
  # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
323
323
  # of the Device in format: `devices/`device_id``, where device_id is the unique
324
324
  # ID assigned to the Device.
325
+ # @param [String] customer
326
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
327
+ # of the customer. If you're using this API for your own organization, use `
328
+ # customers/my_customer` If you're using this API to manage another organization,
329
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
330
+ # device belongs.
325
331
  # @param [String] fields
326
332
  # Selector specifying which fields to include in a partial response.
327
333
  # @param [String] quota_user
@@ -339,11 +345,12 @@ module Google
339
345
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
340
346
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
341
347
  # @raise [Google::Apis::AuthorizationError] Authorization is required
342
- def delete_device(name, fields: nil, quota_user: nil, options: nil, &block)
348
+ def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
343
349
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
344
350
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
345
351
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
346
352
  command.params['name'] = name unless name.nil?
353
+ command.query['customer'] = customer unless customer.nil?
347
354
  command.query['fields'] = fields unless fields.nil?
348
355
  command.query['quotaUser'] = quota_user unless quota_user.nil?
349
356
  execute_or_queue_command(command, &block)
@@ -354,6 +361,10 @@ module Google
354
361
  # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
355
362
  # of the Device in format: `devices/`device_id``, where device_id is the unique
356
363
  # ID assigned to the Device.
364
+ # @param [String] customer
365
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
366
+ # of the Customer in format: `customers/`customer_id``, where customer_id is the
367
+ # customer to whom the device belongs.
357
368
  # @param [String] fields
358
369
  # Selector specifying which fields to include in a partial response.
359
370
  # @param [String] quota_user
@@ -371,17 +382,21 @@ module Google
371
382
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
372
383
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
373
384
  # @raise [Google::Apis::AuthorizationError] Authorization is required
374
- def get_device(name, fields: nil, quota_user: nil, options: nil, &block)
385
+ def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
375
386
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
376
387
  command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation
377
388
  command.response_class = Google::Apis::CloudidentityV1beta1::Device
378
389
  command.params['name'] = name unless name.nil?
390
+ command.query['customer'] = customer unless customer.nil?
379
391
  command.query['fields'] = fields unless fields.nil?
380
392
  command.query['quotaUser'] = quota_user unless quota_user.nil?
381
393
  execute_or_queue_command(command, &block)
382
394
  end
383
395
 
384
396
  # Lists/Searches devices.
397
+ # @param [String] customer
398
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
399
+ # of the customer.
385
400
  # @param [String] filter
386
401
  # Optional. Additional restrictions when fetching list of devices. For a list of
387
402
  # search fields, refer to [Mobile device search fields](https://developers.
@@ -420,10 +435,11 @@ module Google
420
435
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
421
436
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
422
437
  # @raise [Google::Apis::AuthorizationError] Authorization is required
423
- def list_devices(filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
438
+ 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)
424
439
  command = make_simple_command(:get, 'v1beta1/devices', options)
425
440
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation
426
441
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse
442
+ command.query['customer'] = customer unless customer.nil?
427
443
  command.query['filter'] = filter unless filter.nil?
428
444
  command.query['orderBy'] = order_by unless order_by.nil?
429
445
  command.query['pageSize'] = page_size unless page_size.nil?
@@ -587,6 +603,12 @@ module Google
587
603
  # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
588
604
  # where device_id is the unique ID assigned to the Device, and device_user_id is
589
605
  # the unique ID assigned to the User.
606
+ # @param [String] customer
607
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
608
+ # of the customer. If you're using this API for your own organization, use `
609
+ # customers/my_customer` If you're using this API to manage another organization,
610
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
611
+ # device belongs.
590
612
  # @param [String] fields
591
613
  # Selector specifying which fields to include in a partial response.
592
614
  # @param [String] quota_user
@@ -604,11 +626,12 @@ module Google
604
626
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
605
627
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
606
628
  # @raise [Google::Apis::AuthorizationError] Authorization is required
607
- def delete_device_device_user(name, fields: nil, quota_user: nil, options: nil, &block)
629
+ def delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
608
630
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
609
631
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
610
632
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
611
633
  command.params['name'] = name unless name.nil?
634
+ command.query['customer'] = customer unless customer.nil?
612
635
  command.query['fields'] = fields unless fields.nil?
613
636
  command.query['quotaUser'] = quota_user unless quota_user.nil?
614
637
  execute_or_queue_command(command, &block)
@@ -620,6 +643,12 @@ module Google
620
643
  # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
621
644
  # where device_id is the unique ID assigned to the Device, and device_user_id is
622
645
  # the unique ID assigned to the User.
646
+ # @param [String] customer
647
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
648
+ # of the customer. If you're using this API for your own organization, use `
649
+ # customers/my_customer` If you're using this API to manage another organization,
650
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
651
+ # device belongs.
623
652
  # @param [String] fields
624
653
  # Selector specifying which fields to include in a partial response.
625
654
  # @param [String] quota_user
@@ -637,11 +666,12 @@ module Google
637
666
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
638
667
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
639
668
  # @raise [Google::Apis::AuthorizationError] Authorization is required
640
- def get_device_device_user(name, fields: nil, quota_user: nil, options: nil, &block)
669
+ def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
641
670
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
642
671
  command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation
643
672
  command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser
644
673
  command.params['name'] = name unless name.nil?
674
+ command.query['customer'] = customer unless customer.nil?
645
675
  command.query['fields'] = fields unless fields.nil?
646
676
  command.query['quotaUser'] = quota_user unless quota_user.nil?
647
677
  execute_or_queue_command(command, &block)
@@ -652,6 +682,12 @@ module Google
652
682
  # Required. To list all DeviceUsers, set this to "devices/-". To list all
653
683
  # DeviceUsers owned by a device, set this to the resource name of the device.
654
684
  # Format: devices/`device`
685
+ # @param [String] customer
686
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
687
+ # of the customer. If you're using this API for your own organization, use `
688
+ # customers/my_customer` If you're using this API to manage another organization,
689
+ # use `customers/`customer_id``, where customer_id is the customer to whom the
690
+ # device belongs.
655
691
  # @param [String] filter
656
692
  # Optional. Additional restrictions when fetching list of devices. For a list of
657
693
  # search fields, refer to [Mobile device search fields](https://developers.
@@ -685,11 +721,12 @@ module Google
685
721
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
686
722
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
687
723
  # @raise [Google::Apis::AuthorizationError] Authorization is required
688
- def list_device_device_users(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
724
+ 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)
689
725
  command = make_simple_command(:get, 'v1beta1/{+parent}/deviceUsers', options)
690
726
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation
691
727
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse
692
728
  command.params['parent'] = parent unless parent.nil?
729
+ command.query['customer'] = customer unless customer.nil?
693
730
  command.query['filter'] = filter unless filter.nil?
694
731
  command.query['orderBy'] = order_by unless order_by.nil?
695
732
  command.query['pageSize'] = page_size unless page_size.nil?
@@ -1049,7 +1086,8 @@ module Google
1049
1086
  # Required. The parent resource under which to list all `Group` resources. Must
1050
1087
  # be of the form `identitysources/`identity_source_id`` for external- identity-
1051
1088
  # mapped groups or `customers/`customer_id`` for Google Groups. The `customer_id`
1052
- # must begin with "C" (for example, 'C046psxkn').
1089
+ # must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (
1090
+ # https://support.google.com/cloudidentity/answer/10070793)
1053
1091
  # @param [String] view
1054
1092
  # The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
1055
1093
  # @param [String] fields
@@ -1163,6 +1201,12 @@ module Google
1163
1201
  end
1164
1202
 
1165
1203
  # Searches for `Group` resources matching a specified query.
1204
+ # @param [String] order_by
1205
+ # The ordering of groups for the display name or email in the search groups
1206
+ # response. The syntax for this field can be found at https://cloud.google.com/
1207
+ # apis/design/design_patterns#sorting_order. Example: Sort by the ascending name:
1208
+ # order_by="display_name" Sort by the descending group key email: order_by="
1209
+ # group_key desc"
1166
1210
  # @param [Fixnum] page_size
1167
1211
  # The maximum number of results to return. Note that the number of results
1168
1212
  # returned may be less than this value even if there are more available results.
@@ -1173,11 +1217,18 @@ module Google
1173
1217
  # @param [String] page_token
1174
1218
  # The `next_page_token` value returned from a previous search request, if any.
1175
1219
  # @param [String] query
1176
- # Required. The search query. Must be specified in [Common Expression Language](
1177
- # https://opensource.google/projects/cel). May only contain equality operators
1178
- # on the parent and inclusion operators on labels (e.g., `parent == 'customers/`
1179
- # customer_id`' && 'cloudidentity.googleapis.com/groups.discussion_forum' in
1180
- # labels`). The `customer_id` must begin with "C" (for example, 'C046psxkn').
1220
+ # Required. The search query. * Must be specified in [Common Expression Language]
1221
+ # (https://opensource.google/projects/cel). * Must contain equality operators on
1222
+ # the parent, e.g. `parent == 'customers/`customer_id`'`. The `customer_id` must
1223
+ # begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://
1224
+ # support.google.com/cloudidentity/answer/10070793) * Can contain optional
1225
+ # inclusion operators on `labels` such as `cloudidentity.googleapis.com/groups.
1226
+ # discussion_forum' in labels`). * Can contain an optional equality operator on `
1227
+ # domain_name` or `startsWith/contains/equality` operator on `group_key`, e.g. `
1228
+ # domain_name == 'abc.com'`, `group_key.startsWith('dev')`, `group_key.contains('
1229
+ # dev'), group_key == 'dev@abc.com'` * Can contain an optional `startsWith/
1230
+ # contains/equality` operator on `display_name`, such as `display_name.
1231
+ # startsWith('dev')` , `display_name.contains('dev')`, `display_name == 'dev'`
1181
1232
  # @param [String] view
1182
1233
  # The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
1183
1234
  # @param [String] fields
@@ -1197,10 +1248,11 @@ module Google
1197
1248
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1198
1249
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1199
1250
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1200
- def search_groups(page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1251
+ def search_groups(order_by: nil, page_size: nil, page_token: nil, query: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1201
1252
  command = make_simple_command(:get, 'v1beta1/groups:search', options)
1202
1253
  command.response_representation = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse::Representation
1203
1254
  command.response_class = Google::Apis::CloudidentityV1beta1::SearchGroupsResponse
1255
+ command.query['orderBy'] = order_by unless order_by.nil?
1204
1256
  command.query['pageSize'] = page_size unless page_size.nil?
1205
1257
  command.query['pageToken'] = page_token unless page_token.nil?
1206
1258
  command.query['query'] = query unless query.nil?
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudidentity_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.35.0
4
+ version: 0.36.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-11-07 00:00:00.000000000 Z
11
+ date: 2023-01-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudidentity_v1beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudidentity_v1beta1/v0.35.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudidentity_v1beta1/v0.36.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudidentity_v1beta1
63
63
  post_install_message:
64
64
  rdoc_options: []