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

STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. ( See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/ stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help# fieldNumber) STEPLADDER: Generated unstable field number for field ' organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/ stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help# fieldNumber) STEPLADDER: Generated unstable field number for field ' ssh_public_keys' to avoid collision. (See http://go/stepladder-help# fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder- help#fieldNumber) STEPLADDER: Generated unstable field number for field ' keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. ( See http://go/stepladder-help#fieldNumber)

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.


3231
3232
3233
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3231

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

Instance Attribute Details

#addressesObject

Addresses of User Corresponds to the JSON property addresses

Returns:

  • (Object)

2992
2993
2994
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2992

def addresses
  @addresses
end

#agreed_to_termsBoolean Also known as: agreed_to_terms?

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

Returns:

  • (Boolean)

2997
2998
2999
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2997

def agreed_to_terms
  @agreed_to_terms
end

#aliasesArray<String>

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

Returns:

  • (Array<String>)

3003
3004
3005
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3003

def aliases
  @aliases
end

#archivedBoolean Also known as: archived?

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

Returns:

  • (Boolean)

3008
3009
3010
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3008

def archived
  @archived
end

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

3014
3015
3016
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3014

def 
  @change_password_at_next_login
end

#creation_timeDateTime

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

Returns:

  • (DateTime)

3020
3021
3022
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3020

def creation_time
  @creation_time
end

#custom_schemasHash<String,Google::Apis::AdminDirectoryV1::UserCustomProperties>

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


3025
3026
3027
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3025

def custom_schemas
  @custom_schemas
end

#customer_idString

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

Returns:

  • (String)

3030
3031
3032
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3030

def customer_id
  @customer_id
end

#deletion_timeDateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime)

3035
3036
3037
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3035

def deletion_time
  @deletion_time
end

#emailsObject

Emails of User Corresponds to the JSON property emails

Returns:

  • (Object)

3040
3041
3042
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3040

def emails
  @emails
end

#etagString

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

Returns:

  • (String)

3045
3046
3047
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3045

def etag
  @etag
end

#external_idsObject

The external Ids of User * Corresponds to the JSON property externalIds

Returns:

  • (Object)

3050
3051
3052
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3050

def external_ids
  @external_ids
end

#genderObject

Gender of User Corresponds to the JSON property gender

Returns:

  • (Object)

3055
3056
3057
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3055

def gender
  @gender
end

#hash_functionString

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

Returns:

  • (String)

3060
3061
3062
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3060

def hash_function
  @hash_function
end

#idString

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

Returns:

  • (String)

3065
3066
3067
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3065

def id
  @id
end

#imsObject

User's Instant Messenger Corresponds to the JSON property ims

Returns:

  • (Object)

3070
3071
3072
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3070

def ims
  @ims
end

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

3075
3076
3077
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3075

def include_in_global_address_list
  @include_in_global_address_list
end

#ip_whitelistedBoolean Also known as: ip_whitelisted?

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

Returns:

  • (Boolean)

3081
3082
3083
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3081

def ip_whitelisted
  @ip_whitelisted
end

#is_adminBoolean Also known as: is_admin?

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

Returns:

  • (Boolean)

3087
3088
3089
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3087

def is_admin
  @is_admin
end

#is_delegated_adminBoolean Also known as: is_delegated_admin?

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

Returns:

  • (Boolean)

3093
3094
3095
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3093

def is_delegated_admin
  @is_delegated_admin
end

#is_enforced_in2_svBoolean Also known as: is_enforced_in2_sv?

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

Returns:

  • (Boolean)

3099
3100
3101
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3099

def is_enforced_in2_sv
  @is_enforced_in2_sv
end

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

3105
3106
3107
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3105

def is_enrolled_in2_sv
  @is_enrolled_in2_sv
end

#is_mailbox_setupBoolean Also known as: is_mailbox_setup?

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

Returns:

  • (Boolean)

3111
3112
3113
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3111

def is_mailbox_setup
  @is_mailbox_setup
end

#keywordsObject

Keywords of User Corresponds to the JSON property keywords

Returns:

  • (Object)

3117
3118
3119
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3117

def keywords
  @keywords
end

#kindString

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

Returns:

  • (String)

3122
3123
3124
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3122

def kind
  @kind
end

#languagesObject

Languages of User Corresponds to the JSON property languages

Returns:

  • (Object)

3127
3128
3129
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3127

def languages
  @languages
end

#last_login_timeDateTime

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

Returns:

  • (DateTime)

3132
3133
3134
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3132

def 
  @last_login_time
end

#locationsObject

Locations of User Corresponds to the JSON property locations

Returns:

  • (Object)

3137
3138
3139
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3137

def locations
  @locations
end

#nameGoogle::Apis::AdminDirectoryV1::UserName

User's name Corresponds to the JSON property name


3142
3143
3144
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3142

def name
  @name
end

#non_editable_aliasesArray<String>

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

Returns:

  • (Array<String>)

3147
3148
3149
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3147

def non_editable_aliases
  @non_editable_aliases
end

#notesObject

Notes of User Corresponds to the JSON property notes

Returns:

  • (Object)

3152
3153
3154
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3152

def notes
  @notes
end

#org_unit_pathString

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String)

3157
3158
3159
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3157

def org_unit_path
  @org_unit_path
end

#organizationsObject

Organizations of User Corresponds to the JSON property organizations

Returns:

  • (Object)

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

def organizations
  @organizations
end

#passwordString

User's password Corresponds to the JSON property password

Returns:

  • (String)

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

def password
  @password
end

#phonesObject

Phone numbers of User Corresponds to the JSON property phones

Returns:

  • (Object)

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

def phones
  @phones
end

#posix_accountsObject

The POSIX accounts of User Corresponds to the JSON property posixAccounts

Returns:

  • (Object)

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

def posix_accounts
  @posix_accounts
end

#primary_emailString

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String)

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

def primary_email
  @primary_email
end

#recovery_emailString

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

Returns:

  • (String)

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

def recovery_email
  @recovery_email
end

#recovery_phoneString

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)

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

def recovery_phone
  @recovery_phone
end

#relationsObject

The Relations of User * Corresponds to the JSON property relations

Returns:

  • (Object)

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

def relations
  @relations
end

#ssh_public_keysObject

The SSH public keys of User Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object)

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

def ssh_public_keys
  @ssh_public_keys
end

#suspendedBoolean Also known as: suspended?

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

Returns:

  • (Boolean)

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

def suspended
  @suspended
end

#suspension_reasonString

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

Returns:

  • (String)

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

def suspension_reason
  @suspension_reason
end

#thumbnail_photo_etagString

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

Returns:

  • (String)

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

def thumbnail_photo_etag
  @thumbnail_photo_etag
end

#thumbnail_photo_urlString

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

Returns:

  • (String)

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

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websitesObject

Websites of User Corresponds to the JSON property websites

Returns:

  • (Object)

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

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3236

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