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.



2817
2818
2819
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2817

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) 


2799
2800
2801
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2799

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) 


2805
2806
2807
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2805

def name
  @name
end

#state ⇒ String

State of the UserInvitation. Corresponds to the JSON property state

Returns:

  • (String) 


2810
2811
2812
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2810

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


2815
2816
2817
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2815

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2822
2823
2824
2825
2826
2827
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2822

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