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

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

Overview

JSON template for User object in Directory API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ User

Returns a new instance of User.



3389
3390
3391
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3389

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

Instance Attribute Details

#addresses ⇒ Object

Corresponds to the JSON property addresses

Returns:

  • (Object) 


3150
3151
3152
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3150

def addresses
  @addresses
end

#agreed_to_terms ⇒ Boolean Also known as: agreed_to_terms?

Indicates if user has agreed to terms (Read-only) Corresponds to the JSON property agreedToTerms

Returns:

  • (Boolean) 


3155
3156
3157
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3155

def agreed_to_terms
  @agreed_to_terms
end

#aliases ⇒ Array<String>

List of aliases (Read-only) Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


3161
3162
3163
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3161

def aliases
  @aliases
end

#archived ⇒ Boolean Also known as: archived?

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

Returns:

  • (Boolean) 


3166
3167
3168
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3166

def archived
  @archived
end

#change_password_at_next_login ⇒ Boolean Also known as: change_password_at_next_login?

Boolean indicating if the user should change password in next login Corresponds to the JSON property changePasswordAtNextLogin

Returns:

  • (Boolean) 


3172
3173
3174
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3172

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) 


3178
3179
3180
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3178

def creation_time
  @creation_time
end

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

Custom fields of the user. Corresponds to the JSON property customSchemas

Returns:

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


3183
3184
3185
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3183

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

CustomerId of User (Read-only) Corresponds to the JSON property customerId

Returns:

  • (String) 


3188
3189
3190
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3188

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


3193
3194
3195
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3193

def deletion_time
  @deletion_time
end

#emails ⇒ Object

Corresponds to the JSON property emails

Returns:

  • (Object) 


3198
3199
3200
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3198

def emails
  @emails
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


3203
3204
3205
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3203

def etag
  @etag
end

#external_ids ⇒ Object

Corresponds to the JSON property externalIds

Returns:

  • (Object) 


3208
3209
3210
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3208

def external_ids
  @external_ids
end

#gender ⇒ Object

Corresponds to the JSON property gender

Returns:

  • (Object) 


3213
3214
3215
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3213

def gender
  @gender
end

#hash_function ⇒ String

Hash function name for password. Supported are MD5, SHA-1 and crypt Corresponds to the JSON property hashFunction

Returns:

  • (String) 


3218
3219
3220
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3218

def hash_function
  @hash_function
end

#id ⇒ String

Unique identifier of User (Read-only) Corresponds to the JSON property id

Returns:

  • (String) 


3223
3224
3225
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3223

def id
  @id
end

#ims ⇒ Object

Corresponds to the JSON property ims

Returns:

  • (Object) 


3228
3229
3230
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3228

def ims
  @ims
end

#include_in_global_address_list ⇒ Boolean Also known as: include_in_global_address_list?

Boolean indicating if user is included in Global Address List Corresponds to the JSON property includeInGlobalAddressList

Returns:

  • (Boolean) 


3233
3234
3235
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3233

def include_in_global_address_list
  @include_in_global_address_list
end

#ip_whitelisted ⇒ Boolean Also known as: ip_whitelisted?

Boolean indicating if ip is whitelisted Corresponds to the JSON property ipWhitelisted

Returns:

  • (Boolean) 


3239
3240
3241
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3239

def ip_whitelisted
  @ip_whitelisted
end

#is_admin ⇒ Boolean Also known as: is_admin?

Boolean indicating if the user is admin (Read-only) Corresponds to the JSON property isAdmin

Returns:

  • (Boolean) 


3245
3246
3247
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3245

def is_admin
  @is_admin
end

#is_delegated_admin ⇒ Boolean Also known as: is_delegated_admin?

Boolean indicating if the user is delegated admin (Read-only) Corresponds to the JSON property isDelegatedAdmin

Returns:

  • (Boolean) 


3251
3252
3253
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3251

