Class: Google::Apis::AdminDirectoryV1::User

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

Overview

The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the User Accounts Developer's Guide and the User Aliases Developer's Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ User

Returns a new instance of User.



4932
4933
4934
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4932

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

Instance Attribute Details

#addresses ⇒ Object

The list of the user's addresses. The maximum allowed data size for this field is 10KB. Corresponds to the JSON property addresses

Returns:

  • (Object) 


4614
4615
4616
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4614

def addresses
  @addresses
end

#agreed_to_terms ⇒ Boolean Also known as: agreed_to_terms?

Output only. This property is true if the user has completed an initial login and accepted the Terms of Service agreement. Corresponds to the JSON property agreedToTerms

Returns:

  • (Boolean) 


4620
4621
4622
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4620

def agreed_to_terms
  @agreed_to_terms
end

#aliases ⇒ Array<String>

Output only. The list of the user's alias email addresses. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


4626
4627
4628
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4626

def aliases
  @aliases
end

#archival_time ⇒ String

Output only. User's account archival time. (Read-only) Corresponds to the JSON property archivalTime

Returns:

  • (String) 


4631
4632
4633
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4631

def archival_time
  @archival_time
end

#archived ⇒ Boolean Also known as: archived?

Indicates if user is archived. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


4636
4637
4638
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4636

def archived
  @archived
end

#change_password_at_next_login ⇒ Boolean Also known as: change_password_at_next_login?

Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider. Corresponds to the JSON property changePasswordAtNextLogin

Returns:

  • (Boolean) 


4644
4645
4646
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4644

def 
  @change_password_at_next_login
end

#creation_time ⇒ DateTime

User's G Suite account creation time. (Read-only) Corresponds to the JSON property creationTime

Returns:

  • (DateTime) 


4650
4651
4652
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4650

def creation_time
  @creation_time
end

#custom_schemas ⇒ Hash<String,Hash<String,Object>>

Custom fields of the user. The key is a schema_name and its values are ' field_name': 'field_value'. Corresponds to the JSON property customSchemas

Returns:

  • (Hash<String,Hash<String,Object>>) 


4656
4657
4658
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4656

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

Output only. The customer ID to retrieve all account users. You can use the alias my_customer to represent your account' s customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request. Corresponds to the JSON property customerId

Returns:

  • (String) 


4667
4668
4669
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4667

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


4672
4673
4674
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4672

def deletion_time
  @deletion_time
end

#emails ⇒ Object

The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes publicKeyEncryptionCertificates. Corresponds to the JSON property emails

Returns:

  • (Object) 


4678
4679
4680
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4678

def emails
  @emails
end

#etag ⇒ String

Output only. ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


4683
4684
4685
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4683

def etag
  @etag
end

#external_ids ⇒ Object

The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB. Corresponds to the JSON property externalIds

Returns:

  • (Object) 


4689
4690
4691
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4689

def external_ids
  @external_ids
end

#gender ⇒ Object

The user's gender. The maximum allowed data size for this field is 1KB. Corresponds to the JSON property gender

Returns:

  • (Object) 


4694
4695
4696
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4694

def gender
  @gender
end

#guest_account_info ⇒ Google::Apis::AdminDirectoryV1::GuestAccountInfo

Account info specific to Guest users. Corresponds to the JSON property guestAccountInfo

Returns:



4699
4700
4701
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4699

def 
  @guest_account_info
end

#hash_function ⇒ String

Stores the hash format of the password property. The following hashFunction values are allowed: * MD5 - Accepts simple hex-encoded values. * SHA-1 - Accepts simple hex-encoded values. * crypt - Compliant with the C crypt library. Supports the DES, MD5 ( hash prefix $1$), SHA-256 (hash prefix $5$), and SHA-512 (hash prefix $6$ ) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer. Corresponds to the JSON property hashFunction

Returns:

  • (String) 


4710
4711
4712
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4710

def hash_function
  @hash_function
end

#id ⇒ String

The unique ID for the user. A user id can be used as a user request URI's userKey. Corresponds to the JSON property id

Returns:

  • (String) 


4716
4717
4718
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4716

def id
  @id
end

#ims ⇒ Object

The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB. Corresponds to the JSON property ims

Returns:

  • (Object) 


4723
4724
4725
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4723

def ims
  @ims
end

#include_in_global_address_list ⇒ Boolean Also known as: include_in_global_address_list?

Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center. Corresponds to the JSON property includeInGlobalAddressList

Returns:

  • (Boolean) 


4731
4732
4733
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4731

def include_in_global_address_list
  @include_in_global_address_list
end

#ip_whitelisted ⇒ Boolean Also known as: ip_whitelisted?

If true, the user's IP address is subject to a deprecated IP address allowlist configuration. Corresponds to the JSON property ipWhitelisted

Returns:

  • (Boolean) 


4738
4739
4740
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4738

def ip_whitelisted
  @ip_whitelisted
end

#is_admin ⇒ Boolean Also known as: is_admin?

