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



2560
2561
2562
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2560

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

Instance Attribute Details

#addresses ⇒ Object

Corresponds to the JSON property addresses

Returns:

  • (Object) 


2338
2339
2340
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2338

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) 


2343
2344
2345
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2343

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


2349
2350
2351
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2349

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


2354
2355
2356
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2354

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) 


2360
2361
2362
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2360

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


2365
2366
2367
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2365

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

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

Returns:

  • (String) 


2370
2371
2372
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2370

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


2375
2376
2377
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2375

def deletion_time
  @deletion_time
end

#emails ⇒ Object

Corresponds to the JSON property emails

Returns:

  • (Object) 


2380
2381
2382
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2380

def emails
  @emails
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2385
2386
2387
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2385

def etag
  @etag
end

#external_ids ⇒ Object

Corresponds to the JSON property externalIds

Returns:

  • (Object) 


2390
2391
2392
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2390

def external_ids
  @external_ids
end

#gender ⇒ Object

Corresponds to the JSON property gender

Returns:

  • (Object) 


2395
2396
2397
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2395

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) 


2400
2401
2402
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2400

def hash_function
  @hash_function
end

#id ⇒ String

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

Returns:

  • (String) 


2405
2406
2407
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2405

def id
  @id
end

#ims ⇒ Object

Corresponds to the JSON property ims

Returns:

  • (Object) 


2410
2411
2412
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2410

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) 


2415
2416
2417
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2415

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) 


2421
2422
2423
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2421

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) 


2427
2428
2429
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2427

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) 


2433
2434
2435
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2433

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) 


2439
2440
2441
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2439

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) 


2445
2446
2447
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2445

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) 


2451
2452
2453
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2451

def is_mailbox_setup
  @is_mailbox_setup
end

#keywords ⇒ Object

Corresponds to the JSON property keywords

Returns:

  • (Object) 


2457
2458
2459
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2457

def keywords
  @keywords
end

#kind ⇒ String

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

Returns:

  • (String) 


2462
2463
2464
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2462

def kind
  @kind
end

#languages ⇒ Object

Corresponds to the JSON property languages

Returns:

  • (Object) 


2467
2468
2469
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2467

def languages
  @languages
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


2472
2473
2474
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2472

def 
  @last_login_time
end

#locations ⇒ Object

Corresponds to the JSON property locations

Returns:

  • (Object) 


2477
2478
2479
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2477

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:



2482
2483
2484
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2482

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


2487
2488
2489
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2487

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Corresponds to the JSON property notes

Returns:

  • (Object) 


2492
2493
2494
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2492

def notes
  @notes
end

#org_unit_path ⇒ String

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


2497
2498
2499
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2497

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

Corresponds to the JSON property organizations

Returns:

  • (Object) 


2502
2503
2504
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2502

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


2507
2508
2509
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2507

def password
  @password
end

#phones ⇒ Object

Corresponds to the JSON property phones

Returns:

  • (Object) 


2512
2513
2514
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2512

def phones
  @phones
end

#posix_accounts ⇒ Object

Corresponds to the JSON property posixAccounts

Returns:

  • (Object) 


2517
2518
2519
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2517

def posix_accounts
  @posix_accounts
end

#primary_email ⇒ String

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


2522
2523
2524
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2522

def primary_email
  @primary_email
end

#relations ⇒ Object

Corresponds to the JSON property relations

Returns:

  • (Object) 


2527
2528
2529
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2527

def relations
  @relations
end

#ssh_public_keys ⇒ Object

Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object) 


2532
2533
2534
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2532

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) 


2537
2538
2539
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2537

def suspended
  @suspended
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


2543
2544
2545
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2543

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) 


2548
2549
2550
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2548

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) 


2553
2554
2555
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2553

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

Corresponds to the JSON property websites

Returns:

  • (Object) 


2558
2559
2560
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2558

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2565

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