google-apis-cloudidentity_v1beta1 0.4.0 → 0.5.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: 3e8b14848bc64a0dbcfb7273f0a17063891913816239d3f54142487ddcd0951a
4
- data.tar.gz: f98451a5682f02bb9cd633398ae53428a7da83ea606bf8f8cebe87550b9fdd93
3
+ metadata.gz: 87772c3d5197ec64d71bd9fcf7ae2d6311b1ab6ccaf32902d9ba8e2449026a97
4
+ data.tar.gz: 408ecefff8dd954ca37bd1d9e2fec624faf2f9070f2531813aed2df71658620d
5
5
  SHA512:
6
- metadata.gz: 2e16845a715231262c13c289fe400018e85feca2ae177351d014066ca714705bc02727d7b9af1190ebe526c08065a7cb72cd57e5f31eecfe8fc352d7cd3a9ef5
7
- data.tar.gz: 7dfdc3ef59316c2134f0d7e30b472a29efc61bd8e1d1e6b1038d17d7151810e6cb947483b8933c48298f6f99d7d54833922ea4a4ee19b81f7400cce61411aa27
6
+ metadata.gz: 2f3bf4ceb4f202283b486dc151d2ddf6925be5c6319e3a40c514c5b9d81a0ee7c911993584c4eada63b2e86ed865b8fb41a5ded3ee392aaa3ec78b14061165e8
7
+ data.tar.gz: 992dda908fcde4f6a9f1b02034ae29ebd81798dea5ece12ca050959c5227224e96e16e864588279c4d30658752652e5158ac1e73e75089605f08d6a852ca1d7c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-cloudidentity_v1beta1
2
2
 
3
+ ### v0.5.0 (2021-03-12)
4
+
5
+ * Regenerated from discovery document revision 20210310
6
+ * Regenerated using generator version 0.2.0
7
+
3
8
  ### v0.4.0 (2021-03-04)
4
9
 
5
10
  * Unspecified changes
@@ -70,22 +70,12 @@ module Google
70
70
  class ApproveDeviceUserRequest
71
71
  include Google::Apis::Core::Hashable
72
72
 
73
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
74
- # of the customer. If you're using this API for your own organization, use `
75
- # customers/my_customer` If you're using this API to manage another organization,
76
- # use `customers/`customer_id``, where customer_id is the customer to whom the
77
- # device belongs.
78
- # Corresponds to the JSON property `customer`
79
- # @return [String]
80
- attr_accessor :customer
81
-
82
73
  def initialize(**args)
83
74
  update!(**args)
84
75
  end
85
76
 
86
77
  # Update properties of this object
87
78
  def update!(**args)
88
- @customer = args[:customer] if args.key?(:customer)
89
79
  end
90
80
  end
91
81
 
@@ -113,22 +103,12 @@ module Google
113
103
  class BlockDeviceUserRequest
114
104
  include Google::Apis::Core::Hashable
115
105
 
116
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
117
- # of the customer. If you're using this API for your own organization, use `
118
- # customers/my_customer` If you're using this API to manage another organization,
119
- # use `customers/`customer_id``, where customer_id is the customer to whom the
120
- # device belongs.
121
- # Corresponds to the JSON property `customer`
122
- # @return [String]
123
- attr_accessor :customer
124
-
125
106
  def initialize(**args)
126
107
  update!(**args)
127
108
  end
128
109
 
129
110
  # Update properties of this object
130
111
  def update!(**args)
131
- @customer = args[:customer] if args.key?(:customer)
132
112
  end
133
113
  end
134
114
 
@@ -152,26 +132,29 @@ module Google
152
132
  end
153
133
  end
154
134
 
135
+ # Request to cancel sent invitation for target email in UserInvitation.
136
+ class CancelUserInvitationRequest
137
+ include Google::Apis::Core::Hashable
138
+
139
+ def initialize(**args)
140
+ update!(**args)
141
+ end
142
+
143
+ # Update properties of this object
144
+ def update!(**args)
145
+ end
146
+ end
147
+
155
148
  # Request message for cancelling an unfinished device wipe.
156
149
  class CancelWipeDeviceRequest
157
150
  include Google::Apis::Core::Hashable
158
151
 
159
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
160
- # of the customer. If you're using this API for your own organization, use `
161
- # customers/my_customer` If you're using this API to manage another organization,
162
- # use `customers/`customer_id``, where customer_id is the customer to whom the
163
- # device belongs.
164
- # Corresponds to the JSON property `customer`
165
- # @return [String]
166
- attr_accessor :customer
167
-
168
152
  def initialize(**args)
169
153
  update!(**args)
170
154
  end
171
155
 
172
156
  # Update properties of this object
173
157
  def update!(**args)
