Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetAccountInfoRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/identitytoolkit_v1/classes.rb,
lib/google/apis/identitytoolkit_v1/representations.rb,
lib/google/apis/identitytoolkit_v1/representations.rb

Overview

Request message for GetAccountInfo.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1GetAccountInfoRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1GetAccountInfoRequest.



768
769
770
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 768

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#delegated_project_numberFixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum)


706
707
708
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 706

def delegated_project_number
  @delegated_project_number
end

#emailArray<String>

The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of name@domain.tld. The email should also match the RFC 822 addr-spec production. Should only be specified by authenticated requests from a developer. Corresponds to the JSON property email

Returns:

  • (Array<String>)


715
716
717
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 715

def email
  @email
end

#federated_user_idArray<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1FederatedUserIdentifier>

The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper permissions. Corresponds to the JSON property federatedUserId



723
724
725
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 723

def federated_user_id
  @federated_user_id
end

#id_tokenString

The Identity Platform ID token of the account to fetch. Require to be specified for requests from end users. Corresponds to the JSON property idToken

Returns:

  • (String)


729
730
731
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 729

def id_token
  @id_token
end

#initial_emailArray<String>

The initial email of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of name@domain.tld. The email should also match the RFC 822 addr-spec production. Should only be specified by authenticated requests from a developer. Corresponds to the JSON property initialEmail

Returns:

  • (Array<String>)


738
739
740
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 738

def initial_email
  @initial_email
end

#local_idArray<String>

The ID of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper permissions. Corresponds to the JSON property localId

Returns:

  • (Array<String>)


745
746
747
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 745

def local_id
  @local_id
end

#phone_numberArray<String>

The phone number of one or more accounts to fetch. Should only be specified by authenticated requests from a developer and should be in E.164 format, for example, +15555555555. Corresponds to the JSON property phoneNumber

Returns:

  • (Array<String>)


752
753
754
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 752

def phone_number
  @phone_number
end

#target_project_idString

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. Corresponds to the JSON property targetProjectId

Returns:

  • (String)


760
761
762
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 760

def target_project_id
  @target_project_id
end

#tenant_idString

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

Returns:

  • (String)


766
767
768
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 766

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



773
774
775
776
777
778
779
780
781
782
783
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 773

def update!(**args)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @email = args[:email] if args.key?(:email)
  @federated_user_id = args[:federated_user_id] if args.key?(:federated_user_id)
  @id_token = args[:id_token] if args.key?(:id_token)
  @initial_email = args[:initial_email] if args.key?(:initial_email)
  @local_id = args[:local_id] if args.key?(:local_id)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end