public final class AuthenticationInfo extends com.google.protobuf.GeneratedMessageV3 implements AuthenticationInfoOrBuilder
auditlog.v2.AuthenticationInfo
Modifier and Type | Class and Description |
---|---|
static class |
AuthenticationInfo.Builder
Protobuf type
auditlog.v2.AuthenticationInfo |
static class |
AuthenticationInfo.Exposure
Protobuf enum
auditlog.v2.AuthenticationInfo.Exposure |
static class |
AuthenticationInfo.Result
Protobuf enum
auditlog.v2.AuthenticationInfo.Result |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
CREDENTIALS_FIELD_NUMBER |
static int |
ERROR_MESSAGE_FIELD_NUMBER |
static int |
EXPOSURE_FIELD_NUMBER |
static int |
ORIGINAL_PRINCIPAL_FIELD_NUMBER |
static int |
PRINCIPAL_FIELD_NUMBER |
static int |
RESULT_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Credentials |
getCredentials()
The information sent to prove the identity of the principal.
|
CredentialsOrBuilder |
getCredentialsOrBuilder()
The information sent to prove the identity of the principal.
|
static AuthenticationInfo |
getDefaultInstance() |
AuthenticationInfo |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getErrorMessage()
A short, human-readable description of the reason authentication failed.
|
com.google.protobuf.ByteString |
getErrorMessageBytes()
A short, human-readable description of the reason authentication failed.
|
AuthenticationInfo.Exposure |
getExposure()
We divide operations into "internal" and "customer" operations.
|
int |
getExposureValue()
We divide operations into "internal" and "customer" operations.
|
Principal |
getOriginalPrincipal()
In the case where the original actor provides credentials to prove
their own identity and their right to assume the identity of a different
principal, THIS field captures the original actor, while `principal`
captures the assumed principal.
|
PrincipalOrBuilder |
getOriginalPrincipalOrBuilder()
In the case where the original actor provides credentials to prove
their own identity and their right to assume the identity of a different
principal, THIS field captures the original actor, while `principal`
captures the assumed principal.
|
com.google.protobuf.Parser<AuthenticationInfo> |
getParserForType() |
Principal |
getPrincipal()
The identity that authorization decisions are checked against
when processing the request; usually a user or service account.
|
PrincipalOrBuilder |
getPrincipalOrBuilder()
The identity that authorization decisions are checked against
when processing the request; usually a user or service account.
|
AuthenticationInfo.Result |
getResult()
SUCCESS if the service accepted the principal's credentials, FAILURE
otherwise.
|
int |
getResultValue()
SUCCESS if the service accepted the principal's credentials, FAILURE
otherwise.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasCredentials()
The information sent to prove the identity of the principal.
|
int |
hashCode() |
boolean |
hasOriginalPrincipal()
In the case where the original actor provides credentials to prove
their own identity and their right to assume the identity of a different
principal, THIS field captures the original actor, while `principal`
captures the assumed principal.
|
boolean |
hasPrincipal()
The identity that authorization decisions are checked against
when processing the request; usually a user or service account.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static AuthenticationInfo.Builder |
newBuilder() |
static AuthenticationInfo.Builder |
newBuilder(AuthenticationInfo prototype) |
AuthenticationInfo.Builder |
newBuilderForType() |
protected AuthenticationInfo.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static AuthenticationInfo |
parseDelimitedFrom(InputStream input) |
static AuthenticationInfo |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AuthenticationInfo |
parseFrom(byte[] data) |
static AuthenticationInfo |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AuthenticationInfo |
parseFrom(ByteBuffer data) |
static AuthenticationInfo |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AuthenticationInfo |
parseFrom(com.google.protobuf.ByteString data) |
static AuthenticationInfo |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AuthenticationInfo |
parseFrom(com.google.protobuf.CodedInputStream input) |
static AuthenticationInfo |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AuthenticationInfo |
parseFrom(InputStream input) |
static AuthenticationInfo |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<AuthenticationInfo> |
parser() |
AuthenticationInfo.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int EXPOSURE_FIELD_NUMBER
public static final int PRINCIPAL_FIELD_NUMBER
public static final int ORIGINAL_PRINCIPAL_FIELD_NUMBER
public static final int RESULT_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER
public static final int CREDENTIALS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public int getExposureValue()
We divide operations into "internal" and "customer" operations. All "customer" operations are those which must be requested by a Confluent customer's user or service account. On the other hand, "internal" operations are those requested by systems or employees of Confluent through special internal endpoints. If you're not sure, ask @audit-logs-eng-team in #audit-logs-eng. Downstream, we will scrub audit log events of "internal" authentication info before forwarding to customers. This includes removal of credentials info, and replacement of the employee principal with a generic "Confluent" principal. Down internal streams, we will hide all but the `confluent_user` or `confluent_service_account` details of "customer" principals from employees, unless privileged and working an incident.
.auditlog.v2.AuthenticationInfo.Exposure exposure = 1 [(.confluent.protobuf.field_meta) = { ... }
getExposureValue
in interface AuthenticationInfoOrBuilder
public AuthenticationInfo.Exposure getExposure()
We divide operations into "internal" and "customer" operations. All "customer" operations are those which must be requested by a Confluent customer's user or service account. On the other hand, "internal" operations are those requested by systems or employees of Confluent through special internal endpoints. If you're not sure, ask @audit-logs-eng-team in #audit-logs-eng. Downstream, we will scrub audit log events of "internal" authentication info before forwarding to customers. This includes removal of credentials info, and replacement of the employee principal with a generic "Confluent" principal. Down internal streams, we will hide all but the `confluent_user` or `confluent_service_account` details of "customer" principals from employees, unless privileged and working an incident.
.auditlog.v2.AuthenticationInfo.Exposure exposure = 1 [(.confluent.protobuf.field_meta) = { ... }
getExposure
in interface AuthenticationInfoOrBuilder
public boolean hasPrincipal()
The identity that authorization decisions are checked against when processing the request; usually a user or service account. The service MUST NOT fill in this field without first validating credentials and ensuring the credentials can be used to assume the identity of the principal. (If this field is present, `result` must be `SUCCESS`.) In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the assumed principal, while `original_principal` captures the identity of the original actor.
.auditlog.v2.Principal principal = 2;
hasPrincipal
in interface AuthenticationInfoOrBuilder
public Principal getPrincipal()
The identity that authorization decisions are checked against when processing the request; usually a user or service account. The service MUST NOT fill in this field without first validating credentials and ensuring the credentials can be used to assume the identity of the principal. (If this field is present, `result` must be `SUCCESS`.) In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the assumed principal, while `original_principal` captures the identity of the original actor.
.auditlog.v2.Principal principal = 2;
getPrincipal
in interface AuthenticationInfoOrBuilder
public PrincipalOrBuilder getPrincipalOrBuilder()
The identity that authorization decisions are checked against when processing the request; usually a user or service account. The service MUST NOT fill in this field without first validating credentials and ensuring the credentials can be used to assume the identity of the principal. (If this field is present, `result` must be `SUCCESS`.) In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the assumed principal, while `original_principal` captures the identity of the original actor.
.auditlog.v2.Principal principal = 2;
getPrincipalOrBuilder
in interface AuthenticationInfoOrBuilder
public boolean hasOriginalPrincipal()
In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the original actor, while `principal` captures the assumed principal. Authorization decisions are based off the privileges attached to `principal`, not this `original_principal`. The service MUST NOT fill in this field unless the `principal` field is also present and has a different value.
.auditlog.v2.Principal original_principal = 3;
hasOriginalPrincipal
in interface AuthenticationInfoOrBuilder
public Principal getOriginalPrincipal()
In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the original actor, while `principal` captures the assumed principal. Authorization decisions are based off the privileges attached to `principal`, not this `original_principal`. The service MUST NOT fill in this field unless the `principal` field is also present and has a different value.
.auditlog.v2.Principal original_principal = 3;
getOriginalPrincipal
in interface AuthenticationInfoOrBuilder
public PrincipalOrBuilder getOriginalPrincipalOrBuilder()
In the case where the original actor provides credentials to prove their own identity and their right to assume the identity of a different principal, THIS field captures the original actor, while `principal` captures the assumed principal. Authorization decisions are based off the privileges attached to `principal`, not this `original_principal`. The service MUST NOT fill in this field unless the `principal` field is also present and has a different value.
.auditlog.v2.Principal original_principal = 3;
getOriginalPrincipalOrBuilder
in interface AuthenticationInfoOrBuilder
public int getResultValue()
SUCCESS if the service accepted the principal's credentials, FAILURE otherwise. In case of FAILURE, an error_message should be provided.
.auditlog.v2.AuthenticationInfo.Result result = 4;
getResultValue
in interface AuthenticationInfoOrBuilder
public AuthenticationInfo.Result getResult()
SUCCESS if the service accepted the principal's credentials, FAILURE otherwise. In case of FAILURE, an error_message should be provided.
.auditlog.v2.AuthenticationInfo.Result result = 4;
getResult
in interface AuthenticationInfoOrBuilder
public String getErrorMessage()
A short, human-readable description of the reason authentication failed. Producers must not include details from the request itself. Consumers should not programmatically parse this field.
string error_message = 5;
getErrorMessage
in interface AuthenticationInfoOrBuilder
public com.google.protobuf.ByteString getErrorMessageBytes()
A short, human-readable description of the reason authentication failed. Producers must not include details from the request itself. Consumers should not programmatically parse this field.
string error_message = 5;
getErrorMessageBytes
in interface AuthenticationInfoOrBuilder
public boolean hasCredentials()
The information sent to prove the identity of the principal. This may be present even when authentication fails. Authentication events include this field, but after a successful authentication attempt, later events (of a different type) on the same connection from the same authenticated principal may omit the credentials from their audit log entries, in which case they can be correlated back to the authentication event by means of the `connection_id` they share. Alternatively, services may include the connected client's credentials even for event types other than authentication events. Consumers should be prepared to handle either case.
.auditlog.v2.Credentials credentials = 6;
hasCredentials
in interface AuthenticationInfoOrBuilder
public Credentials getCredentials()
The information sent to prove the identity of the principal. This may be present even when authentication fails. Authentication events include this field, but after a successful authentication attempt, later events (of a different type) on the same connection from the same authenticated principal may omit the credentials from their audit log entries, in which case they can be correlated back to the authentication event by means of the `connection_id` they share. Alternatively, services may include the connected client's credentials even for event types other than authentication events. Consumers should be prepared to handle either case.
.auditlog.v2.Credentials credentials = 6;
getCredentials
in interface AuthenticationInfoOrBuilder
public CredentialsOrBuilder getCredentialsOrBuilder()
The information sent to prove the identity of the principal. This may be present even when authentication fails. Authentication events include this field, but after a successful authentication attempt, later events (of a different type) on the same connection from the same authenticated principal may omit the credentials from their audit log entries, in which case they can be correlated back to the authentication event by means of the `connection_id` they share. Alternatively, services may include the connected client's credentials even for event types other than authentication events. Consumers should be prepared to handle either case.
.auditlog.v2.Credentials credentials = 6;
getCredentialsOrBuilder
in interface AuthenticationInfoOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static AuthenticationInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationInfo parseFrom(InputStream input) throws IOException
IOException
public static AuthenticationInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static AuthenticationInfo parseDelimitedFrom(InputStream input) throws IOException
IOException
public static AuthenticationInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static AuthenticationInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static AuthenticationInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public AuthenticationInfo.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static AuthenticationInfo.Builder newBuilder()
public static AuthenticationInfo.Builder newBuilder(AuthenticationInfo prototype)
public AuthenticationInfo.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected AuthenticationInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static AuthenticationInfo getDefaultInstance()
public static com.google.protobuf.Parser<AuthenticationInfo> parser()
public com.google.protobuf.Parser<AuthenticationInfo> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public AuthenticationInfo getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder