Class: Google::Apis::IdentitytoolkitV1::IdentityToolkitService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/identitytoolkit_v1/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_v1'

Identitytoolkit = Google::Apis::IdentitytoolkitV1 # 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

#initialize ⇒ IdentityToolkitService

Returns a new instance of IdentityToolkitService.



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

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

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

#accounts_project(target_project_id, google_cloud_identitytoolkit_v1_sign_up_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse

Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper permissions, creates a new anonymous, email and password, or phone number user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • target_project_id (String) —

    The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. If this is not set, the target project is inferred from the scope associated to the Bearer access token.

  • google_cloud_identitytoolkit_v1_sign_up_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest) (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



640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 640

def accounts_project(target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#accounts_project_tenant(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_sign_up_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse

Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper permissions, creates a new anonymous, email and password, or phone number user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • target_project_id (String) —

    The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. If this is not set, the target project is inferred from the scope associated to the Bearer access token.

  • tenant_id (String) —

    The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project.

  • google_cloud_identitytoolkit_v1_sign_up_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest) (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



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

def accounts_project_tenant(target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#batch_project_account_create(target_project_id, google_cloud_identitytoolkit_v1_upload_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse

Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper permissions.

Parameters:

  • target_project_id (String) —

    The Project ID of the Identity Platform project which the account belongs to.

  • google_cloud_identitytoolkit_v1_upload_account_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountRequest) (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



745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 745

def (target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:batchCreate', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#batch_project_account_delete(target_project_id, google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse

Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2. 0 credential with proper permissions.

Parameters:

  • target_project_id (String) —

    If tenant_id is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.

  • google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest) (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



784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 784

def (target_project_id, google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:batchDelete', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#batch_project_account_get(target_project_id, delegated_project_number: nil, max_results: nil, next_page_token: nil, tenant_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse

Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper permissions.. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.

Parameters:

  • target_project_id (String) —

    If tenant_id is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.

  • delegated_project_number (Fixnum) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil) —

    The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.

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

    The pagination token from the response of a previous request.

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

    The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.

  • 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



831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 831

def (target_project_id, delegated_project_number: nil, max_results: nil, next_page_token: nil, tenant_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{+targetProjectId}/accounts:batchGet', options)
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['nextPageToken'] = next_page_token unless next_page_token.nil?
  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

#batch_project_tenant_account_create(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_upload_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse

Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper permissions.

Parameters:

  • target_project_id (String) —

    The Project ID of the Identity Platform project which the account belongs to.

  • tenant_id (String) —

    The ID of the Identity Platform tenant the account belongs to.

  • google_cloud_identitytoolkit_v1_upload_account_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountRequest) (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



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

def (target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchCreate', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#batch_project_tenant_account_delete(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse

Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2. 0 credential with proper permissions.

Parameters:

  • target_project_id (String) —

    If tenant_id is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.

  • tenant_id (String) —

    If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to a default Identity Platform project, the field is not needed.

  • google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest) (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



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1181

def (target_project_id, tenant_id, google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchDelete', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_batch_delete_accounts_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#batch_project_tenant_account_get(target_project_id, tenant_id, delegated_project_number: nil, max_results: nil, next_page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse

Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper permissions.. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.

Parameters:

  • target_project_id (String) —

    If tenant_id is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.

  • tenant_id (String) —

    The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.

  • delegated_project_number (Fixnum) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil) —

    The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.

  • next_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



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1229

def (target_project_id, tenant_id, delegated_project_number: nil, max_results: nil, next_page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchGet', options)
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DownloadAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['tenantId'] = tenant_id unless tenant_id.nil?
  command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['nextPageToken'] = next_page_token unless next_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

#create_account_auth_uri(google_cloud_identitytoolkit_v1_create_auth_uri_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriResponse

If an email identifier is specified, checks and returns if any user account is registered with the email. If there is a registered account, fetches all providers associated with the account's email. If the provider ID of an Identity Provider (IdP) is specified, creates an authorization URI for the IdP. The user can be directed to this URI to sign in with the IdP. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_create_auth_uri_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def (google_cloud_identitytoolkit_v1_create_auth_uri_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:createAuthUri', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_create_auth_uri_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriResponse
  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_session_cookie(target_project_id, google_cloud_identitytoolkit_v1_create_session_cookie_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse

Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.

Parameters:

  • target_project_id (String) —

    The ID of the project that the account belongs to.

  • google_cloud_identitytoolkit_v1_create_session_cookie_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest) (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



674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 674

def create_project_session_cookie(target_project_id, google_cloud_identitytoolkit_v1_create_session_cookie_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}:createSessionCookie', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_create_session_cookie_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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_session_cookie(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_create_session_cookie_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse

Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.

Parameters:

  • target_project_id (String) —

    The ID of the project that the account belongs to.

  • tenant_id (String) —

    The tenant ID of the Identity Platform tenant the account belongs to.

  • google_cloud_identitytoolkit_v1_create_session_cookie_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest) (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



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1097

def create_project_tenant_session_cookie(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_create_session_cookie_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}:createSessionCookie', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_create_session_cookie_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#delete_account(google_cloud_identitytoolkit_v1_delete_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse

Deletes a user's account.

Parameters:

  • google_cloud_identitytoolkit_v1_delete_account_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest) (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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 110

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:delete', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse
  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_account(target_project_id, google_cloud_identitytoolkit_v1_delete_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse

Deletes a user's account.

Parameters:

  • target_project_id (String) —

    The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.

  • google_cloud_identitytoolkit_v1_delete_account_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest) (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



867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 867

def (target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:delete', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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_tenant_account(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_delete_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse

Deletes a user's account.

Parameters:

  • target_project_id (String) —

    The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.

  • tenant_id (String) —

    The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify local_id of an account that belongs to an Identity Platform tenant.

  • google_cloud_identitytoolkit_v1_delete_account_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest) (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



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1270

def (target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:delete', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1DeleteAccountResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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_projects(android_package_name: nil, client_id: nil, delegated_project_number: nil, firebase_app_id: nil, ios_bundle_id: nil, project_number: nil, return_dynamic_link: nil, sha1_cert: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetProjectConfigResponse

Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.

Parameters:

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

    Android package name to check against the real android package name. If this field is provided, and sha1_cert_hash is not provided, the action will throw an error if this does not match the real android package name.

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

    The RP OAuth client ID. If set, a check will be performed to ensure that the OAuth client is valid for the retrieved project and the request rejected with a client error if not valid.

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

    Project Number of the delegated project request. This field should only be used as part of the Firebase V1 migration.

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

    The Firebase app ID, for applications that use Firebase. This can be found in the Firebase console for your project. If set, a check will be performed to ensure that the app ID is valid for the retrieved project. If not valid, the request will be rejected with a client error.

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

    iOS bundle id to check against the real ios bundle id. If this field is provided, the action will throw an error if this does not match the real iOS bundle id.

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

    Project number of the configuration to retrieve. This field is deprecated and should not be used by new integrations.

  • return_dynamic_link (Boolean) (defaults to: nil) —

    Whether dynamic link should be returned.

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

    SHA-1 Android application cert hash. If set, a check will be performed to ensure that the cert hash is valid for the retrieved project and android_package_name.

  • 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



1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1494

def get_projects(android_package_name: nil, client_id: nil, delegated_project_number: nil, firebase_app_id: nil, ios_bundle_id: nil, project_number: nil, return_dynamic_link: nil, sha1_cert: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects', options)
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetProjectConfigResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetProjectConfigResponse
  command.query['androidPackageName'] = android_package_name unless android_package_name.nil?
  command.query['clientId'] = client_id unless client_id.nil?
  command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil?
  command.query['firebaseAppId'] = firebase_app_id unless firebase_app_id.nil?
  command.query['iosBundleId'] = ios_bundle_id unless ios_bundle_id.nil?
  command.query['projectNumber'] = project_number unless project_number.nil?
  command.query['returnDynamicLink'] = return_dynamic_link unless return_dynamic_link.nil?
  command.query['sha1Cert'] = sha1_cert unless sha1_cert.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_public_keys(fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Retrieves public keys of the legacy Identity Toolkit token signer to enable third parties to verify the legacy ID token. For now the X509 pem cert is the only format supported.

Parameters:

  • 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:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

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



1531
1532
1533
1534
1535
1536
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1531

def get_public_keys(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/publicKeys', options)
  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_params(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse

Gets parameters needed for generating a reCAPTCHA challenge.

Parameters:

  • 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



1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1556

def get_recaptcha_params(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/recaptchaParams', options)
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_session_cookie_public_keys(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse

Retrieves the set of public keys of the session cookie JSON Web Token (JWT) signer that can be used to validate the session cookie created through createSessionCookie.

Parameters:

  • 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



1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1585

def get_session_cookie_public_keys(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/sessionCookiePublicKeys', options)
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#issue_account_saml_response(google_cloud_identitytoolkit_v1_issue_saml_response_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse

Experimental

Parameters:

  • google_cloud_identitytoolkit_v1_issue_saml_response_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest) (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



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 140

def (google_cloud_identitytoolkit_v1_issue_saml_response_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:issueSamlResponse', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_issue_saml_response_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_account(google_cloud_identitytoolkit_v1_get_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse

Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.

Parameters:

  • google_cloud_identitytoolkit_v1_get_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest) (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



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 172

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:lookup', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project_account(target_project_id, google_cloud_identitytoolkit_v1_get_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse

Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.

Parameters:

  • target_project_id (String) —

    The ID of the Google Cloud project that the account or the Identity Platform tenant specified by tenant_id belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper permissions.

  • google_cloud_identitytoolkit_v1_get_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest) (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



905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 905

def (target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:lookup', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#lookup_project_tenant_account(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_get_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse

Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.

Parameters:

  • target_project_id (String) —

    The ID of the Google Cloud project that the account or the Identity Platform tenant specified by tenant_id belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper permissions.

  • tenant_id (String) —

    The ID of the tenant that the account belongs to. Should only be specified by authenticated requests from a developer.

  • google_cloud_identitytoolkit_v1_get_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest) (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



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

def (target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:lookup', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#query_project_account(target_project_id, google_cloud_identitytoolkit_v1_query_user_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse

Looks up user accounts within a project or a tenant based on conditions in the request.

Parameters:

  • target_project_id (String) —

    The ID of the project to which the result is scoped.

  • google_cloud_identitytoolkit_v1_query_user_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest) (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



939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 939

def (target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:query', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#query_project_accounts(target_project_id, google_cloud_identitytoolkit_v1_query_user_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse

Looks up user accounts within a project or a tenant based on conditions in the request.

Parameters:

  • target_project_id (String) —

    The ID of the project to which the result is scoped.

  • google_cloud_identitytoolkit_v1_query_user_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest) (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



708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 708

def query_project_accounts(target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}:queryAccounts', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#query_project_tenant_account(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_query_user_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse

Looks up user accounts within a project or a tenant based on conditions in the request.

Parameters:

  • target_project_id (String) —

    The ID of the project to which the result is scoped.

  • tenant_id (String) —

    The ID of the tenant to which the result is scoped.

  • google_cloud_identitytoolkit_v1_query_user_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest) (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



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

def (target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:query', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#reset_account_password(google_cloud_identitytoolkit_v1_reset_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordResponse

Resets the password of an account either using an out-of-band code generated by sendOobCode or by specifying the email and password of the account to be modified. Can also check the purpose of an out-of-band code without consuming it.

Parameters:

  • google_cloud_identitytoolkit_v1_reset_password_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordRequest) (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



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 205

def (google_cloud_identitytoolkit_v1_reset_password_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:resetPassword', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_reset_password_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_account_oob_code(google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse

Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.

Parameters:

  • google_cloud_identitytoolkit_v1_get_oob_code_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest) (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



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 237

def (google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:sendOobCode', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_get_oob_code_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_account_verification_code(google_cloud_identitytoolkit_v1_send_verification_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse

Sends a SMS verification code for phone number sign-in. To localize the text of the SMS sent to the user, set the HTTP header X-Firebase-Locale to the language code that corresponds with the user's locale. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_send_verification_code_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest) (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



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 271

def (google_cloud_identitytoolkit_v1_send_verification_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:sendVerificationCode', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_send_verification_code_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_project_account_oob_code(target_project_id, google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse

Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.

Parameters:

  • target_project_id (String) —

    The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper permissions.

  • google_cloud_identitytoolkit_v1_get_oob_code_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest) (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



976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 976

def (target_project_id, google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:sendOobCode', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_get_oob_code_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#send_project_tenant_account_oob_code(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse

Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.

Parameters:

  • target_project_id (String) —

    The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper permissions.

  • tenant_id (String) —

    The tenant ID of the Identity Platform tenant the account belongs to.

  • google_cloud_identitytoolkit_v1_get_oob_code_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest) (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



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1389

def (target_project_id, tenant_id, google_cloud_identitytoolkit_v1_get_oob_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:sendOobCode', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_get_oob_code_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#sign_account_in_with_custom_token(google_cloud_identitytoolkit_v1_sign_in_with_custom_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse

Signs in or signs up a user by exchanging a custom Auth token. Upon a successful sign-in or sign-up, a new Identity Platform ID token and refresh token are issued for the user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_custom_token_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest) (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



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 305

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithCustomToken', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_in_with_email_link(google_cloud_identitytoolkit_v1_sign_in_with_email_link_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse

Signs in or signs up a user with a out-of-band code from an email link. If a user does not exist with the given email address, a user record will be created. If the sign-in succeeds, an Identity Platform ID and refresh token are issued for the authenticated user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_email_link_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest) (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



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 340

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithEmailLink', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_in_with_game_center(google_cloud_identitytoolkit_v1_sign_in_with_game_center_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse

Signs in or signs up a user with iOS Game Center credentials. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. The bundle ID is required in the request header as x- ios-bundle-identifier. An API key is required in the request in order to identify the Google Cloud project. Apple has deprecated the playerID field. The Apple platform Firebase SDK will use gamePlayerID and teamPlayerID from version 10.5.0 and onwards. Upgrading to SDK version 10.5.0 or later updates existing integrations that use playerID to instead use gamePlayerID and teamPlayerID. When making calls to signInWithGameCenter, you must include playerID along with the new fields gamePlayerID and teamPlayerID to successfully identify all existing users. Upgrading existing Game Center sign in integrations to SDK version 10.5.0 or later is irreversible.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_game_center_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest) (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



383
384
385
386
387
388
389
390
391
392
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 383

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithGameCenter', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_in_with_idp(google_cloud_identitytoolkit_v1_sign_in_with_idp_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpResponse

Signs in or signs up a user using credentials from an Identity Provider (IdP). This is done by manually providing an IdP credential, or by providing the authorization response obtained via the authorization request from CreateAuthUri. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. A new Identity Platform user account will be created if the user has not previously signed in to the IdP with the same account. In addition, when the "One account per email address" setting is enabled, there should not be an existing Identity Platform user account with the same email address for a new user account to be created. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_idp_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpRequest) (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



423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 423

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithIdp', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_in_with_password(google_cloud_identitytoolkit_v1_sign_in_with_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse

Signs in a user with email and password. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_password_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest) (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



456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 456

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithPassword', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_in_with_phone_number(google_cloud_identitytoolkit_v1_sign_in_with_phone_number_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse

Completes a phone number authentication attempt. If a user already exists with the given phone number, an ID token is minted for that user. Otherwise, a new user is created and associated with the phone number. This method may also be used to link a phone number to an existing user. To localize the text of the SMS sent to the user, set the HTTP header X-Firebase-Locale to the language code that corresponds with the user's locale. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_in_with_phone_number_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest) (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



493
494
495
496
497
498
499
500
501
502
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 493

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signInWithPhoneNumber', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sign_account_up(google_cloud_identitytoolkit_v1_sign_up_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse

Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper permissions, creates a new anonymous, email and password, or phone number user. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_sign_up_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest) (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



529
530
531
532
533
534
535
536
537
538
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 529

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:signUp', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account(google_cloud_identitytoolkit_v1_set_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse

Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.

Parameters:

  • google_cloud_identitytoolkit_v1_set_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest) (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



561
562
563
564
565
566
567
568
569
570
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 561

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:update', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse
  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_account(target_project_id, google_cloud_identitytoolkit_v1_set_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse

Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.

Parameters:

  • target_project_id (String) —

    The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper permissions. Requests from end users should pass an Identity Platform ID token instead.

  • google_cloud_identitytoolkit_v1_set_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest) (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



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1014

def (target_project_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/accounts:update', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_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

#update_project_tenant_account(target_project_id, tenant_id, google_cloud_identitytoolkit_v1_set_account_info_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse

Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.

Parameters:

  • target_project_id (String) —

    The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper permissions. Requests from end users should pass an Identity Platform ID token instead.

  • tenant_id (String) —

    The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.

  • google_cloud_identitytoolkit_v1_set_account_info_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest) (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



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 1432

def (target_project_id, tenant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:update', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoResponse
  command.params['targetProjectId'] = target_project_id unless target_project_id.nil?
  command.params['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

#verify_account_ios_client(google_cloud_identitytoolkit_v1_verify_ios_client_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1VerifyIosClientResponse

Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts: sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as x-ios-bundle-identifier. An API key is required in the request in order to identify the Google Cloud project.

Parameters:

  • google_cloud_identitytoolkit_v1_verify_ios_client_request_object (Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1VerifyIosClientRequest) (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



598
599
600
601
602
603
604
605
606
607
 
# File 'lib/google/apis/identitytoolkit_v1/service.rb', line 598

def (google_cloud_identitytoolkit_v1_verify_ios_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/accounts:verifyIosClient', options)
  command.request_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1VerifyIosClientRequest::Representation
  command.request_object = google_cloud_identitytoolkit_v1_verify_ios_client_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1VerifyIosClientResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1VerifyIosClientResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end