174
- @customer = args[:customer] if args.key?(:customer)
175
158
  end
176
159
  end
177
160
 
@@ -200,22 +183,12 @@ module Google
200
183
  class CancelWipeDeviceUserRequest
201
184
  include Google::Apis::Core::Hashable
202
185
 
203
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
204
- # of the customer. If you're using this API for your own organization, use `
205
- # customers/my_customer` If you're using this API to manage another organization,
206
- # use `customers/`customer_id``, where customer_id is the customer to whom the
207
- # device belongs.
208
- # Corresponds to the JSON property `customer`
209
- # @return [String]
210
- attr_accessor :customer
211
-
212
186
  def initialize(**args)
213
187
  update!(**args)
214
188
  end
215
189
 
216
190
  # Update properties of this object
217
191
  def update!(**args)
218
- @customer = args[:customer] if args.key?(:customer)
219
192
  end
220
193
  end
221
194
 
@@ -359,15 +332,6 @@ module Google
359
332
  class CreateDeviceRequest
360
333
  include Google::Apis::Core::Hashable
361
334
 
362
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
363
- # of the customer. If you're using this API for your own organization, use `
364
- # customers/my_customer` If you're using this API to manage another organization,
365
- # use `customers/`customer_id``, where customer_id is the customer to whom the
366
- # device belongs.
367
- # Corresponds to the JSON property `customer`
368
- # @return [String]
369
- attr_accessor :customer
370
-
371
335
  # A Device within the Cloud Identity Devices API. Represents a Device known to
372
336
  # Google Cloud, independent of the device ownership, type, and whether it is
373
337
  # assigned or in use by a user.
@@ -381,7 +345,6 @@ module Google
381
345
 
382
346
  # Update properties of this object
383
347
  def update!(**args)
384
- @customer = args[:customer] if args.key?(:customer)
385
348
  @device = args[:device] if args.key?(:device)
386
349
  end
387
350
  end
@@ -1569,6 +1532,26 @@ module Google
1569
1532
  end
1570
1533
  end
1571
1534
 
1535
+ # Response for IsInvitableUser RPC.
1536
+ class IsInvitableUserResponse
1537
+ include Google::Apis::Core::Hashable
1538
+
1539
+ # Returns true if the email address is invitable.
1540
+ # Corresponds to the JSON property `isInvitableUser`
1541
+ # @return [Boolean]
1542
+ attr_accessor :is_invitable_user
1543
+ alias_method :is_invitable_user?, :is_invitable_user
1544
+
1545
+ def initialize(**args)
1546
+ update!(**args)
1547
+ end
1548
+
1549
+ # Update properties of this object
1550
+ def update!(**args)
1551
+ @is_invitable_user = args[:is_invitable_user] if args.key?(:is_invitable_user)
1552
+ end
1553
+ end
1554
+
1572
1555
  # Response message that is returned in LRO result of ListClientStates Operation.
1573
1556
  class ListClientStatesResponse
1574
1557
  include Google::Apis::Core::Hashable
@@ -1696,6 +1679,34 @@ module Google
1696
1679
  end
1697
1680
  end
1698
1681
 
1682
+ # Response message for UserInvitation listing request.
1683
+ class ListUserInvitationsResponse
1684
+ include Google::Apis::Core::Hashable
1685
+
1686
+ # The token for the next page. If not empty, indicates that there may be more `
1687
+ # UserInvitation` resources that match the listing request; this value can be
1688
+ # used in a subsequent ListUserInvitationsRequest to get continued results with
1689
+ # the current list call.
1690
+ # Corresponds to the JSON property `nextPageToken`
1691
+ # @return [String]
1692
+ attr_accessor :next_page_token
1693
+
1694
+ # The list of UserInvitation resources.
1695
+ # Corresponds to the JSON property `userInvitations`
1696
+ # @return [Array<Google::Apis::CloudidentityV1beta1::UserInvitation>]
1697
+ attr_accessor :user_invitations
1698
+
1699
+ def initialize(**args)
1700
+ update!(**args)
1701
+ end
1702
+
1703
+ # Update properties of this object
1704
+ def update!(**args)
1705
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1706
+ @user_invitations = args[:user_invitations] if args.key?(:user_invitations)
1707
+ end
1708
+ end
1709
+
1699
1710
  # The response message for GroupsService.LookupGroupName.
1700
1711
  class LookupGroupNameResponse
1701
1712
  include Google::Apis::Core::Hashable
@@ -2132,6 +2143,20 @@ module Google
2132
2143
  end
2133
2144
  end
2134
2145
 
2146
+ # A request to send email for inviting target user corresponding to the
2147
+ # UserInvitation.
2148
+ class SendUserInvitationRequest
2149
+ include Google::Apis::Core::Hashable
2150
+
2151
+ def initialize(**args)
2152
+ update!(**args)
2153
+ end
2154
+
2155
+ # Update properties of this object
2156
+ def update!(**args)
2157
+ end
2158
+ end
2159
+
2135
2160
  # The `Status` type defines a logical error model that is suitable for different
2136
2161
  # programming environments, including REST APIs and RPC APIs. It is used by [
2137
2162
  # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
@@ -2218,11 +2243,12 @@ module Google
2218
2243
  end
2219
2244
  end
2220
2245
 
2221
- # The `UserInvitation` resource represents an email sent to an unmanaged user
2222
- # account (an email address that shares the domain of the Google Workspace
2223
- # customer but is not managed by it yet), inviting them to join the customer’s
2224
- # domain. If the user accepts the `UserInvitation`, the account will become a
2225
- # managed account.
2246
+ # The `UserInvitation` resource represents an email that can be sent to an
2247
+ # unmanaged user account inviting them to join the customer’s Google Workspace
2248
+ # or Cloud Identity account. An unmanaged account shares an email address domain
2249
+ # with the Google Workspace or Cloud Identity account but is not managed by it
2250
+ # yet. If the user accepts the `UserInvitation`, the user account will become
2251
+ # managed.
2226
2252
  class UserInvitation
2227
2253
  include Google::Apis::Core::Hashable
2228
2254
 
@@ -2264,22 +2290,12 @@ module Google
2264
2290
  class WipeDeviceRequest
2265
2291
  include Google::Apis::Core::Hashable
2266
2292
 
2267
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
2268
- # of the customer. If you're using this API for your own organization, use `
2269
- # customers/my_customer` If you're using this API to manage another organization,
2270
- # use `customers/`customer_id``, where customer_id is the customer to whom the
2271
- # device belongs.
2272
- # Corresponds to the JSON property `customer`
2273
- # @return [String]
2274
- attr_accessor :customer
2275
-
2276
2293
  def initialize(**args)
2277
2294
  update!(**args)
2278
2295
  end
2279
2296
 
2280
2297
  # Update properties of this object
2281
2298
  def update!(**args)
2282
- @customer = args[:customer] if args.key?(:customer)
2283
2299
  end
2284
2300
  end
2285
2301
 
@@ -2308,22 +2324,12 @@ module Google
2308
2324
  class WipeDeviceUserRequest
2309
2325
  include Google::Apis::Core::Hashable
2310
2326
 
2311
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
2312
- # of the customer. If you're using this API for your own organization, use `
2313
- # customers/my_customer` If you're using this API to manage another organization,
2314
- # use `customers/`customer_id``, where customer_id is the customer to whom the
2315
- # device belongs.
2316
- # Corresponds to the JSON property `customer`
2317
- # @return [String]
2318
- attr_accessor :customer
2319
-
2320
2327
  def initialize(**args)
2321
2328
  update!(**args)
2322
2329
  end
2323
2330
 
2324
2331
  # Update properties of this object
2325
2332
  def update!(**args)
2326
- @customer = args[:customer] if args.key?(:customer)
2327
2333
  end
2328
2334
  end
2329
2335
 
@@ -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.4.0"
19
+ GEM_VERSION = "0.5.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.2"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210204"
25
+ REVISION = "20210310"
26
26
  end
27
27
  end
28
28
  end
@@ -52,6 +52,12 @@ module Google
52
52
  include Google::Apis::Core::JsonObjectSupport
53
53
  end
54
54
 
55
+ class CancelUserInvitationRequest
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
55
61
  class CancelWipeDeviceRequest
56
62
  class Representation < Google::Apis::Core::JsonRepresentation; end
57
63
 
@@ -226,6 +232,12 @@ module Google
226
232
  include Google::Apis::Core::JsonObjectSupport
227
233
  end
228
234
 
235
+ class IsInvitableUserResponse
236
+ class Representation < Google::Apis::Core::JsonRepresentation; end
237
+
238
+ include Google::Apis::Core::JsonObjectSupport
239
+ end
240
+
229
241
  class ListClientStatesResponse
230
242
  class Representation < Google::Apis::Core::JsonRepresentation; end
231
243
 
@@ -256,6 +268,12 @@ module Google
256
268
  include Google::Apis::Core::JsonObjectSupport
257
269
  end
258
270
 
271
+ class ListUserInvitationsResponse
272
+ class Representation < Google::Apis::Core::JsonRepresentation; end
273
+
274
+ include Google::Apis::Core::JsonObjectSupport
275
+ end
276
+
259
277
  class LookupGroupNameResponse
260
278
  class Representation < Google::Apis::Core::JsonRepresentation; end
261
279
 
