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



3096
3097
3098
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3096

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

Instance Attribute Details

#addresses ⇒ Object

Corresponds to the JSON property addresses

Returns:

  • (Object) 


2874
2875
2876
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2874

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) 


2879
2880
2881
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2879

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


2885
2886
2887
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2885

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) 


2890
2891
2892
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2890

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) 


2896
2897
2898
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2896

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


2901
2902
2903
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2901

def custom_schemas
  @custom_schemas
end

#customer_id ⇒ String

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

Returns:

  • (String) 


2906
2907
2908
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2906

def customer_id
  @customer_id
end

#deletion_time ⇒ DateTime

Corresponds to the JSON property deletionTime

Returns:

  • (DateTime) 


2911
2912
2913
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2911

def deletion_time
  @deletion_time
end

#emails ⇒ Object

Corresponds to the JSON property emails

Returns:

  • (Object) 


2916
2917
2918
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2916

def emails
  @emails
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2921
2922
2923
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2921

def etag
  @etag
end

#external_ids ⇒ Object

Corresponds to the JSON property externalIds

Returns:

  • (Object) 


2926
2927
2928
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2926

def external_ids
  @external_ids
end

#gender ⇒ Object

Corresponds to the JSON property gender

Returns:

  • (Object) 


2931
2932
2933
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2931

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

Returns:

  • (String) 


2936
2937
2938
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2936

def hash_function
  @hash_function
end

#id ⇒ String

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

Returns:

  • (String) 


2941
2942
2943
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2941

def id
  @id
end

#ims ⇒ Object

Corresponds to the JSON property ims

Returns:

  • (Object) 


2946
2947
2948
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2946

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) 


2951
2952
2953
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2951

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) 


2957
2958
2959
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2957

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) 


2963
2964
2965
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2963

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) 


2969
2970
2971
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2969

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

Returns:

  • (Boolean) 


2975
2976
2977
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2975

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

Returns:

  • (Boolean) 


2981
2982
2983
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2981

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

Returns:

  • (Boolean) 


2987
2988
2989
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2987

def is_mailbox_setup
  @is_mailbox_setup
end

#keywords ⇒ Object

Corresponds to the JSON property keywords

Returns:

  • (Object) 


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

def keywords
  @keywords
end

#kind ⇒ String

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

Returns:

  • (String) 


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

def kind
  @kind
end

#languages ⇒ Object

Corresponds to the JSON property languages

Returns:

  • (Object) 


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

def languages
  @languages
end

#last_login_time ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def 
  @last_login_time
end

#locations ⇒ Object

Corresponds to the JSON property locations

Returns:

  • (Object) 


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

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

Returns:



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

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


3023
3024
3025
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3023

def non_editable_aliases
  @non_editable_aliases
end

#notes ⇒ Object

Corresponds to the JSON property notes

Returns:

  • (Object) 


3028
3029
3030
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3028

def notes
  @notes
end

#org_unit_path ⇒ String

OrgUnit of User Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


3033
3034
3035
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3033

def org_unit_path
  @org_unit_path
end

#organizations ⇒ Object

Corresponds to the JSON property organizations

Returns:

  • (Object) 


3038
3039
3040
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3038

def organizations
  @organizations
end

#password ⇒ String

User's password Corresponds to the JSON property password

Returns:

  • (String) 


3043
3044
3045
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3043

def password
  @password
end

#phones ⇒ Object

Corresponds to the JSON property phones

Returns:

  • (Object) 


3048
3049
3050
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3048

def phones
  @phones
end

#posix_accounts ⇒ Object

Corresponds to the JSON property posixAccounts

Returns:

  • (Object) 


3053
3054
3055
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3053

def posix_accounts
  @posix_accounts
end

#primary_email ⇒ String

username of User Corresponds to the JSON property primaryEmail

Returns:

  • (String) 


3058
3059
3060
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3058

def primary_email
  @primary_email
end

#relations ⇒ Object

Corresponds to the JSON property relations

Returns:

  • (Object) 


3063
3064
3065
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3063

def relations
  @relations
end

#ssh_public_keys ⇒ Object

Corresponds to the JSON property sshPublicKeys

Returns:

  • (Object) 


3068
3069
3070
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3068

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) 


3073
3074
3075
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3073

def suspended
  @suspended
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


3079
3080
3081
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3079

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) 


3084
3085
3086
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3084

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) 


3089
3090
3091
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3089

def thumbnail_photo_url
  @thumbnail_photo_url
end

#websites ⇒ Object

Corresponds to the JSON property websites

Returns:

  • (Object) 


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

def websites
  @websites
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3101

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