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

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

The Authentication extension captures details specific to authentication events. General guidelines for authentication events:

  • Details about the source of the authentication event (for example, client IP or hostname), should be captured in principal. The principal may be empty if we have no details about the source of the login.
  • Details about the target of the authentication event (for example, details about the machine that is being logged into or logged out of) should be captured in target.
  • Some authentication events may involve a third-party. For example, a user logs into a cloud service (for example, Chronicle) via their company's SSO (the event is logged by their SSO solution). In this case, the principal captures information about the user's device, the target captures details about the cloud service they logged into, and the intermediary captures details about the SSO solution.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auth_details

def auth_details() -> ::String
Returns
  • (::String) — The vendor defined details of the authentication.

#auth_details=

def auth_details=(value) -> ::String
Parameter
  • value (::String) — The vendor defined details of the authentication.
Returns
  • (::String) — The vendor defined details of the authentication.

#mechanism

def mechanism() -> ::Array<::Google::Backstory::Authentication::Mechanism>
Returns

#mechanism=

def mechanism=(value) -> ::Array<::Google::Backstory::Authentication::Mechanism>
Parameter
Returns

#outcome

def outcome() -> ::Google::Backstory::Authentication::Outcome
Returns

#outcome=

def outcome=(value) -> ::Google::Backstory::Authentication::Outcome
Parameter
Returns

#type

def type() -> ::Google::Backstory::Authentication::AuthType
Returns

#type=

def type=(value) -> ::Google::Backstory::Authentication::AuthType
Parameter
Returns