@@ -334,6 +352,12 @@ module Google
334
352
  include Google::Apis::Core::JsonObjectSupport
335
353
  end
336
354
 
355
+ class SendUserInvitationRequest
356
+ class Representation < Google::Apis::Core::JsonRepresentation; end
357
+
358
+ include Google::Apis::Core::JsonObjectSupport
359
+ end
360
+
337
361
  class Status
338
362
  class Representation < Google::Apis::Core::JsonRepresentation; end
339
363
 
@@ -395,7 +419,6 @@ module Google
395
419
  class ApproveDeviceUserRequest
396
420
  # @private
397
421
  class Representation < Google::Apis::Core::JsonRepresentation
398
- property :customer, as: 'customer'
399
422
  end
400
423
  end
401
424
 
@@ -410,7 +433,6 @@ module Google
410
433
  class BlockDeviceUserRequest
411
434
  # @private
412
435
  class Representation < Google::Apis::Core::JsonRepresentation
413
- property :customer, as: 'customer'
414
436
  end
415
437
  end
416
438
 
@@ -422,10 +444,15 @@ module Google
422
444
  end
423
445
  end
424
446
 
447
+ class CancelUserInvitationRequest
448
+ # @private
449
+ class Representation < Google::Apis::Core::JsonRepresentation
450
+ end
451
+ end
452
+
425
453
  class CancelWipeDeviceRequest
426
454
  # @private
427
455
  class Representation < Google::Apis::Core::JsonRepresentation
428
- property :customer, as: 'customer'
429
456
  end
430
457
  end
431
458
 
@@ -440,7 +467,6 @@ module Google
440
467
  class CancelWipeDeviceUserRequest
441
468
  # @private
442
469
  class Representation < Google::Apis::Core::JsonRepresentation
443
- property :customer, as: 'customer'
444
470
  end
445
471
  end
446
472
 
@@ -481,7 +507,6 @@ module Google
481
507
  class CreateDeviceRequest
482
508
  # @private
483
509
  class Representation < Google::Apis::Core::JsonRepresentation
484
- property :customer, as: 'customer'
485
510
  property :device, as: 'device', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation
486
511
 
487
512
  end
@@ -768,6 +793,13 @@ module Google
768
793
  end
769
794
  end
770
795
 
796
+ class IsInvitableUserResponse
797
+ # @private
798
+ class Representation < Google::Apis::Core::JsonRepresentation
799
+ property :is_invitable_user, as: 'isInvitableUser'
800
+ end
801
+ end
802
+
771
803
  class ListClientStatesResponse
772
804
  # @private
773
805
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -813,6 +845,15 @@ module Google
813
845
  end
814
846
  end
815
847
 
848
+ class ListUserInvitationsResponse
849
+ # @private
850
+ class Representation < Google::Apis::Core::JsonRepresentation
851
+ property :next_page_token, as: 'nextPageToken'
852
+ collection :user_invitations, as: 'userInvitations', class: Google::Apis::CloudidentityV1beta1::UserInvitation, decorator: Google::Apis::CloudidentityV1beta1::UserInvitation::Representation
853
+
854
+ end
855
+ end
856
+
816
857
  class LookupGroupNameResponse
817
858
  # @private
818
859
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -940,6 +981,12 @@ module Google
940
981
  end
941
982
  end
942
983
 
984
+ class SendUserInvitationRequest
985
+ # @private
986
+ class Representation < Google::Apis::Core::JsonRepresentation
987
+ end
988
+ end
989
+
943
990
  class Status
944
991
  # @private
945
992
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -978,7 +1025,6 @@ module Google
978
1025
  class WipeDeviceRequest
979
1026
  # @private
980
1027
  class Representation < Google::Apis::Core::JsonRepresentation
981
- property :customer, as: 'customer'
982
1028
  end
983
1029
  end
984
1030
 
@@ -993,7 +1039,6 @@ module Google
993
1039
  class WipeDeviceUserRequest
994
1040
  # @private
995
1041
  class Representation < Google::Apis::Core::JsonRepresentation
996
- property :customer, as: 'customer'
997
1042
  end
998
1043
  end
999
1044
 
@@ -49,6 +49,204 @@ module Google
49
49
  @batch_path = 'batch'
50
50
  end
51
51
 
