Chronicle V1 API - Class Google::Backstory::User (v1.4.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::User.

Information about a user.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#account_expiration_time

def account_expiration_time() -> ::Google::Protobuf::Timestamp
Returns

#account_expiration_time=

def account_expiration_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#account_lockout_time

def account_lockout_time() -> ::Google::Protobuf::Timestamp
Returns

#account_lockout_time=

def account_lockout_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#account_type

def account_type() -> ::Google::Backstory::User::AccountType
Returns

#account_type=

def account_type=(value) -> ::Google::Backstory::User::AccountType
Parameter
Returns

#attribute

def attribute() -> ::Google::Backstory::Attribute
Returns

#attribute=

def attribute=(value) -> ::Google::Backstory::Attribute
Parameter
Returns

#company_name

def company_name() -> ::String
Returns
  • (::String) — User job company name.

#company_name=

def company_name=(value) -> ::String
Parameter
  • value (::String) — User job company name.
Returns
  • (::String) — User job company name.

#department

def department() -> ::Array<::String>
Returns
  • (::Array<::String>) — User job department

#department=

def department=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — User job department
Returns
  • (::Array<::String>) — User job department

#email_addresses

def email_addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Email addresses of the user. This field can be used as an entity indicator for user entities.

#email_addresses=

def email_addresses=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Email addresses of the user. This field can be used as an entity indicator for user entities.
Returns
  • (::Array<::String>) — Email addresses of the user. This field can be used as an entity indicator for user entities.

#employee_id

def employee_id() -> ::String
Returns
  • (::String) — Human capital management identifier. This field can be used as an entity indicator for user entities.

#employee_id=

def employee_id=(value) -> ::String
Parameter
  • value (::String) — Human capital management identifier. This field can be used as an entity indicator for user entities.
Returns
  • (::String) — Human capital management identifier. This field can be used as an entity indicator for user entities.

#first_name

def first_name() -> ::String
Returns
  • (::String) — First name of the user (e.g. "John").

#first_name=

def first_name=(value) -> ::String
Parameter
  • value (::String) — First name of the user (e.g. "John").
Returns
  • (::String) — First name of the user (e.g. "John").

#first_seen_time

def first_seen_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.

#first_seen_time=

def first_seen_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.
Returns
  • (::Google::Protobuf::Timestamp) — The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.

#group_identifiers

def group_identifiers() -> ::Array<::String>
Returns
  • (::Array<::String>) — Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

#group_identifiers=

def group_identifiers=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).
Returns
  • (::Array<::String>) — Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

#groupid

def groupid() -> ::String
Returns
  • (::String) — The ID of the group that the user belongs to. Deprecated in favor of the repeated group_identifiers field.

#groupid=

def groupid=(value) -> ::String
Parameter
  • value (::String) — The ID of the group that the user belongs to. Deprecated in favor of the repeated group_identifiers field.
Returns
  • (::String) — The ID of the group that the user belongs to. Deprecated in favor of the repeated group_identifiers field.

#hire_date

def hire_date() -> ::Google::Protobuf::Timestamp
Returns

#hire_date=

def hire_date=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#last_bad_password_attempt_time

def last_bad_password_attempt_time() -> ::Google::Protobuf::Timestamp
Returns

#last_bad_password_attempt_time=

def last_bad_password_attempt_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#last_login_time

def last_login_time() -> ::Google::Protobuf::Timestamp
Returns

#last_login_time=

def last_login_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#last_name

def last_name() -> ::String
Returns
  • (::String) — Last name of the user (e.g. "Locke").

#last_name=

def last_name=(value) -> ::String
Parameter
  • value (::String) — Last name of the user (e.g. "Locke").
Returns
  • (::String) — Last name of the user (e.g. "Locke").

#last_password_change_time

def last_password_change_time() -> ::Google::Protobuf::Timestamp
Returns

#last_password_change_time=

