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.



3499
3500
3501
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3499

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) 


3210
3211
3212
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3210

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) 


3216
3217
3218
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3216

def agreed_to_terms
  @agreed_to_terms
end

#aliases ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3222
3223
3224
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3222

def aliases
  @aliases
end

#archived ⇒ Boolean Also known as: archived?

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

Returns:

  • (Boolean) 


3227
3228
3229
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3227

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) 


3235
3236
3237
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3235

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) 


3241
3242
3243
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3241

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


3246
3247
3248
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3246

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) 


3256
3257
3258
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3256

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


3261
3262
3263
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3261

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) 


3267
3268
3269
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3267

def emails
  @emails
end

#etag ⇒ String

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

Returns:

  • (String) 


3272
3273
3274
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3272

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) 


3278
3279
3280
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3278

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) 


3283
3284
3285
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3283

def gender
  @gender
end

#hash_function ⇒ String

Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format. Corresponds to the JSON property hashFunction

Returns:

  • (String) 


3292
3293
3294
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3292

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) 


3298
3299
3300
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3298

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) 


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

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) 


3313
3314
3315
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3313

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

Returns:

  • (Boolean) 


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

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) 


3332
3333
3334
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3332

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) 


3342
3343
3344
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3342

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) 


3348
3349
3350
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3348

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) 


3354
3355
3356
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3354

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) 


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

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) 


3367
3368
3369
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3367

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) 


3373
3374
3375
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3373

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) 


3378
3379
3380
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3378

def languages
  @languages
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


3383
3384
3385
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3383

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) 


3388
3389
3390
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3388

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:



3399
3400
3401
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3399

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


3405
3406
3407
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3405

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Notes for the user. Corresponds to the JSON property notes

Returns:

  • (Object) 


3410
3411
3412
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3410

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) 


3417
3418
3419
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3417

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) 


3423
3424
3425
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3423

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


3428
3429
3430
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3428

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) 


3434
3435
3436
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3434

def phones
  @phones
end

#posix_accounts ⇒ Object

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

Returns:

  • (Object) 


3440
3441
3442
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3440

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) 


3447
3448
3449
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3447

def primary_email
  @primary_email
end

#recovery_email ⇒ String

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

Returns:

  • (String) 


3452
3453
3454
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3452

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) 


3458
3459
3460
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3458

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) 


3464
3465
3466
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3464

def relations
  @relations
end

#ssh_public_keys ⇒ Object

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

Returns:

  • (Object) 


3469
3470
3471
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3469

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) 


3474
3475
3476
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3474

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) 


3482
3483
3484
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3482

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) 


3487
3488
3489
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3487

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) 


3492
3493
3494
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3492

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) 


3497
3498
3499
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3497

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3504

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