52
+ # Cancels a UserInvitation that was already sent.
53
+ # @param [String] name
54
+ # Required. `UserInvitation` name in the format `customers/`customer`/
55
+ # userinvitations/`user_email_address``
56
+ # @param [Google::Apis::CloudidentityV1beta1::CancelUserInvitationRequest] cancel_user_invitation_request_object
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::CloudidentityV1beta1::Operation]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def cancel_userinvitation_user_invitation(name, cancel_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
76
+ command.request_representation = Google::Apis::CloudidentityV1beta1::CancelUserInvitationRequest::Representation
77
+ command.request_object = cancel_user_invitation_request_object
78
+ command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
79
+ command.response_class = Google::Apis::CloudidentityV1beta1::Operation
80
+ command.params['name'] = name unless name.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
86
+ # Retrieves a UserInvitation resource. **Note:** New consumer accounts with the
87
+ # customer’s verified domain created within the previous 48 hours will not
88
+ # appear in the result. This delay also applies to newly-verified domains.
89
+ # @param [String] name
90
+ # Required. `UserInvitation` name in the format `customers/`customer`/
91
+ # userinvitations/`user_email_address``
92
+ # @param [String] fields
93
+ # Selector specifying which fields to include in a partial response.
94
+ # @param [String] quota_user
95
+ # Available to use for quota purposes for server-side applications. Can be any
96
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
97
+ # @param [Google::Apis::RequestOptions] options
98
+ # Request-specific options
99
+ #
100
+ # @yield [result, err] Result & error if block supplied
101
+ # @yieldparam result [Google::Apis::CloudidentityV1beta1::UserInvitation] parsed result object
102
+ # @yieldparam err [StandardError] error object if request failed
103
+ #
104
+ # @return [Google::Apis::CloudidentityV1beta1::UserInvitation]
105
+ #
106
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
107
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
108
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
109
+ def get_customer_userinvitation(name, fields: nil, quota_user: nil, options: nil, &block)
110
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
111
+ command.response_representation = Google::Apis::CloudidentityV1beta1::UserInvitation::Representation
112
+ command.response_class = Google::Apis::CloudidentityV1beta1::UserInvitation
113
+ command.params['name'] = name unless name.nil?
114
+ command.query['fields'] = fields unless fields.nil?
115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
116
+ execute_or_queue_command(command, &block)
117
+ end
118
+
119
+ # Verifies whether a user account is eligible to receive a UserInvitation (is an
120
+ # unmanaged account). Eligibility is based on the following criteria: * the
121
+ # email address is a consumer account and it’s the primary email address of the
122
+ # account, and * the domain of the email address matches an existing verified
123
+ # Google Workspace or Cloud Identity domain If both conditions are met, the user
124
+ # is eligible. **Note:** This method is not supported for Workspace Essentials
125
+ # customers.
126
+ # @param [String] name
127
+ # Required. `UserInvitation` name in the format `customers/`customer`/
128
+ # userinvitations/`user_email_address``
129
+ # @param [String] fields
130
+ # Selector specifying which fields to include in a partial response.
131
+ # @param [String] quota_user
132
+ # Available to use for quota purposes for server-side applications. Can be any
133
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
134
+ # @param [Google::Apis::RequestOptions] options
135
+ # Request-specific options
136
+ #
137
+ # @yield [result, err] Result & error if block supplied
138
+ # @yieldparam result [Google::Apis::CloudidentityV1beta1::IsInvitableUserResponse] parsed result object
139
+ # @yieldparam err [StandardError] error object if request failed
140
+ #
141
+ # @return [Google::Apis::CloudidentityV1beta1::IsInvitableUserResponse]
142
+ #
143
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
144
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
145
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
146
+ def is_customer_userinvitation_invitable_user(name, fields: nil, quota_user: nil, options: nil, &block)
147
+ command = make_simple_command(:get, 'v1beta1/{+name}:isInvitableUser', options)
148
+ command.response_representation = Google::Apis::CloudidentityV1beta1::IsInvitableUserResponse::Representation
149
+ command.response_class = Google::Apis::CloudidentityV1beta1::IsInvitableUserResponse
150
+ command.params['name'] = name unless name.nil?
151
+ command.query['fields'] = fields unless fields.nil?
152
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
153
+ execute_or_queue_command(command, &block)
154
+ end
155
+
156
+ # Retrieves a list of UserInvitation resources. **Note:** New consumer accounts
157
+ # with the customer’s verified domain created within the previous 48 hours will
158
+ # not appear in the result. This delay also applies to newly-verified domains.
159
+ # @param [String] parent
160
+ # Required. The customer ID of the Google Workspace or Cloud Identity account
161
+ # the UserInvitation resources are associated with.
162
+ # @param [String] filter
163
+ # Optional. A query string for filtering `UserInvitation` results by their
164
+ # current state, in the format: `"state=='invited'"`.
165
+ # @param [String] order_by
166
+ # Optional. The sort order of the list results. You can sort the results in
167
+ # descending order based on either email or last update timestamp but not both,
168
+ # using `order_by="email desc"`. Currently, sorting is supported for `
169
+ # update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not
170
+ # specified, results will be returned based on `email asc` order.
171
+ # @param [Fixnum] page_size
172
+ # Optional. The maximum number of UserInvitation resources to return. If
173
+ # unspecified, at most 100 resources will be returned. The maximum value is 200;
174
+ # values above 200 will be set to 200.
175
+ # @param [String] page_token
176
+ # Optional. A page token, received from a previous `ListUserInvitations` call.
177
+ # Provide this to retrieve the subsequent page. When paginating, all other
178
+ # parameters provided to `ListBooks` must match the call that provided the page
179
+ # token.
180
+ # @param [String] fields
181
+ # Selector specifying which fields to include in a partial response.
182
+ # @param [String] quota_user
183
+ # Available to use for quota purposes for server-side applications. Can be any
184
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
185
+ # @param [Google::Apis::RequestOptions] options
186
+ # Request-specific options
187
+ #
188
+ # @yield [result, err] Result & error if block supplied
189
+ # @yieldparam result [Google::Apis::CloudidentityV1beta1::ListUserInvitationsResponse] parsed result object
190
+ # @yieldparam err [StandardError] error object if request failed
191
+ #
192
+ # @return [Google::Apis::CloudidentityV1beta1::ListUserInvitationsResponse]
193
+ #
194
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
195
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
196
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
197
+ def list_customer_userinvitations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
198
+ command = make_simple_command(:get, 'v1beta1/{+parent}/userinvitations', options)
199
+ command.response_representation = Google::Apis::CloudidentityV1beta1::ListUserInvitationsResponse::Representation
200
+ command.response_class = Google::Apis::CloudidentityV1beta1::ListUserInvitationsResponse
201
+ command.params['parent'] = parent unless parent.nil?
202
+ command.query['filter'] = filter unless filter.nil?
203
+ command.query['orderBy'] = order_by unless order_by.nil?
204
+ command.query['pageSize'] = page_size unless page_size.nil?
205
+ command.query['pageToken'] = page_token unless page_token.nil?
206
+ command.query['fields'] = fields unless fields.nil?
207
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
208
+ execute_or_queue_command(command, &block)
209
+ end
210
+
211
+ # Sends a UserInvitation to email. If the `UserInvitation` does not exist for
212
+ # this request and it is a valid request, the request creates a `UserInvitation`.
213
+ # **Note:** The `get` and `list` methods have a 48-hour delay where newly-
214
+ # created consumer accounts will not appear in the results. You can still send a
215
+ # `UserInvitation` to those accounts if you know the unmanaged email address and
216
+ # IsInvitableUser==True.
217
+ # @param [String] name
218
+ # Required. `UserInvitation` name in the format `customers/`customer`/
219
+ # userinvitations/`user_email_address``
220
+ # @param [Google::Apis::CloudidentityV1beta1::SendUserInvitationRequest] send_user_invitation_request_object
221
+ # @param [String] fields
222
+ # Selector specifying which fields to include in a partial response.
223
+ # @param [String] quota_user
224
+ # Available to use for quota purposes for server-side applications. Can be any
225
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
226
+ # @param [Google::Apis::RequestOptions] options
227
+ # Request-specific options
228
+ #
229
+ # @yield [result, err] Result & error if block supplied
230
+ # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object
231
+ # @yieldparam err [StandardError] error object if request failed
232
+ #
233
+ # @return [Google::Apis::CloudidentityV1beta1::Operation]
234
+ #
235
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
236
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
237
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
238
+ def send_userinvitation_user_invitation(name, send_user_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
239
+ command = make_simple_command(:post, 'v1beta1/{+name}:send', options)
240
+ command.request_representation = Google::Apis::CloudidentityV1beta1::SendUserInvitationRequest::Representation
241
+ command.request_object = send_user_invitation_request_object
242
+ command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
243
+ command.response_class = Google::Apis::CloudidentityV1beta1::Operation
244
+ command.params['name'] = name unless name.nil?
245
+ command.query['fields'] = fields unless fields.nil?
246
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
247
+ execute_or_queue_command(command, &block)
248
+ end
249
+
52
250
  # Cancels an unfinished device wipe. This operation can be used to cancel device
53
251
  # wipe in the gap between the wipe operation returning success and the device
54
252
  # being wiped.
@@ -124,12 +322,6 @@ module Google
124
322
  # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
125
323
  # of the Device in format: `devices/`device_id``, where device_id is the unique
126
324
  # ID assigned to the Device.
127
- # @param [String] customer
128
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
129
- # of the customer. If you're using this API for your own organization, use `
130
- # customers/my_customer` If you're using this API to manage another organization,
131
- # use `customers/`customer_id``, where customer_id is the customer to whom the
132
- # device belongs.
133
325
  # @param [String] fields
134
326
  # Selector specifying which fields to include in a partial response.
135
327
  # @param [String] quota_user
@@ -147,12 +339,11 @@ module Google
147
339
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
148
340
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
149
341
  # @raise [Google::Apis::AuthorizationError] Authorization is required
150
- def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
342
+ def delete_device(name, fields: nil, quota_user: nil, options: nil, &block)
151
343
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
152
344
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
153
345
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
154
346
  command.params['name'] = name unless name.nil?
155
- command.query['customer'] = customer unless customer.nil?
156
347
  command.query['fields'] = fields unless fields.nil?
157
348
  command.query['quotaUser'] = quota_user unless quota_user.nil?
158
349
  execute_or_queue_command(command, &block)
@@ -163,10 +354,6 @@ module Google
163
354
  # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
164
355
  # of the Device in format: `devices/`device_id``, where device_id is the unique
165
356
  # ID assigned to the Device.
166
- # @param [String] customer
167
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
168
- # of the Customer in format: `customers/`customer_id``, where customer_id is the
169
- # customer to whom the device belongs.
170
357
  # @param [String] fields
171
358
  # Selector specifying which fields to include in a partial response.
172
359
  # @param [String] quota_user
@@ -184,21 +371,17 @@ module Google
184
371
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
185
372
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
186
373
  # @raise [Google::Apis::AuthorizationError] Authorization is required
187
- def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
374
+ def get_device(name, fields: nil, quota_user: nil, options: nil, &block)
188
375
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
189
376
  command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation
190
377
  command.response_class = Google::Apis::CloudidentityV1beta1::Device
191
378
  command.params['name'] = name unless name.nil?
192
- command.query['customer'] = customer unless customer.nil?
193
379
  command.query['fields'] = fields unless fields.nil?
194
380
  command.query['quotaUser'] = quota_user unless quota_user.nil?
195
381
  execute_or_queue_command(command, &block)
196
382
  end
197
383
 
198
384
  # Lists/Searches devices.
199
- # @param [String] customer
200
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
201
- # of the customer.
202
385
  # @param [String] filter
203
386
  # Optional. Additional restrictions when fetching list of devices. For a list of
204
387
  # search fields, refer to [Mobile device search fields](https://developers.
@@ -237,11 +420,10 @@ module Google
237
420
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
238
421
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
239
422
  # @raise [Google::Apis::AuthorizationError] Authorization is required
240
- 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)
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)
241
424
  command = make_simple_command(:get, 'v1beta1/devices', options)
