Class: Google::Apis::IdentitytoolkitV2::IdentityToolkitService

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

Overview

Identity Toolkit API

The Google Identity Toolkit API lets you use open standards to verify a user's identity.

Examples:

require 'google/apis/identitytoolkit_v2'

Identitytoolkit = Google::Apis::IdentitytoolkitV2 # Alias the module
service = Identitytoolkit::IdentityToolkitService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://identitytoolkit.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeIdentityToolkitService

Returns a new instance of IdentityToolkitService.



48
49
50
51
52
53
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-identitytoolkit_v2',
        client_version: Google::Apis::IdentitytoolkitV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.



41
42
43
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 41

def key
  @key
end

#quota_userString

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.



46
47
48
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#create_project_default_supported_idp_config(parent, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, idp_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Create a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig) (defaults to: nil)
  • idp_id (String) (defaults to: nil)

    The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.

  • 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



368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 368

def create_project_default_supported_idp_config(parent, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, idp_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/defaultSupportedIdpConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['idpId'] = idp_id unless idp_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

#create_project_inbound_saml_config(parent, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, inbound_saml_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Create an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig) (defaults to: nil)
  • inbound_saml_config_id (String) (defaults to: nil)

    The id to use for this config.

  • 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
589
590
591
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 580

def create_project_inbound_saml_config(parent, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, inbound_saml_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/inboundSamlConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['inboundSamlConfigId'] = inbound_saml_config_id unless inbound_saml_config_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

#create_project_oauth_idp_config(parent, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, oauth_idp_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Create an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig) (defaults to: nil)
  • oauth_idp_config_id (String) (defaults to: nil)

    The id to use for this config.

  • 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



754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 754

def create_project_oauth_idp_config(parent, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, oauth_idp_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/oauthIdpConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['oauthIdpConfigId'] = oauth_idp_config_id unless oauth_idp_config_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

#create_project_tenant(parent, google_cloud_identitytoolkit_admin_v2_tenant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant

Create a tenant. Requires write permission on the Agent project.

Parameters:

  • parent (String)

    The parent resource name where the tenant will be created. For example, " projects/project1".

  • google_cloud_identitytoolkit_admin_v2_tenant_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant) (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



926
927
928
929
930
931
932
933
934
935
936
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 926

def create_project_tenant(parent, google_cloud_identitytoolkit_admin_v2_tenant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/tenants', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_tenant_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant
  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_tenant_default_supported_idp_config(parent, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, idp_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Create a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig) (defaults to: nil)
  • idp_id (String) (defaults to: nil)

    The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.

  • 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



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1212

def create_project_tenant_default_supported_idp_config(parent, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, idp_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/defaultSupportedIdpConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['idpId'] = idp_id unless idp_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

#create_project_tenant_inbound_saml_config(parent, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, inbound_saml_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Create an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig) (defaults to: nil)
  • inbound_saml_config_id (String) (defaults to: nil)

    The id to use for this config.

  • 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



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1386

def create_project_tenant_inbound_saml_config(parent, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, inbound_saml_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/inboundSamlConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['inboundSamlConfigId'] = inbound_saml_config_id unless inbound_saml_config_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

#create_project_tenant_oauth_idp_config(parent, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, oauth_idp_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Create an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name where the config to be created, for example: " projects/my-awesome-project"

  • google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig) (defaults to: nil)
  • oauth_idp_config_id (String) (defaults to: nil)

    The id to use for this config.

  • 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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1560

def create_project_tenant_oauth_idp_config(parent, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, oauth_idp_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/oauthIdpConfigs', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['oauthIdpConfigId'] = oauth_idp_config_id unless oauth_idp_config_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_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: "projects/my-awesome-project/ defaultSupportedIdpConfigs/google.com"

  • 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



402
403
404
405
406
407
408
409
410
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 402

def delete_project_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config to be deleted, for example: 'projects/my- awesome-project/inboundSamlConfigs/my-config-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



614
615
616
617
618
619
620
621
622
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 614

def delete_project_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config to be deleted, for example: 'projects/my- awesome-project/oauthIdpConfigs/oauth-config-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



788
789
790
791
792
793
794
795
796
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 788

def delete_project_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_tenant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete a tenant. Requires write permission on the Agent project.

Parameters:

  • name (String)

    Resource name of the tenant to delete.

  • 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



958
959
960
961
962
963
964
965
966
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 958

def delete_project_tenant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_tenant_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: "projects/my-awesome-project/ defaultSupportedIdpConfigs/google.com"

  • 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



1246
1247
1248
1249
1250
1251
1252
1253
1254
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1246

def delete_project_tenant_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_tenant_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config to be deleted, for example: 'projects/my- awesome-project/inboundSamlConfigs/my-config-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



1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1420

def delete_project_tenant_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty
  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_tenant_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleProtobufEmpty

Delete an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config to be deleted, for example: 'projects/my- awesome-project/oauthIdpConfigs/oauth-config-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



1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1594

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

#finalize_account_mfa_enrollment(google_cloud_identitytoolkit_v2_finalize_mfa_enrollment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse

Finishes enrolling a second factor for the user.

Parameters:

  • google_cloud_identitytoolkit_v2_finalize_mfa_enrollment_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest) (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



107
108
109
110
111
112
113
114
115
116
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 107

def (google_cloud_identitytoolkit_v2_finalize_mfa_enrollment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts/mfaEnrollment:finalize', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v2_finalize_mfa_enrollment_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#finalize_account_mfa_sign_in(google_cloud_identitytoolkit_v2_finalize_mfa_sign_in_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse

Verifies the MFA challenge and performs sign-in

Parameters:

  • google_cloud_identitytoolkit_v2_finalize_mfa_sign_in_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest) (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



198
199
200
201
202
203
204
205
206
207
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 198

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts/mfaSignIn:finalize', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_password_policy(tenant_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2PasswordPolicy

Gets password policy config set on the project or tenant.

Parameters:

  • tenant_id (String) (defaults to: nil)

    The id of a tenant.

  • 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



1730
1731
1732
1733
1734
1735
1736
1737
1738
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1730

def get_password_policy(tenant_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/passwordPolicy', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2PasswordPolicy::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2PasswordPolicy
  command.query['tenantId'] = tenant_id unless tenant_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

#get_project_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config

Retrieve an Identity Toolkit project configuration.

Parameters:

  • name (String)

    The resource name of the config, for example: "projects/my-awesome-project/ config"

  • 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



293
294
295
296
297
298
299
300
301
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 293

def get_project_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config
  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_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Retrieve a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: "projects/my-awesome-project/ defaultSupportedIdpConfigs/google.com"

  • 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



433
434
435
436
437
438
439
440
441
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 433

def get_project_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  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_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Retrieve an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: 'projects/my-awesome-project/ inboundSamlConfigs/my-config-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



645
646
647
648
649
650
651
652
653
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 645

def get_project_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  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_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Retrieve an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: 'projects/my-awesome-project/ oauthIdpConfigs/oauth-config-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



819
820
821
822
823
824
825
826
827
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 819

def get_project_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  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_tenant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant

Get a tenant. Requires read permission on the Tenant resource.

Parameters:

  • name (String)

    Resource name of the tenant to retrieve.

  • 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



988
989
990
991
992
993
994
995
996
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 988

def get_project_tenant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant
  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_tenant_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Retrieve a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: "projects/my-awesome-project/ defaultSupportedIdpConfigs/google.com"

  • 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



1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1277

def get_project_tenant_default_supported_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  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_tenant_iam_policy(resource, google_iam_v1_get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy

Gets the access control policy for a resource. An error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Caller must have the right Google IAM permission on the resource.

Parameters:

  • resource (String)

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

  • google_iam_v1_get_iam_policy_request_object (Google::Apis::IdentitytoolkitV2::GoogleIamV1GetIamPolicyRequest) (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



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1024

def get_project_tenant_iam_policy(resource, google_iam_v1_get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1GetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_get_iam_policy_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy
  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_project_tenant_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Retrieve an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: 'projects/my-awesome-project/ inboundSamlConfigs/my-config-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



1451
1452
1453
1454
1455
1456
1457
1458
1459
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1451

def get_project_tenant_inbound_saml_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  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_tenant_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Retrieve an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The resource name of the config, for example: 'projects/my-awesome-project/ oauthIdpConfigs/oauth-config-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



1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1625

def get_project_tenant_oauth_idp_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  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_recaptcha_config(client_type: nil, tenant_id: nil, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RecaptchaConfig

Gets parameters needed for reCAPTCHA analysis.

Parameters:

  • client_type (String) (defaults to: nil)

    reCAPTCHA Enterprise uses separate site keys for different client types. Specify the client type to get the corresponding key.

  • tenant_id (String) (defaults to: nil)

    The id of a tenant.

  • version (String) (defaults to: nil)

    The reCAPTCHA version.

  • 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



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1765

def get_recaptcha_config(client_type: nil, tenant_id: nil, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/recaptchaConfig', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RecaptchaConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RecaptchaConfig
  command.query['clientType'] = client_type unless client_type.nil?
  command.query['tenantId'] = tenant_id unless tenant_id.nil?
  command.query['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#initialize_project_identity_platform_auth(project, google_cloud_identitytoolkit_admin_v2_initialize_identity_platform_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse

Initialize Identity Platform for a Cloud project. Identity Platform is an end- to-end authentication system for third-party users to access your apps and services. These could include mobile/web apps, games, APIs and beyond. This is the publicly available variant of EnableIdentityPlatform that is only available to billing-enabled projects.

Parameters:

  • project (String)

    The resource name of the target project the developer wants to enable Identity Platform for.

  • google_cloud_identitytoolkit_admin_v2_initialize_identity_platform_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformRequest) (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



544
545
546
547
548
549
550
551
552
553
554
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 544

def initialize_project_identity_platform_auth(project, google_cloud_identitytoolkit_admin_v2_initialize_identity_platform_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+project}/identityPlatform:initializeAuth', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformRequest::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_initialize_identity_platform_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse
  command.params['project'] = project unless project.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_default_supported_idps(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse

List all default supported Idps.

Parameters:

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



261
262
263
264
265
266
267
268
269
270
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 261

def list_default_supported_idps(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/defaultSupportedIdps', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse
  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_default_supported_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse

List all default supported Idp configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



467
468
469
470
471
472
473
474
475
476
477
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 467

def list_project_default_supported_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/defaultSupportedIdpConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse
  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_inbound_saml_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse

List all inbound SAML configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



679
680
681
682
683
684
685
686
687
688
689
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 679

def list_project_inbound_saml_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/inboundSamlConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse
  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_oauth_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse

List all Oidc Idp configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



853
854
855
856
857
858
859
860
861
862
863
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 853

def list_project_oauth_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/oauthIdpConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse
  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_tenant_default_supported_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse

List all default supported Idp configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1311

def list_project_tenant_default_supported_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/defaultSupportedIdpConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse
  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_tenant_inbound_saml_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse

List all inbound SAML configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1485

def list_project_tenant_inbound_saml_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/inboundSamlConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse
  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_tenant_oauth_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse

List all Oidc Idp configurations for an Identity Toolkit project.

Parameters:

  • parent (String)

    The parent resource name, for example, "projects/my-awesome-project".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous List request, if any.

  • 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



1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1659

def list_project_tenant_oauth_idp_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/oauthIdpConfigs', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse
  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_tenants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse

List tenants under the given agent project. Requires read permission on the Agent project.

Parameters:

  • parent (String)

    Required. The parent resource name to list tenants for.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return, capped at 1000. If not specified, the default value is 20.

  • page_token (String) (defaults to: nil)

    The pagination token from the response of a previous request.

  • 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



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1062

def list_project_tenants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/tenants', options)
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse
  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_default_supported_idp_config(name, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Update a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the DefaultSupportedIdpConfig resource, for example: "projects/my- awesome-project/defaultSupportedIdpConfigs/google.com"

  • google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. For the FieldMask definition, 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



505
506
507
508
509
510
511
512
513
514
515
516
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 505

def patch_project_default_supported_idp_config(name, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  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

#patch_project_inbound_saml_config(name, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Update an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the InboundSamlConfig resource, for example: 'projects/my-awesome- project/inboundSamlConfigs/my-config-id'. Ignored during create requests.

  • google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. Empty update mask will result in updating nothing. For the FieldMask definition, 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



717
718
719
720
721
722
723
724
725
726
727
728
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 717

def patch_project_inbound_saml_config(name, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  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

#patch_project_oauth_idp_config(name, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Update an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome- project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.

  • google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. Empty update mask will result in updating nothing. For the FieldMask definition, 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



891
892
893
894
895
896
897
898
899
900
901
902
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 891

def patch_project_oauth_idp_config(name, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  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

#patch_project_tenant(name, google_cloud_identitytoolkit_admin_v2_tenant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant

Update a tenant. Requires write permission on the Tenant resource.

Parameters:

  • name (String)

    Output only. Resource name of a tenant. For example: "projects/project-id/ tenants/tenant-id"

  • google_cloud_identitytoolkit_admin_v2_tenant_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    If provided, only update fields set in the update mask. Otherwise, all settable fields will be updated. For the FieldMask definition, 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



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1101

def patch_project_tenant(name, google_cloud_identitytoolkit_admin_v2_tenant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_tenant_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant
  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

#patch_project_tenant_default_supported_idp_config(name, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig

Update a default supported Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the DefaultSupportedIdpConfig resource, for example: "projects/my- awesome-project/defaultSupportedIdpConfigs/google.com"

  • google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. For the FieldMask definition, 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



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1349

def patch_project_tenant_default_supported_idp_config(name, google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_default_supported_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
  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

#patch_project_tenant_inbound_saml_config(name, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig

Update an inbound SAML configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the InboundSamlConfig resource, for example: 'projects/my-awesome- project/inboundSamlConfigs/my-config-id'. Ignored during create requests.

  • google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. Empty update mask will result in updating nothing. For the FieldMask definition, 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



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1523

def patch_project_tenant_inbound_saml_config(name, google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_inbound_saml_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
  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

#patch_project_tenant_oauth_idp_config(name, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Update an Oidc Idp configuration for an Identity Toolkit project.

Parameters:

  • name (String)

    The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome- project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.

  • google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. Empty update mask will result in updating nothing. For the FieldMask definition, 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



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1697

def patch_project_tenant_oauth_idp_config(name, google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_o_auth_idp_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
  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

#revoke_account_token(google_cloud_identitytoolkit_v2_revoke_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RevokeTokenResponse

Revokes a user's token from an Identity Provider (IdP). This is done by manually providing an IdP credential, and the token types for revocation. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v2_revoke_token_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RevokeTokenRequest) (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



77
78
79
80
81
82
83
84
85
86
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 77

def (google_cloud_identitytoolkit_v2_revoke_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts:revokeToken', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RevokeTokenRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v2_revoke_token_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RevokeTokenResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RevokeTokenResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_tenant_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy

Sets the access control policy for a resource. If the policy exists, it is replaced. Caller must have the right Google IAM permission on the resource.

Parameters:

  • resource (String)

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

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::IdentitytoolkitV2::GoogleIamV1SetIamPolicyRequest) (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



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1138

def set_project_tenant_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleIamV1Policy
  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

#start_account_mfa_enrollment(google_cloud_identitytoolkit_v2_start_mfa_enrollment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse

Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.

Parameters:

  • google_cloud_identitytoolkit_v2_start_mfa_enrollment_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest) (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



138
139
140
141
142
143
144
145
146
147
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 138

def (google_cloud_identitytoolkit_v2_start_mfa_enrollment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts/mfaEnrollment:start', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v2_start_mfa_enrollment_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_account_mfa_sign_in(google_cloud_identitytoolkit_v2_start_mfa_sign_in_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInResponse

Sends the MFA challenge

Parameters:

  • google_cloud_identitytoolkit_v2_start_mfa_sign_in_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInRequest) (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



228
229
230
231
232
233
234
235
236
237
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 228

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts/mfaSignIn:start', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2StartMfaSignInResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_tenant_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleIamV1TestIamPermissionsResponse

Returns the caller's permissions on a resource. An error is returned if the resource does not exist. A caller is not required to have Google IAM permission to make this request.

Parameters:

  • resource (String)

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

  • google_iam_v1_test_iam_permissions_request_object (Google::Apis::IdentitytoolkitV2::GoogleIamV1TestIamPermissionsRequest) (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



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 1175

def test_project_tenant_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1_test_iam_permissions_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleIamV1TestIamPermissionsResponse
  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_project_config(name, google_cloud_identitytoolkit_admin_v2_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config

Update an Identity Toolkit project configuration.

Parameters:

  • name (String)

    Output only. The name of the Config resource. Example: "projects/my-awesome- project/config"

  • google_cloud_identitytoolkit_admin_v2_config_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. Fields set in the config but not included in this update mask will be ignored. For the FieldMask definition, 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



330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 330

def update_project_config(name, google_cloud_identitytoolkit_admin_v2_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config::Representation
  command.request_object = google_cloud_identitytoolkit_admin_v2_config_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Config
  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

#withdraw_account_mfa_enrollment(google_cloud_identitytoolkit_v2_withdraw_mfa_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2WithdrawMfaResponse

Revokes one second factor from the enrolled second factors for an account.

Parameters:

  • google_cloud_identitytoolkit_v2_withdraw_mfa_request_object (Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2WithdrawMfaRequest) (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



168
169
170
171
172
173
174
175
176
177
# File 'lib/google/apis/identitytoolkit_v2/service.rb', line 168

def (google_cloud_identitytoolkit_v2_withdraw_mfa_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/accounts/mfaEnrollment:withdraw', options)
  command.request_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2WithdrawMfaRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v2_withdraw_mfa_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2WithdrawMfaResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2WithdrawMfaResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end