Class: Google::Apis::CloudidentityV1::UserInvitation

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

Overview

The UserInvitation resource represents an email that can be sent to an unmanaged user account inviting them to join the customer's Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the UserInvitation, the user account will become managed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserInvitation

Returns a new instance of UserInvitation.



2853
2854
2855
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2853

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

Instance Attribute Details

#mails_sent_count ⇒ Fixnum

Number of invitation emails sent to the user. Corresponds to the JSON property mailsSentCount

Returns:

  • (Fixnum) 


2835
2836
2837
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2835

def mails_sent_count
  @mails_sent_count
end

#name ⇒ String

Shall be of the form customers/customer/userinvitations/user_email_address . Corresponds to the JSON property name

Returns:

  • (String) 


2841
2842
2843
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2841

def name
  @name
end

#state ⇒ String

State of the UserInvitation. Corresponds to the JSON property state

Returns:

  • (String) 


2846
2847
2848
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2846

def state
  @state
end

#update_time ⇒ String

Time when the UserInvitation was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2851
2852
2853
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2851

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2858
2859
2860
2861
2862
2863
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2858

def update!(**args)
  @mails_sent_count = args[:mails_sent_count] if args.key?(:mails_sent_count)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end