Class Authentication (0.3.0)

public final class Authentication extends GeneratedMessage implements AuthenticationOrBuilder

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.

Protobuf type google.backstory.Authentication

Static Fields

AUTH_DETAILS_FIELD_NUMBER

public static final int AUTH_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

MECHANISM_FIELD_NUMBER

public static final int MECHANISM_FIELD_NUMBER
Field Value
Type Description
int

OUTCOME_FIELD_NUMBER

public static final int OUTCOME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Authentication getDefaultInstance()
Returns
Type Description
Authentication

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Authentication.Builder newBuilder()
Returns
Type Description
Authentication.Builder

newBuilder(Authentication prototype)

public static Authentication.Builder newBuilder(Authentication prototype)
Parameter
Name Description
prototype Authentication
Returns
Type Description
Authentication.Builder

parseDelimitedFrom(InputStream input)

public static Authentication parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Authentication parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Authentication parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Authentication parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Authentication parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Authentication parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Authentication
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Authentication> parser()
Returns
Type Description
Parser<Authentication>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthDetails()

public String getAuthDetails()

The vendor defined details of the authentication.

string auth_details = 3;

Returns
Type Description
String

The authDetails.

getAuthDetailsBytes()

public ByteString getAuthDetailsBytes()

The vendor defined details of the authentication.

string auth_details = 3;

Returns
Type Description
ByteString

The bytes for authDetails.

getDefaultInstanceForType()

public Authentication getDefaultInstanceForType()
Returns
Type Description
Authentication

getMechanism(int index)

public Authentication.Mechanism getMechanism(int index)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Authentication.Mechanism

The mechanism at the given index.

getMechanismCount()

public int getMechanismCount()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type Description
int

The count of mechanism.

getMechanismList()

public List<Authentication.Mechanism> getMechanismList()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type Description
List<Mechanism>

A list containing the mechanism.

getMechanismValue(int index)

public int getMechanismValue(int index)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of mechanism at the given index.

getMechanismValueList()

public List<Integer> getMechanismValueList()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for mechanism.

getOutcome()

public Authentication.Outcome getOutcome()

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Returns
Type Description
Authentication.Outcome

The outcome.

getOutcomeValue()

public int getOutcomeValue()

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Returns
Type Description
int

The enum numeric value on the wire for outcome.

getParserForType()

public Parser<Authentication> getParserForType()
Returns
Type Description
Parser<Authentication>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public Authentication.AuthType getType()

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Returns
Type Description
Authentication.AuthType

The type.

getTypeValue()

public int getTypeValue()

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Authentication.Builder newBuilderForType()
Returns
Type Description
Authentication.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Authentication.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Authentication.Builder
Overrides

toBuilder()

public Authentication.Builder toBuilder()
Returns
Type Description
Authentication.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException