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.



3242
3243
3244
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3242

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

Instance Attribute Details

#addressesObject

Corresponds to the JSON property addresses

Returns:

  • (Object)


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

def addresses
  @addresses
end

#agreed_to_termsBoolean Also known as: agreed_to_terms?

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

Returns:

  • (Boolean)


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

def agreed_to_terms
  @agreed_to_terms
end

#aliasesArray<String>

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

Returns:

  • (Array<String>)


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

def aliases
  @aliases
end

#archivedBoolean Also known as: archived?

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

Returns:

  • (Boolean)


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

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)


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

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)


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

def creation_time
  @creation_time
end

#custom_schemasHash<String,Hash<String,Object>>

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

Returns:

  • (Hash<String,Hash<String,Object>>)


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

def custom_schemas
  @custom_schemas
end

#customer_idString

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

Returns:

  • (String)


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

def customer_id
  @customer_id
end

#deletion_timeDateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime)


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

def deletion_time
  @deletion_time
end

#emailsObject

Corresponds to the JSON property emails

Returns:

  • (Object)


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

def emails
  @emails
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)


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

def etag
  @etag
end

#external_idsObject

Corresponds to the JSON property externalIds

Returns:

  • (Object)


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

def external_ids
  @external_ids
end

#genderObject

Corresponds to the JSON property gender

Returns:

  • (Object)


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

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)


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

def hash_function
  @hash_function
end

#idString

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

Returns:

  • (String)


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

def id
  @id
end

#imsObject

Corresponds to the JSON property ims

Returns:

  • (Object)


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

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)


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

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)


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

def ip_whitelisted
  @ip_whitelisted
end

#is_adminBoolean Also known as: is_admin?

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

Returns:

  • (Boolean)


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

def is_admin
  @is_admin
end

#is_delegated_adminBoolean Also known as: is_delegated_admin?

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

Returns:

  • (Boolean)


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

def is_delegated_admin
  @is_delegated_admin
end

#is_enforced_in2_svBoolean Also known as: is_enforced_in2_sv?

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

Returns:

  • (Boolean)


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

def is_enforced_in2_sv
  @is_enforced_in2_sv
end

#is_enrolled_in2_svBoolean Also known as: is_enrolled_in2_sv?

Is enrolled in 2-step verification (Read-only) Corresponds to the JSON property isEnrolledIn2Sv

Returns:

  • (Boolean)


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

def is_enrolled_in2_sv
  @is_enrolled_in2_sv
end

#is_mailbox_setupBoolean Also known as: is_mailbox_setup?

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

Returns:

  • (Boolean)


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

def is_mailbox_setup
  @is_mailbox_setup
end

#keywordsObject

Corresponds to the JSON property keywords

Returns:

  • (Object)


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

def keywords
  @keywords
end

#kindString

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

Returns:

  • (String)


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

def kind
  @kind
end

#languagesObject

Corresponds to the JSON property languages

Returns:

  • (Object)


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

def languages
  @languages
end

#last_login_timeDateTime

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

Returns:

  • (DateTime)


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

def 
  @last_login_time
end

#locationsObject

Corresponds to the JSON property locations

Returns:

  • (Object)


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

def locations
  @locations
end

#nameGoogle::Apis::AdminDirectoryV1::UserName

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



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

def name
  @name
end

#non_editable_aliasesArray<String>

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

Returns:

  • (Array<String>)


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

def non_editable_aliases
  @non_editable_aliases
end

#notesObject

Corresponds to the JSON property notes

Returns:

  • (Object)


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

def notes
  @notes
end

#org_unit_pathString

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String)


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

def org_unit_path
  @org_unit_path
end

#organizationsObject

Corresponds to the JSON property organizations

Returns:

  • (Object)


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

def organizations
  @organizations
end

#passwordString

User's password Corresponds to the JSON property password

Returns:

  • (String)


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

def password
  @password
end

#phonesObject

Corresponds to the JSON property phones

Returns:

  • (Object)


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

def phones
  @phones
end

#posix_accountsObject

Corresponds to the JSON property posixAccounts

Returns:

  • (Object)


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

def posix_accounts
  @posix_accounts
end

#primary_emailString

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String)


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

def primary_email
  @primary_email
end

#recovery_emailString

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

Returns:

  • (String)


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

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)


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

def recovery_phone
  @recovery_phone
end

#relationsObject

Corresponds to the JSON property relations

Returns:

  • (Object)


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

def relations
  @relations
end

#ssh_public_keysObject

Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object)


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

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)


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

def suspended
  @suspended
end

#suspension_reasonString

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

Returns:

  • (String)


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

def suspension_reason
  @suspension_reason
end

#thumbnail_photo_etagString

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

Returns:

  • (String)


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

def thumbnail_photo_etag
  @thumbnail_photo_etag
end

#thumbnail_photo_urlString

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

Returns:

  • (String)


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

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websitesObject

Corresponds to the JSON property websites

Returns:

  • (Object)


3240
3241
3242
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3240

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3247

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