Output only. Indicates a user with super administrator privileges. The isAdmin property can only be edited in the Make a user an administrator operation ( makeAdmin method). If edited in the user insert or update methods, the edit is ignored by the API service. Corresponds to the JSON property isAdmin

Returns:

  • (Boolean) 


4752
4753
4754
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4752

def is_admin
  @is_admin
end

#is_delegated_admin ⇒ Boolean Also known as: is_delegated_admin?

Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console. Corresponds to the JSON property isDelegatedAdmin

Returns:

  • (Boolean) 


4762
4763
4764
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4762

def is_delegated_admin
  @is_delegated_admin
end

#is_enforced_in2_sv ⇒ Boolean Also known as: is_enforced_in2_sv?

Output only. Is 2-step verification enforced (Read-only) Corresponds to the JSON property isEnforcedIn2Sv

Returns:

  • (Boolean) 


4768
4769
4770
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4768

def is_enforced_in2_sv
  @is_enforced_in2_sv
end

#is_enrolled_in2_sv ⇒ Boolean Also known as: is_enrolled_in2_sv?

Output only. Is enrolled in 2-step verification (Read-only) Corresponds to the JSON property isEnrolledIn2Sv

Returns:

  • (Boolean) 


4774
4775
4776
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4774

def is_enrolled_in2_sv
  @is_enrolled_in2_sv
end

#is_guest_user ⇒ Boolean Also known as: is_guest_user?

Immutable. Indicates if the inserted user is a guest. Corresponds to the JSON property isGuestUser

Returns:

  • (Boolean) 


4780
4781
4782
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4780

def is_guest_user
  @is_guest_user
end

#is_mailbox_setup ⇒ Boolean Also known as: is_mailbox_setup?

Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. Corresponds to the JSON property isMailboxSetup

Returns:

  • (Boolean) 


4787
4788
4789
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4787

def is_mailbox_setup
  @is_mailbox_setup
end

#keywords ⇒ Object

The list of the user's keywords. The maximum allowed data size for this field is 1KB. Corresponds to the JSON property keywords

Returns:

  • (Object) 


4794
4795
4796
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4794

def keywords
  @keywords
end

#kind ⇒ String

Output only. The type of the API resource. For Users resources, the value is admin#directory#user. Corresponds to the JSON property kind

Returns:

  • (String) 


4800
4801
4802
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4800

def kind
  @kind
end

#languages ⇒ Object

The user's languages. The maximum allowed data size for this field is 1KB. Corresponds to the JSON property languages

Returns:

  • (Object) 


4805
4806
4807
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4805

def languages
  @languages
end

#last_login_time ⇒ DateTime

User's last login time. (Read-only) Corresponds to the JSON property lastLoginTime

Returns:

  • (DateTime) 


4810
4811
4812
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4810

def 
  @last_login_time
end

#locations ⇒ Object

The user's locations. The maximum allowed data size for this field is 10KB. Corresponds to the JSON property locations

Returns:

  • (Object) 


4815
4816
4817
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4815

def locations
  @locations
end

#name ⇒ Google::Apis::AdminDirectoryV1::UserName

Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the administration help center. Maximum allowed data size for this field is 1KB. Corresponds to the JSON property name

Returns:



4826
4827
4828
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4826

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. Corresponds to the JSON property nonEditableAliases

Returns:

  • (Array<String>) 


4832
4833
4834
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4832

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Notes for the user. Corresponds to the JSON property notes

Returns:

  • (Object) 


4837
4838
4839
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4837

def notes
  @notes
end

#org_unit_path ⇒ String

The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/ ). Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


4844
4845
4846
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4844

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB. Corresponds to the JSON property organizations

Returns:

  • (Object) 


4850
4851
4852
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4850

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


4855
4856
4857
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4855

def password
  @password
end

#phones ⇒ Object

The list of the user's phone numbers. The maximum allowed data size for this field is 1KB. Corresponds to the JSON property phones

Returns:

  • (Object) 


4861
4862
4863
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4861

def phones
  @phones
end

#posix_accounts ⇒ Object

The list of POSIX account information for the user. Corresponds to the JSON property posixAccounts

Returns:

  • (Object) 


4867
4868
4869
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4867

def posix_accounts
  @posix_accounts
end

#primary_email ⇒ String

The user's primary email address. This property is required in a request to create a user account. The primaryEmail must be unique and cannot be an alias of another user. Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


4874
4875
4876
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4874

def primary_email
  @primary_email
end

#recovery_email ⇒ String

Recovery email of the user. Corresponds to the JSON property recoveryEmail

Returns:

  • (String) 


4879
4880
4881
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4879

def recovery_email
  @recovery_email
end

#recovery_phone ⇒ String

Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212. Corresponds to the JSON property recoveryPhone

Returns:

  • (String) 


4885
4886
4887
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4885

def recovery_phone
  @recovery_phone
end

#relations ⇒ Object

The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB. Corresponds to the JSON property relations

Returns:

  • (Object) 


4891
4892
4893
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4891

def relations
  @relations
end

#ssh_public_keys ⇒ Object

A list of SSH public keys. Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object) 


4896
4897
4898
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4896

