Class: Google::Apis::IapV1::CloudIAPService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::IapV1::CloudIAPService
- Defined in:
- generated/google/apis/iap_v1/service.rb
Overview
Cloud Identity-Aware Proxy API
Controls access to cloud applications running on Google Cloud Platform.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#get_project_brand(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::Brand
Retrieves the OAuth brand of the project.
-
#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.
-
#initialize ⇒ CloudIAPService
constructor
A new instance of CloudIAPService.
-
#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.
-
#list_project_brands(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IapV1::ListBrandsResponse
Lists the existing brands for the project.
-
#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.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ CloudIAPService
Returns a new instance of CloudIAPService.
45 46 47 48 |
# File 'generated/google/apis/iap_v1/service.rb', line 45 def initialize super('https://iap.googleapis.com/', '') @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.
38 39 40 |
# File 'generated/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.
43 44 45 |
# File 'generated/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 G Suite 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.
78 79 80 81 82 83 84 85 86 87 88 |
# File 'generated/google/apis/iap_v1/service.rb', line 78 def create_project_brand(parent, brand_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/brands', ) 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.
178 179 180 181 182 183 184 185 186 187 188 |
# File 'generated/google/apis/iap_v1/service.rb', line 178 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', ) 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 |
#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.
215 216 217 218 219 220 221 222 223 |
# File 'generated/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}', ) 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
365 366 367 368 369 370 371 372 373 374 375 |
# File 'generated/google/apis/iap_v1/service.rb', line 365 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', ) 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.
399 400 401 402 403 404 405 406 407 |
# File 'generated/google/apis/iap_v1/service.rb', line 399 def get_iap_settings(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:iapSettings', ) 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.
111 112 113 114 115 116 117 118 119 |
# File 'generated/google/apis/iap_v1/service.rb', line 111 def get_project_brand(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
249 250 251 252 253 254 255 256 257 |
# File 'generated/google/apis/iap_v1/service.rb', line 249 def get_project_brand_identity_aware_proxy_client(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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 |
#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.
291 292 293 294 295 296 297 298 299 300 301 |
# File 'generated/google/apis/iap_v1/service.rb', line 291 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', ) 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.
142 143 144 145 146 147 148 149 150 |
# File 'generated/google/apis/iap_v1/service.rb', line 142 def list_project_brands(parent, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/brands', ) 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 |
#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.
328 329 330 331 332 333 334 335 336 337 338 |
# File 'generated/google/apis/iap_v1/service.rb', line 328 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', ) 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
434 435 436 437 438 439 440 441 442 443 444 |
# File 'generated/google/apis/iap_v1/service.rb', line 434 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', ) 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
471 472 473 474 475 476 477 478 479 480 481 |
# File 'generated/google/apis/iap_v1/service.rb', line 471 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::IapV1::TestIamPermissionsRequest::Representation command.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.
510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'generated/google/apis/iap_v1/service.rb', line 510 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', ) 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 |