242
425
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation
243
426
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse
244
- command.query['customer'] = customer unless customer.nil?
245
427
  command.query['filter'] = filter unless filter.nil?
246
428
  command.query['orderBy'] = order_by unless order_by.nil?
247
429
  command.query['pageSize'] = page_size unless page_size.nil?
@@ -405,12 +587,6 @@ module Google
405
587
  # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
406
588
  # where device_id is the unique ID assigned to the Device, and device_user_id is
407
589
  # the unique ID assigned to the User.
408
- # @param [String] customer
409
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
410
- # of the customer. If you're using this API for your own organization, use `
411
- # customers/my_customer` If you're using this API to manage another organization,
412
- # use `customers/`customer_id``, where customer_id is the customer to whom the
413
- # device belongs.
414
590
  # @param [String] fields
415
591
  # Selector specifying which fields to include in a partial response.
416
592
  # @param [String] quota_user
@@ -428,12 +604,11 @@ module Google
428
604
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
429
605
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
430
606
  # @raise [Google::Apis::AuthorizationError] Authorization is required
431
- def delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
607
+ def delete_device_device_user(name, fields: nil, quota_user: nil, options: nil, &block)
432
608
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
433
609
  command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation
434
610
  command.response_class = Google::Apis::CloudidentityV1beta1::Operation