def ssh_public_keys
  @ssh_public_keys
end

#suspended ⇒ Boolean Also known as: suspended?

Indicates if user is suspended. Corresponds to the JSON property suspended

Returns:

  • (Boolean) 


4901
4902
4903
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4901

def suspended
  @suspended
end

#suspension_reason ⇒ String

Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true. Corresponds to the JSON property suspensionReason

Returns:

  • (String) 


4909
4910
4911
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4909

def suspension_reason
  @suspension_reason
end

#suspension_time ⇒ String

Output only. User's account suspension time. (Read-only) Corresponds to the JSON property suspensionTime

Returns:

  • (String) 


4914
4915
4916
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4914

def suspension_time
  @suspension_time
end

#thumbnail_photo_etag ⇒ String

Output only. ETag of the user's photo (Read-only) Corresponds to the JSON property thumbnailPhotoEtag

Returns:

  • (String) 


4919
4920
4921
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4919

def thumbnail_photo_etag
  @thumbnail_photo_etag
end

#thumbnail_photo_url ⇒ String

Output only. The URL of the user's profile photo. The URL might be temporary or private. Corresponds to the JSON property thumbnailPhotoUrl

Returns:

  • (String) 


4925
4926
4927
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4925

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

The user's websites. The maximum allowed data size for this field is 2KB. Corresponds to the JSON property websites

Returns:

  • (Object) 


4930
4931
4932
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4930

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4937

def update!(**args)
  @addresses = args[:addresses] if args.key?(:addresses)
  @agreed_to_terms = args[:agreed_to_terms] if args.key?(:agreed_to_terms)
  @aliases = args[:aliases] if args.key?(:aliases)
  @archival_time = args[:archival_time] if args.key?(:archival_time)
  @archived = args[:archived] if args.key?(:archived)
  @change_password_at_next_login = args[:change_password_at_next_login] if args.key?(:change_password_at_next_login)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @custom_schemas = args[:custom_schemas] if args.key?(:custom_schemas)
  @customer_id = args[:customer_id] if args.key?(:customer_id)
  @deletion_time = args[:deletion_time] if args.key?(:deletion_time)
  @emails = args[:emails] if args.key?(:emails)
  @etag = args[:etag] if args.key?(:etag)
  @external_ids = args[:external_ids] if args.key?(:external_ids)
  @gender = args[:gender] if args.key?(:gender)
  @guest_account_info = args[:guest_account_info] if args.key?(:guest_account_info)
  @hash_function = args[:hash_function] if args.key?(:hash_function)
  @id = args[:id] if args.key?(:id)
  @ims = args[:ims] if args.key?(:ims)
  @include_in_global_address_list = args[:include_in_global_address_list] if args.key?(:include_in_global_address_list)
  @ip_whitelisted = args[:ip_whitelisted] if args.key?(:ip_whitelisted)
  @is_admin = args[:is_admin] if args.key?(:is_admin)
  @is_delegated_admin = args[:is_delegated_admin] if args.key?(:is_delegated_admin)
  @is_enforced_in2_sv = args[:is_enforced_in2_sv] if args.key?(:is_enforced_in2_sv)
  @is_enrolled_in2_sv = args[:is_enrolled_in2_sv] if args.key?(:is_enrolled_in2_sv)
  @is_guest_user = args[:is_guest_user] if args.key?(:is_guest_user)
  @is_mailbox_setup = args[:is_mailbox_setup] if args.key?(:is_mailbox_setup)
  @keywords = args[:keywords] if args.key?(:keywords)
  @kind = args[:kind] if args.key?(:kind)
  @languages = args[:languages] if args.key?(:languages)
  @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
  @locations = args[:locations] if args.key?(:locations)
  @name = args[:name] if args.key?(:name)
  @non_editable_aliases = args[:non_editable_aliases] if args.key?(:non_editable_aliases)
  @notes = args[:notes] if args.key?(:notes)
  @org_unit_path = args[:org_unit_path] if args.key?(:org_unit_path)
  @organizations = args[:organizations] if args.key?(:organizations)
  @password = args[:password] if args.key?(:password)
  @phones = args[:phones] if args.key?(:phones)
  @posix_accounts = args[:posix_accounts] if args.key?(:posix_accounts)
  @primary_email = args[:primary_email] if args.key?(:primary_email)
  @recovery_email = args[:recovery_email] if args.key?(:recovery_email)
  @recovery_phone = args[:recovery_phone] if args.key?(:recovery_phone)
  @relations = args[:relations] if args.key?(:relations)
  @ssh_public_keys = args[:ssh_public_keys] if args.key?(:ssh_public_keys)
  @suspended = args[:suspended] if args.key?(:suspended)
  @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
  @suspension_time = args[:suspension_time] if args.key?(:suspension_time)
  @thumbnail_photo_etag = args[:thumbnail_photo_etag] if args.key?(:thumbnail_photo_etag)
  @thumbnail_photo_url = args[:thumbnail_photo_url] if args.key?(:thumbnail_photo_url)
  @websites = args[:websites] if args.key?(:websites)
end