def last_password_change_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#managers

def managers() -> ::Array<::Google::Backstory::User>
Returns

#managers=

def managers=(value) -> ::Array<::Google::Backstory::User>
Parameter
Returns

#middle_name

def middle_name() -> ::String
Returns
  • (::String) — Middle name of the user.

#middle_name=

def middle_name=(value) -> ::String
Parameter
  • value (::String) — Middle name of the user.
Returns
  • (::String) — Middle name of the user.

#office_address

def office_address() -> ::Google::Backstory::Location
Returns

#office_address=

def office_address=(value) -> ::Google::Backstory::Location
Parameter
Returns

#password_expiration_time

def password_expiration_time() -> ::Google::Protobuf::Timestamp
Returns

#password_expiration_time=

def password_expiration_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#personal_address

def personal_address() -> ::Google::Backstory::Location
Returns

#personal_address=

def personal_address=(value) -> ::Google::Backstory::Location
Parameter
Returns

#phone_numbers

def phone_numbers() -> ::Array<::String>
Returns
  • (::Array<::String>) — Phone numbers for the user.

#phone_numbers=

def phone_numbers=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Phone numbers for the user.
Returns
  • (::Array<::String>) — Phone numbers for the user.

#product_object_id

def product_object_id() -> ::String
Returns
  • (::String) — A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.

#product_object_id=

def product_object_id=(value) -> ::String
Parameter
  • value (::String) — A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.
Returns
  • (::String) — A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.

#role_description

def role_description() -> ::String
Returns
  • (::String) — System role description for user. Deprecated: use attribute.roles.

#role_description=

def role_description=(value) -> ::String
Parameter
  • value (::String) — System role description for user. Deprecated: use attribute.roles.
Returns
  • (::String) — System role description for user. Deprecated: use attribute.roles.

#role_name

def role_name() -> ::String
Returns
  • (::String) — System role name for user. Deprecated: use attribute.roles.

#role_name=

def role_name=(value) -> ::String
Parameter
  • value (::String) — System role name for user. Deprecated: use attribute.roles.
Returns
  • (::String) — System role name for user. Deprecated: use attribute.roles.

#termination_date

def termination_date() -> ::Google::Protobuf::Timestamp
Returns

#termination_date=

def termination_date=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#time_off

def time_off() -> ::Array<::Google::Backstory::TimeOff>
Returns

#time_off=

def time_off=(value) -> ::Array<::Google::Backstory::TimeOff>
Parameter
Returns

#title

def title() -> ::String
Returns
  • (::String) — User job title.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — User job title.
Returns
  • (::String) — User job title.

#user_authentication_status

def user_authentication_status() -> ::Google::Backstory::Authentication::AuthenticationStatus
Returns

#user_authentication_status=

def user_authentication_status=(value) -> ::Google::Backstory::Authentication::AuthenticationStatus
Parameter
Returns

#user_display_name

def user_display_name() -> ::String
Returns
  • (::String) — The display name of the user (e.g. "John Locke").

#user_display_name=

def user_display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the user (e.g. "John Locke").
Returns
  • (::String) — The display name of the user (e.g. "John Locke").

#user_role

def user_role() -> ::Google::Backstory::User::Role
Returns

#user_role=

def user_role=(value) -> ::Google::Backstory::User::Role
Parameter
Returns

#userid

def userid() -> ::String
Returns
  • (::String) — The ID of the user. This field can be used as an entity indicator for user entities.

#userid=

def userid=(value) -> ::String
Parameter
  • value (::String) — The ID of the user. This field can be used as an entity indicator for user entities.
Returns
  • (::String) — The ID of the user. This field can be used as an entity indicator for user entities.

#windows_sid

def windows_sid() -> ::String
Returns
  • (::String) — The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.

#windows_sid=

def windows_sid=(value) -> ::String
Parameter
  • value (::String) — The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.
Returns
  • (::String) — The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.