435
611
  command.params['name'] = name unless name.nil?
436
- command.query['customer'] = customer unless customer.nil?
437
612
  command.query['fields'] = fields unless fields.nil?
438
613
  command.query['quotaUser'] = quota_user unless quota_user.nil?
439
614
  execute_or_queue_command(command, &block)
@@ -445,12 +620,6 @@ module Google
445
620
  # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``,
446
621
  # where device_id is the unique ID assigned to the Device, and device_user_id is
447
622
  # the unique ID assigned to the User.
448
- # @param [String] customer
449
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
450
- # of the customer. If you're using this API for your own organization, use `
451
- # customers/my_customer` If you're using this API to manage another organization,
452
- # use `customers/`customer_id``, where customer_id is the customer to whom the
453
- # device belongs.
454
623
  # @param [String] fields
455
624
  # Selector specifying which fields to include in a partial response.
456
625
  # @param [String] quota_user
@@ -468,12 +637,11 @@ module Google
468
637
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
469
638
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
470
639
  # @raise [Google::Apis::AuthorizationError] Authorization is required
471
- def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block)
640
+ def get_device_device_user(name, fields: nil, quota_user: nil, options: nil, &block)
472
641
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
473
642
  command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation
474
643
  command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser
475
644
  command.params['name'] = name unless name.nil?
