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 Gmail chat 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.



4147
4148
4149
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4147

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

Instance Attribute Details

#addresses ⇒ Object

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

Returns:

  • (Object) 


3855
3856
3857
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3855

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) 


3861
3862
3863
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3861

def agreed_to_terms
  @agreed_to_terms
end

#aliases ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3867
3868
3869
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3867

def aliases
  @aliases
end

#archived ⇒ Boolean Also known as: archived?

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

Returns:

  • (Boolean) 


3872
3873
3874
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3872

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) 


3880
3881
3882
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3880

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) 


3886
3887
3888
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3886

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>>) 


3892
3893
3894
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3892

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) 


3902
3903
3904
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3902

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


3907
3908
3909
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3907

def deletion_time
  @deletion_time
end

#emails ⇒ Object

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

Returns:

  • (Object) 


3913
3914
3915
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3913

def emails
  @emails
end

#etag ⇒ String

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

Returns:

  • (String) 


3918
3919
3920
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3918

def etag
  @etag
end

#external_ids ⇒ Object

A 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) 


3924
3925
3926
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3924

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) 


3929
3930
3931
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3929

def gender
  @gender
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) 


3940
3941
3942
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3940

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) 


3946
3947
3948
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3946

def id
  @id
end

#ims ⇒ Object

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) 


3953
3954
3955
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3953

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) 


3961
3962
3963
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3961

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

Returns:

  • (Boolean) 


3968
3969
3970
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3968

def ip_whitelisted
  @ip_whitelisted
end

#is_admin ⇒ Boolean Also known as: is_admin?

Output only. Indicates a user with super admininistrator 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) 


3980
3981
3982
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3980

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) 


3990
3991
3992
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3990

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) 


3996
3997
3998
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3996

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) 


4002
4003
4004
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4002

def is_enrolled_in2_sv
  @is_enrolled_in2_sv
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) 


4009
4010
4011
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4009

def is_mailbox_setup
  @is_mailbox_setup
end

#keywords ⇒ Object

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

Returns:

  • (Object) 


4015
4016
4017
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4015

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) 


4021
4022
4023
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4021

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) 


4026
4027
4028
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4026

def languages
  @languages
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


4031
4032
4033
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4031

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) 


4036
4037
4038
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4036

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:



4047
4048
4049
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4047

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

Output only. 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>) 


4053
4054
4055
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4053

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Notes for the user. Corresponds to the JSON property notes

Returns:

  • (Object) 


4058
4059
4060
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4058

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) 


4065
4066
4067
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4065

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

A 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) 


4071
4072
4073
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4071

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


4076
4077
4078
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4076

def password
  @password
end

#phones ⇒ Object

A 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) 


4082
4083
4084
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4082

def phones
  @phones
end

#posix_accounts ⇒ Object

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

Returns:

  • (Object) 


4088
4089
4090
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4088

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) 


4095
4096
4097
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4095

def primary_email
  @primary_email
end

#recovery_email ⇒ String

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

Returns:

  • (String) 


4100
4101
4102
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4100

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) 


4106
4107
4108
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4106

def recovery_phone
  @recovery_phone
end

#relations ⇒ Object

A 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) 


4112
4113
4114
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4112

def relations
  @relations
end

#ssh_public_keys ⇒ Object

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

Returns:

  • (Object) 


4117
4118
4119
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4117

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) 


4122
4123
4124
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4122

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) 


4130
4131
4132
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4130

def suspension_reason
  @suspension_reason
end

#thumbnail_photo_etag ⇒ String

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

Returns:

  • (String) 


4135
4136
4137
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4135

def thumbnail_photo_etag
  @thumbnail_photo_etag
end

#thumbnail_photo_url ⇒ String

Output only. Photo Url of the user (Read-only) Corresponds to the JSON property thumbnailPhotoUrl

Returns:

  • (String) 


4140
4141
4142
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4140

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) 


4145
4146
4147
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4145

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4152

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)
  @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)
  @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_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)
  @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