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



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

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

Instance Attribute Details

#addresses ⇒ Object

Corresponds to the JSON property addresses

Returns:

  • (Object) 


2310
2311
2312
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2310

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) 


2315
2316
2317
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2315

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


2321
2322
2323
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2321

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) 


2326
2327
2328
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2326

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) 


2332
2333
2334
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2332

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


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

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

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

Returns:

  • (String) 


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

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


2347
2348
2349
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2347

def deletion_time
  @deletion_time
end

#emails ⇒ Object

Corresponds to the JSON property emails

Returns:

  • (Object) 


2352
2353
2354
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2352

def emails
  @emails
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2357
2358
2359
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2357

def etag
  @etag
end

#external_ids ⇒ Object

Corresponds to the JSON property externalIds

Returns:

  • (Object) 


2362
2363
2364
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2362

def external_ids
  @external_ids
end

#hash_function ⇒ String

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

Returns:

  • (String) 


2367
2368
2369
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2367

def hash_function
  @hash_function
end

#id ⇒ String

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

Returns:

  • (String) 


2372
2373
2374
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2372

def id
  @id
end

#ims ⇒ Object

Corresponds to the JSON property ims

Returns:

  • (Object) 


2377
2378
2379
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2377

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) 


2382
2383
2384
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2382

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) 


2388
2389
2390
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2388

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) 


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

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) 


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

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) 


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

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) 


2412
2413
2414
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2412

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) 


2418
2419
2420
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2418

def is_mailbox_setup
  @is_mailbox_setup
end

#kind ⇒ String

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

Returns:

  • (String) 


2424
2425
2426
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2424

def kind
  @kind
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


2429
2430
2431
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2429

def 
  @last_login_time
end

#locations ⇒ Object

Corresponds to the JSON property locations

Returns:

  • (Object) 


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

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:



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

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


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

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Corresponds to the JSON property notes

Returns:

  • (Object) 


2449
2450
2451
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2449

def notes
  @notes
end

#org_unit_path ⇒ String

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


2454
2455
2456
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2454

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

Corresponds to the JSON property organizations

Returns:

  • (Object) 


2459
2460
2461
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2459

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


2464
2465
2466
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2464

def password
  @password
end

#phones ⇒ Object

Corresponds to the JSON property phones

Returns:

  • (Object) 


2469
2470
2471
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2469

def phones
  @phones
end

#posix_accounts ⇒ Object

Corresponds to the JSON property posixAccounts

Returns:

  • (Object) 


2474
2475
2476
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2474

def posix_accounts
  @posix_accounts
end

#primary_email ⇒ String

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


2479
2480
2481
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2479

def primary_email
  @primary_email
end

#relations ⇒ Object

Corresponds to the JSON property relations

Returns:

  • (Object) 


2484
2485
2486
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2484

def relations
  @relations
end

#ssh_public_keys ⇒ Object

Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object) 


2489
2490
2491
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2489

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) 


2494
2495
2496
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2494

def suspended
  @suspended
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


2500
2501
2502
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2500

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) 


2505
2506
2507
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2505

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) 


2510
2511
2512
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2510

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

Corresponds to the JSON property websites

Returns:

  • (Object) 


2515
2516
2517
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2515

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2522

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)
  @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)
  @kind = args[:kind] if args.key?(:kind)
  @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