Class: Google::Apis::IapV1::CloudIAPService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/iap_v1/service.rb

Overview

Cloud Identity-Aware Proxy API

Controls access to cloud applications running on Google Cloud Platform.

Examples:

require 'google/apis/iap_v1'

Iap = Google::Apis::IapV1 # Alias the module
service = Iap::CloudIAPService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudIAPService

Returns a new instance of CloudIAPService.



45
46
47
48
49
50
 
# File 'lib/google/apis/iap_v1/service.rb', line 45

def initialize
  super('https://iap.googleapis.com/', '',
        client_name: 'google-apis-iap_v1',
        client_version: Google::Apis::IapV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



38
39
40
 
# File 'lib/google/apis/iap_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



43
44
45
 
# File 'lib/google/apis/iap_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_project_brand(parent, brand_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Brand

Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same Google Workspace organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud Console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.

Parameters:

  • parent (String) —

    Required. GCP Project number/id under which the brand is to be created. In the following format: projects/project_number/id.

  • brand_object (Google::Apis::IapV1::Brand) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/apis/iap_v1/service.rb', line 80

def create_project_brand(parent, brand_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/brands', options)
  command.request_representation = Google::Apis::IapV1::Brand::Representation
  command.request_object = brand_object
  command.response_representation = Google::Apis::IapV1::Brand::Representation
  command.response_class = Google::Apis::IapV1::Brand
  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

#create_project_brand_identity_aware_proxy_client(parent, identity_aware_proxy_client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::IdentityAwareProxyClient

Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.

Parameters:

  • parent (String) —

    Required. Path to create the client in. In the following format: projects/ project_number/id/brands/brand. The project must belong to a G Suite account.

  • identity_aware_proxy_client_object (Google::Apis::IapV1::IdentityAwareProxyClient) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/google/apis/iap_v1/service.rb', line 179

def create_project_brand_identity_aware_proxy_client(parent, identity_aware_proxy_client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/identityAwareProxyClients', options)
  command.request_representation = Google::Apis::IapV1::IdentityAwareProxyClient::Representation
  command.request_object = identity_aware_proxy_client_object
  command.response_representation = Google::Apis::IapV1::IdentityAwareProxyClient::Representation
  command.response_class = Google::Apis::IapV1::IdentityAwareProxyClient
  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

#create_project_iap_tunnel_location_dest_group(parent, tunnel_dest_group_object = nil, tunnel_dest_group_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::TunnelDestGroup

Creates a new TunnelDestGroup.

Parameters:

  • parent (String) —

    Required. GCP Project number/id and location. In the following format: projects/project_number/id/iap_tunnel/locations/location.

  • tunnel_dest_group_object (Google::Apis::IapV1::TunnelDestGroup) (defaults to: nil)
  • tunnel_dest_group_id (String) (defaults to: nil) —

    Required. The ID to use for the TunnelDestGroup, which will become the final component of the resource name. This value should be 4-63 characters, and valid characters are /a-z-/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/google/apis/iap_v1/service.rb', line 362

def create_project_iap_tunnel_location_dest_group(parent, tunnel_dest_group_object = nil, tunnel_dest_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/destGroups', options)
  command.request_representation = Google::Apis::IapV1::TunnelDestGroup::Representation
  command.request_object = tunnel_dest_group_object
  command.response_representation = Google::Apis::IapV1::TunnelDestGroup::Representation
  command.response_class = Google::Apis::IapV1::TunnelDestGroup
  command.params['parent'] = parent unless parent.nil?
  command.query['tunnelDestGroupId'] = tunnel_dest_group_id unless tunnel_dest_group_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

#delete_project_brand_identity_aware_proxy_client(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Empty

Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.

Parameters:

  • name (String) —

    Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/project_number/id/brands/brand/ identityAwareProxyClients/client_id.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



215
216
217
218
219
220
221
222
223
 
# File 'lib/google/apis/iap_v1/service.rb', line 215

def delete_project_brand_identity_aware_proxy_client(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::IapV1::Empty::Representation
  command.response_class = Google::Apis::IapV1::Empty
  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

#delete_project_iap_tunnel_location_dest_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Empty

Deletes a TunnelDestGroup.

Parameters:

  • name (String) —

    Required. Name of the TunnelDestGroup to be deleted. In the following format: projects/project_number/id/iap_tunnel/locations/location/destGroups/ dest_group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



397
398
399
400
401
402
403
404
405
 
# File 'lib/google/apis/iap_v1/service.rb', line 397

def delete_project_iap_tunnel_location_dest_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::IapV1::Empty::Representation
  command.response_class = Google::Apis::IapV1::Empty
  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_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Policy

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud. google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::IapV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/google/apis/iap_v1/service.rb', line 547

def get_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::IapV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::IapV1::Policy::Representation
  command.response_class = Google::Apis::IapV1::Policy
  command.params['resource'] = resource unless resource.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_iap_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::IapSettings

Gets the IAP settings on a particular IAP protected resource.

Parameters:

  • name (String) —

    Required. The resource name for which to retrieve the settings. Authorization: Requires the getSettings permission for the associated resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



580
581
582
583
584
585
586
587
588
 
# File 'lib/google/apis/iap_v1/service.rb', line 580

def get_iap_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:iapSettings', options)
  command.response_representation = Google::Apis::IapV1::IapSettings::Representation
  command.response_class = Google::Apis::IapV1::IapSettings
  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_project_brand(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Brand

Retrieves the OAuth brand of the project.

Parameters:

  • name (String) —

    Required. Name of the brand to be fetched. In the following format: projects/ project_number/id/brands/brand.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/iap_v1/service.rb', line 113

def get_project_brand(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::IapV1::Brand::Representation
  command.response_class = Google::Apis::IapV1::Brand
  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_project_brand_identity_aware_proxy_client(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::IdentityAwareProxyClient

Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.

Parameters:

  • name (String) —

    Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/project_number/id/brands/brand/ identityAwareProxyClients/client_id.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



248
249
250
251
252
253
254
255
256
 
# File 'lib/google/apis/iap_v1/service.rb', line 248

def get_project_brand_identity_aware_proxy_client(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::IapV1::IdentityAwareProxyClient::Representation
  command.response_class = Google::Apis::IapV1::IdentityAwareProxyClient
  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_project_iap_tunnel_location_dest_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::TunnelDestGroup

Retrieves an existing TunnelDestGroup.

Parameters:

  • name (String) —

    Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/project_number/id/iap_tunnel/locations/location/destGroups/ dest_group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



429
430
431
432
433
434
435
436
437
 
# File 'lib/google/apis/iap_v1/service.rb', line 429

def get_project_iap_tunnel_location_dest_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::IapV1::TunnelDestGroup::Representation
  command.response_class = Google::Apis::IapV1::TunnelDestGroup
  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

#list_project_brand_identity_aware_proxy_clients(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::ListIdentityAwareProxyClientsResponse

Lists the existing clients for the brand.

Parameters:

  • parent (String) —

    Required. Full brand path. In the following format: projects/project_number/ id/brands/brand.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListIdentityAwareProxyClients call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIdentityAwareProxyClients must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/apis/iap_v1/service.rb', line 288

def list_project_brand_identity_aware_proxy_clients(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/identityAwareProxyClients', options)
  command.response_representation = Google::Apis::IapV1::ListIdentityAwareProxyClientsResponse::Representation
  command.response_class = Google::Apis::IapV1::ListIdentityAwareProxyClientsResponse
  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

#list_project_brands(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::ListBrandsResponse

Lists the existing brands for the project.

Parameters:

  • parent (String) —

    Required. GCP Project number/id. In the following format: projects/ project_number/id.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



144
145
146
147
148
149
150
151
152
 
# File 'lib/google/apis/iap_v1/service.rb', line 144

def list_project_brands(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/brands', options)
  command.response_representation = Google::Apis::IapV1::ListBrandsResponse::Representation
  command.response_class = Google::Apis::IapV1::ListBrandsResponse
  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

#list_project_iap_tunnel_location_dest_groups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::ListTunnelDestGroupsResponse

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/ destGroups

Parameters:

  • parent (String) —

    Required. GCP Project number/id and location. In the following format: projects/project_number/id/iap_tunnel/locations/location. A - can be used for the location to group across all locations.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 100 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTunnelDestGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTunnelDestGroups must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/google/apis/iap_v1/service.rb', line 472

def list_project_iap_tunnel_location_dest_groups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/destGroups', options)
  command.response_representation = Google::Apis::IapV1::ListTunnelDestGroupsResponse::Representation
  command.response_class = Google::Apis::IapV1::ListTunnelDestGroupsResponse
  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

#patch_project_iap_tunnel_location_dest_group(name, tunnel_dest_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::TunnelDestGroup

Updates a TunnelDestGroup.

Parameters:

  • name (String) —

    Required. Immutable. Identifier for the TunnelDestGroup. Must be unique within the project.

  • tunnel_dest_group_object (Google::Apis::IapV1::TunnelDestGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The field mask specifying which IAP settings should be updated. If omitted, then all of the settings are updated. See https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/google/apis/iap_v1/service.rb', line 510

def patch_project_iap_tunnel_location_dest_group(name, tunnel_dest_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::IapV1::TunnelDestGroup::Representation
  command.request_object = tunnel_dest_group_object
  command.response_representation = Google::Apis::IapV1::TunnelDestGroup::Representation
  command.response_class = Google::Apis::IapV1::TunnelDestGroup
  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

#reset_project_brand_identity_aware_proxy_client_secret(name, reset_identity_aware_proxy_client_secret_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::IdentityAwareProxyClient

Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.

Parameters:

  • name (String) —

    Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/project_number/id/brands/brand/ identityAwareProxyClients/client_id.

  • reset_identity_aware_proxy_client_secret_request_object (Google::Apis::IapV1::ResetIdentityAwareProxyClientSecretRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/google/apis/iap_v1/service.rb', line 324

def reset_project_brand_identity_aware_proxy_client_secret(name, reset_identity_aware_proxy_client_secret_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resetSecret', options)
  command.request_representation = Google::Apis::IapV1::ResetIdentityAwareProxyClientSecretRequest::Representation
  command.request_object = reset_identity_aware_proxy_client_secret_request_object
  command.response_representation = Google::Apis::IapV1::IdentityAwareProxyClient::Representation
  command.response_class = Google::Apis::IapV1::IdentityAwareProxyClient
  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

#set_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Policy

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access# managing_access_via_the_api

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::IapV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/apis/iap_v1/service.rb', line 615

def set_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::IapV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::IapV1::Policy::Representation
  command.response_class = Google::Apis::IapV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::TestIamPermissionsResponse

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::IapV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/google/apis/iap_v1/service.rb', line 651

def test_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::IapV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::IapV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::IapV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_iap_settings(name, iap_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::IapSettings

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters:

  • name (String) —

    Required. The resource name of the IAP protected resource.

  • iap_settings_object (Google::Apis::IapV1::IapSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/ protocol-buffers/docs/reference/google.protobuf#fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/google/apis/iap_v1/service.rb', line 689

def update_iap_settings(name, iap_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:iapSettings', options)
  command.request_representation = Google::Apis::IapV1::IapSettings::Representation
  command.request_object = iap_settings_object
  command.response_representation = Google::Apis::IapV1::IapSettings::Representation
  command.response_class = Google::Apis::IapV1::IapSettings
  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