def is_delegated_admin
  @is_delegated_admin
end

#is_enforced_in2_sv ⇒ Boolean Also known as: is_enforced_in2_sv?

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

Returns:

  • (Boolean) 


3257
3258
3259
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3257

def is_enforced_in2_sv
  @is_enforced_in2_sv
end

#is_enrolled_in2_sv ⇒ Boolean Also known as: is_enrolled_in2_sv?

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

Returns:

  • (Boolean) 


3263
3264
3265
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3263

def is_enrolled_in2_sv
  @is_enrolled_in2_sv
end

#is_mailbox_setup ⇒ Boolean Also known as: is_mailbox_setup?

Is mailbox setup (Read-only) Corresponds to the JSON property isMailboxSetup

Returns:

  • (Boolean) 


3269
3270
3271
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3269

def is_mailbox_setup
  @is_mailbox_setup
end

#keywords ⇒ Object

Corresponds to the JSON property keywords

Returns:

  • (Object) 


3275
3276
3277
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3275

def keywords
  @keywords
end

#kind ⇒ String

Kind of resource this is. Corresponds to the JSON property kind

Returns:

  • (String) 


3280
3281
3282
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3280

def kind
  @kind
end

#languages ⇒ Object

Corresponds to the JSON property languages

Returns:

  • (Object) 


3285
3286
3287
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3285

def languages
  @languages
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


3290
3291
3292
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3290

def 
  @last_login_time
end

#locations ⇒ Object

Corresponds to the JSON property locations

Returns:

  • (Object) 


3295
3296
3297
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3295

def locations
  @locations
end

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

JSON template for name of a user in Directory API. Corresponds to the JSON property name

Returns:



3300
3301
3302
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3300

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

List of non editable aliases (Read-only) Corresponds to the JSON property nonEditableAliases

Returns:

  • (Array<String>) 


3305
3306
3307
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3305

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Corresponds to the JSON property notes

Returns:

  • (Object) 


3310
3311
3312
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3310

def notes
  @notes
end

#org_unit_path ⇒ String

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


3315
3316
3317
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3315

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

Corresponds to the JSON property organizations

Returns:

  • (Object) 


3320
3321
3322
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3320

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


3325
3326
3327
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3325

def password
  @password
end

#phones ⇒ Object

Corresponds to the JSON property phones

Returns:

  • (Object) 


3330
3331
3332
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3330

def phones
  @phones
end

#posix_accounts ⇒ Object

Corresponds to the JSON property posixAccounts

Returns:

  • (Object) 


3335
3336
3337
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3335

def posix_accounts
  @posix_accounts
end

#primary_email ⇒ String

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


3340
3341
3342
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3340

def primary_email
  @primary_email
end

#recovery_email ⇒ String

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

Returns:

  • (String) 


3345
3346
3347
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3345

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) 


3351
3352
3353
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3351

def recovery_phone
  @recovery_phone
end

#relations ⇒ Object

Corresponds to the JSON property relations

Returns:

  • (Object) 


3356
3357
3358
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3356

def relations
  @relations
end

#ssh_public_keys ⇒ Object

Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object) 


3361
3362
3363
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3361

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) 


3366
3367
3368
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3366

def suspended
  @suspended
end

#suspension_reason ⇒ String

Suspension reason if user is suspended (Read-only) Corresponds to the JSON property suspensionReason

Returns:

  • (String) 


3372
3373
3374
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3372

def suspension_reason
  @suspension_reason
end

#thumbnail_photo_etag ⇒ String

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

Returns:

  • (String) 


3377
3378
3379
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3377

def thumbnail_photo_etag
  @thumbnail_photo_etag
end

#thumbnail_photo_url ⇒ String

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

Returns:

  • (String) 


3382
3383
3384
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3382

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

Corresponds to the JSON property websites

Returns:

  • (Object) 


3387
3388
3389
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3387

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3394

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