476
- command.query['customer'] = customer unless customer.nil?
477
645
  command.query['fields'] = fields unless fields.nil?
478
646
  command.query['quotaUser'] = quota_user unless quota_user.nil?
479
647
  execute_or_queue_command(command, &block)
@@ -484,12 +652,6 @@ module Google
484
652
  # Required. To list all DeviceUsers, set this to "devices/-". To list all
485
653
  # DeviceUsers owned by a device, set this to the resource name of the device.
486
654
  # Format: devices/`device`
487
- # @param [String] customer
488
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
489
- # of the customer. If you're using this API for your own organization, use `
490
- # customers/my_customer` If you're using this API to manage another organization,
491
- # use `customers/`customer_id``, where customer_id is the customer to whom the
492
- # device belongs.
493
655
  # @param [String] filter
494
656
  # Optional. Additional restrictions when fetching list of devices. For a list of
495
657
  # search fields, refer to [Mobile device search fields](https://developers.
@@ -523,12 +685,11 @@ module Google
523
685
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
524
686
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
525
687
  # @raise [Google::Apis::AuthorizationError] Authorization is required
526
- 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)
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)
527
689
  command = make_simple_command(:get, 'v1beta1/{+parent}/deviceUsers', options)
528
690
  command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation
529
691
  command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse
530
692
  command.params['parent'] = parent unless parent.nil?
531
- command.query['customer'] = customer unless customer.nil?
532
693
  command.query['filter'] = filter unless filter.nil?
533
694
  command.query['orderBy'] = order_by unless order_by.nil?
534
695
  command.query['pageSize'] = page_size unless page_size.nil?
@@ -646,16 +807,19 @@ module Google
646
807
  # @param [String] name
647
808
  # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
648
809
  # of the ClientState in format: `devices/`device_id`/deviceUsers/`device_user_id`
649
- # /clientStates/`partner_id``, where device_id is the unique ID assigned to the
650
- # Device, device_user_id is the unique ID assigned to the User and partner_id
651
- # identifies the partner storing the data. To get the client state for devices
652
- # belonging to your own organization, the `partnerId` is in the format: `
653
- # customerId-*anystring*`. Where the `customerId` is your organization's
654
- # customer ID and `anystring` is any suffix. This suffix is used in setting up
810
+ # /clientStates/`partner_id``, where `device_id` is the unique ID assigned to
811
+ # the Device, `device_user_id` is the unique ID assigned to the User and `
812
+ # partner_id` identifies the partner storing the data. To get the client state
813
+ # for devices belonging to your own organization, the `partnerId` is in the
814
+ # format: `customerId-*anystring*`. Where the `customerId` is your organization'
815
+ # s customer ID and `anystring` is any suffix. This suffix is used in setting up
655
816
  # Custom Access Levels in Context-Aware Access. You may use `my_customer`
656
- # instead of the customer ID for devices managed by your own organization.
817
+ # instead of the customer ID for devices managed by your own organization. You
818
+ # may specify `-` in place of the ``device_id``, so the ClientState resource
819
+ # name can be: `devices/-/deviceUsers/`device_user_resource_id`/clientStates/`
820
+ # partner_id``.
657
821
  # @param [String] customer
658
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
822
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
659
823
  # of the customer. If you're using this API for your own organization, use `
660
824
  # customers/my_customer` If you're using this API to manage another organization,
661
825
  # use `customers/`customer_id``, where customer_id is the customer to whom the
@@ -699,7 +863,7 @@ module Google
699
863
  # the partner storing the data.
700
864
  # @param [Google::Apis::CloudidentityV1beta1::ClientState] client_state_object
701
865
  # @param [String] customer
702
- # Required. [Resource name](https://cloud.google.com/apis/design/resource_names)
866
+ # Optional. [Resource name](https://cloud.google.com/apis/design/resource_names)
703
867
  # of the customer. If you're using this API for your own organization, use `
704
868
  # customers/my_customer` If you're using this API to manage another organization,
705
869
  # use `customers/`customer_id``, where customer_id is the customer to whom the
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.4.0
4
+ version: 0.5.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: 2021-03-08 00:00:00.000000000 Z
11
+ date: 2021-03-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-cloudidentity_v1beta1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudidentity_v1beta1/v0.4.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudidentity_v1beta1/v0.5.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-cloudidentity_v1beta1
57
57
  post_install_message:
58
58
  rdoc_options: []