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.



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

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

Instance Attribute Details

#addresses ⇒ Object

Corresponds to the JSON property addresses

Returns:

  • (Object) 


2230
2231
2232
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2230

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) 


2235
2236
2237
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2235

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


2241
2242
2243
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2241

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) 


2246
2247
2248
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2246

def 
  @change_password_at_next_login
end

#creation_time ⇒ DateTime

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

Returns:

  • (DateTime) 


2252
2253
2254
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2252

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


2257
2258
2259
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2257

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

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

Returns:

  • (String) 


2262
2263
2264
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2262

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


2267
2268
2269
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2267

def deletion_time
  @deletion_time
end

#emails ⇒ Object

Corresponds to the JSON property emails

Returns:

  • (Object) 


2272
2273
2274
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2272

def emails
  @emails
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2277
2278
2279
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2277

def etag
  @etag
end

#external_ids ⇒ Object

Corresponds to the JSON property externalIds

Returns:

  • (Object) 


2282
2283
2284
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2282

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) 


2287
2288
2289
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2287

def hash_function
  @hash_function
end

#id ⇒ String

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

Returns:

  • (String) 


2292
2293
2294
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2292

def id
  @id
end

#ims ⇒ Object

Corresponds to the JSON property ims

Returns:

  • (Object) 


2297
2298
2299
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2297

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) 


2302
2303
2304
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2302

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) 


2308
2309
2310
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2308

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) 


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

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) 


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

def is_delegated_admin
  @is_delegated_admin
end

#is_mailbox_setup ⇒ Boolean Also known as: is_mailbox_setup?

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

Returns:

  • (Boolean) 


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

def is_mailbox_setup
  @is_mailbox_setup
end

#kind ⇒ String

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

Returns:

  • (String) 


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

def kind
  @kind
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def 
  @last_login_time
end

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

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

Returns:



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

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


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

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Corresponds to the JSON property notes

Returns:

  • (Object) 


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

def notes
  @notes
end

#org_unit_path ⇒ String

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


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

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

Corresponds to the JSON property organizations

Returns:

  • (Object) 


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

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


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

def password
  @password
end

#phones ⇒ Object

Corresponds to the JSON property phones

Returns:

  • (Object) 


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

def phones
  @phones
end

#primary_email ⇒ String

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


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

def primary_email
  @primary_email
end

#relations ⇒ Object

Corresponds to the JSON property relations

Returns:

  • (Object) 


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

def relations
  @relations
end

#suspended ⇒ Boolean Also known as: suspended?

Indicates if user is suspended Corresponds to the JSON property suspended

Returns:

  • (Boolean) 


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

def suspended
  @suspended
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


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

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) 


2398
2399
2400
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2398

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) 


2403
2404
2405
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2403

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

Corresponds to the JSON property websites

Returns:

  • (Object) 


2408
2409
2410
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2408

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2415

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