Class: Google::Apis::AdminDirectoryV1::User
- Inherits:
-
Object
- Object
- Google::Apis::AdminDirectoryV1::User
- 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
-
#addresses ⇒ Object
Corresponds to the JSON property
addresses
. -
#agreed_to_terms ⇒ Boolean
(also: #agreed_to_terms?)
Indicates if user has agreed to terms (Read-only) Corresponds to the JSON property
agreedToTerms
. -
#aliases ⇒ Array<String>
List of aliases (Read-only) Corresponds to the JSON property
aliases
. -
#archived ⇒ Boolean
(also: #archived?)
Indicates if user is archived.
-
#change_password_at_next_login ⇒ Boolean
(also: #change_password_at_next_login?)
Boolean indicating if the user should change password in next login Corresponds to the JSON property
changePasswordAtNextLogin
. -
#creation_time ⇒ DateTime
User's G Suite account creation time.
-
#custom_schemas ⇒ Hash<String,Hash<String,Object>>
Custom fields of the user.
-
#customer_id ⇒ String
CustomerId of User (Read-only) Corresponds to the JSON property
customerId
. -
#deletion_time ⇒ DateTime
Corresponds to the JSON property
deletionTime
. -
#emails ⇒ Object
Corresponds to the JSON property
emails
. -
#etag ⇒ String
ETag of the resource.
-
#external_ids ⇒ Object
Corresponds to the JSON property
externalIds
. -
#gender ⇒ Object
Corresponds to the JSON property
gender
. -
#hash_function ⇒ String
Hash function name for password.
-
#id ⇒ String
Unique identifier of User (Read-only) Corresponds to the JSON property
id
. -
#ims ⇒ Object
Corresponds to the JSON property
ims
. -
#include_in_global_address_list ⇒ Boolean
(also: #include_in_global_address_list?)
Boolean indicating if user is included in Global Address List Corresponds to the JSON property
includeInGlobalAddressList
. -
#ip_whitelisted ⇒ Boolean
(also: #ip_whitelisted?)
Boolean indicating if ip is whitelisted Corresponds to the JSON property
ipWhitelisted
. -
#is_admin ⇒ Boolean
(also: #is_admin?)
Boolean indicating if the user is admin (Read-only) Corresponds to the JSON property
isAdmin
. -
#is_delegated_admin ⇒ Boolean
(also: #is_delegated_admin?)
Boolean indicating if the user is delegated admin (Read-only) Corresponds to the JSON property
isDelegatedAdmin
. -
#is_enforced_in2_sv ⇒ Boolean
(also: #is_enforced_in2_sv?)
Is 2-step verification enforced (Read-only) Corresponds to the JSON property
isEnforcedIn2Sv
. -
#is_enrolled_in2_sv ⇒ Boolean
(also: #is_enrolled_in2_sv?)
Is enrolled in 2-step verification (Read-only) Corresponds to the JSON property
isEnrolledIn2Sv
. -
#is_mailbox_setup ⇒ Boolean
(also: #is_mailbox_setup?)
Is mailbox setup (Read-only) Corresponds to the JSON property
isMailboxSetup
. -
#keywords ⇒ Object
Corresponds to the JSON property
keywords
. -
#kind ⇒ String
Kind of resource this is.
-
#languages ⇒ Object
Corresponds to the JSON property
languages
. -
#last_login_time ⇒ DateTime
User's last login time.
-
#locations ⇒ Object
Corresponds to the JSON property
locations
. -
#name ⇒ Google::Apis::AdminDirectoryV1::UserName
JSON template for name of a user in Directory API.
-
#non_editable_aliases ⇒ Array<String>
List of non editable aliases (Read-only) Corresponds to the JSON property
nonEditableAliases
. -
#notes ⇒ Object
Corresponds to the JSON property
notes
. -
#org_unit_path ⇒ String
OrgUnit of User Corresponds to the JSON property
orgUnitPath
. -
#organizations ⇒ Object
Corresponds to the JSON property
organizations
. -
#password ⇒ String
User's password Corresponds to the JSON property
password
. -
#phones ⇒ Object
Corresponds to the JSON property
phones
. -
#posix_accounts ⇒ Object
Corresponds to the JSON property
posixAccounts
. -
#primary_email ⇒ String
username of User Corresponds to the JSON property
primaryEmail
. -
#recovery_email ⇒ String
Recovery email of the user.
-
#recovery_phone ⇒ String
Recovery phone of the user.
-
#relations ⇒ Object
Corresponds to the JSON property
relations
. -
#ssh_public_keys ⇒ Object
Corresponds to the JSON property
sshPublicKeys
. -
#suspended ⇒ Boolean
(also: #suspended?)
Indicates if user is suspended.
-
#suspension_reason ⇒ String
Suspension reason if user is suspended (Read-only) Corresponds to the JSON property
suspensionReason
. -
#thumbnail_photo_etag ⇒ String
ETag of the user's photo (Read-only) Corresponds to the JSON property
thumbnailPhotoEtag
. -
#thumbnail_photo_url ⇒ String
Photo Url of the user (Read-only) Corresponds to the JSON property
thumbnailPhotoUrl
. -
#websites ⇒ Object
Corresponds to the JSON property
websites
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ User
constructor
A new instance of User.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ User
Returns a new instance of User
3285 3286 3287 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3285 def initialize(**args) update!(**args) end |
Instance Attribute Details
#addresses ⇒ Object
Corresponds to the JSON property addresses
3047 3048 3049 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3047 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
3052 3053 3054 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3052 def agreed_to_terms @agreed_to_terms end |
#aliases ⇒ Array<String>
List of aliases (Read-only)
Corresponds to the JSON property aliases
3058 3059 3060 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3058 def aliases @aliases end |
#archived ⇒ Boolean Also known as: archived?
Indicates if user is archived.
Corresponds to the JSON property archived
3063 3064 3065 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3063 def archived @archived 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
3069 3070 3071 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3069 def change_password_at_next_login @change_password_at_next_login end |
#creation_time ⇒ DateTime
User's G Suite account creation time. (Read-only)
Corresponds to the JSON property creationTime
3075 3076 3077 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3075 def creation_time @creation_time end |
#custom_schemas ⇒ Hash<String,Hash<String,Object>>
Custom fields of the user.
Corresponds to the JSON property customSchemas
3080 3081 3082 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3080 def custom_schemas @custom_schemas end |
#customer_id ⇒ String
CustomerId of User (Read-only)
Corresponds to the JSON property customerId
3085 3086 3087 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3085 def customer_id @customer_id end |
#deletion_time ⇒ DateTime
Corresponds to the JSON property deletionTime
3090 3091 3092 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3090 def deletion_time @deletion_time end |
#emails ⇒ Object
Corresponds to the JSON property emails
3095 3096 3097 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3095 def emails @emails end |
#etag ⇒ String
ETag of the resource.
Corresponds to the JSON property etag
3100 3101 3102 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3100 def etag @etag end |
#external_ids ⇒ Object
Corresponds to the JSON property externalIds
3105 3106 3107 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3105 def external_ids @external_ids end |
#gender ⇒ Object
Corresponds to the JSON property gender
3110 3111 3112 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3110 def gender @gender end |
#hash_function ⇒ String
Hash function name for password. Supported are MD5, SHA-1 and crypt
Corresponds to the JSON property hashFunction
3115 3116 3117 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3115 def hash_function @hash_function end |
#id ⇒ String
Unique identifier of User (Read-only)
Corresponds to the JSON property id
3120 3121 3122 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3120 def id @id end |
#ims ⇒ Object
Corresponds to the JSON property ims
3125 3126 3127 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3125 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
3130 3131 3132 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3130 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
3136 3137 3138 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3136 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
3142 3143 3144 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3142 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
3148 3149 3150 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3148 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
3154 3155 3156 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3154 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
3160 3161 3162 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3160 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
3166 3167 3168 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3166 def is_mailbox_setup @is_mailbox_setup end |
#keywords ⇒ Object
Corresponds to the JSON property keywords
3172 3173 3174 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3172 def keywords @keywords end |
#kind ⇒ String
Kind of resource this is.
Corresponds to the JSON property kind
3177 3178 3179 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3177 def kind @kind end |
#languages ⇒ Object
Corresponds to the JSON property languages
3182 3183 3184 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3182 def languages @languages end |
#last_login_time ⇒ DateTime
User's last login time. (Read-only)
Corresponds to the JSON property lastLoginTime
3187 3188 3189 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3187 def last_login_time @last_login_time end |
#locations ⇒ Object
Corresponds to the JSON property locations
3192 3193 3194 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3192 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
3197 3198 3199 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3197 def name @name end |
#non_editable_aliases ⇒ Array<String>
List of non editable aliases (Read-only)
Corresponds to the JSON property nonEditableAliases
3202 3203 3204 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3202 def non_editable_aliases @non_editable_aliases end |
#notes ⇒ Object
Corresponds to the JSON property notes
3207 3208 3209 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3207 def notes @notes end |
#org_unit_path ⇒ String
OrgUnit of User
Corresponds to the JSON property orgUnitPath
3212 3213 3214 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3212 def org_unit_path @org_unit_path end |
#organizations ⇒ Object
Corresponds to the JSON property organizations
3217 3218 3219 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3217 def organizations @organizations end |
#password ⇒ String
User's password
Corresponds to the JSON property password
3222 3223 3224 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3222 def password @password end |
#phones ⇒ Object
Corresponds to the JSON property phones
3227 3228 3229 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3227 def phones @phones end |
#posix_accounts ⇒ Object
Corresponds to the JSON property posixAccounts
3232 3233 3234 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3232 def posix_accounts @posix_accounts end |
#primary_email ⇒ String
username of User
Corresponds to the JSON property primaryEmail
3237 3238 3239 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3237 def primary_email @primary_email end |
#recovery_email ⇒ String
Recovery email of the user.
Corresponds to the JSON property recoveryEmail
3242 3243 3244 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3242 def recovery_email @recovery_email end |
#recovery_phone ⇒ String
Recovery phone of the user.
Corresponds to the JSON property recoveryPhone
3247 3248 3249 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3247 def recovery_phone @recovery_phone end |
#relations ⇒ Object
Corresponds to the JSON property relations
3252 3253 3254 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3252 def relations @relations end |
#ssh_public_keys ⇒ Object
Corresponds to the JSON property sshPublicKeys
3257 3258 3259 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3257 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
3262 3263 3264 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3262 def suspended @suspended end |
#suspension_reason ⇒ String
Suspension reason if user is suspended (Read-only)
Corresponds to the JSON property suspensionReason
3268 3269 3270 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3268 def suspension_reason @suspension_reason end |
#thumbnail_photo_etag ⇒ String
ETag of the user's photo (Read-only)
Corresponds to the JSON property thumbnailPhotoEtag
3273 3274 3275 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3273 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
3278 3279 3280 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3278 def thumbnail_photo_url @thumbnail_photo_url end |
#websites ⇒ Object
Corresponds to the JSON property websites
3283 3284 3285 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3283 def websites @websites end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3290 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 |