Send feedback
Class AuthRequirement (2.7.4)
Stay organized with collections
Save and categorize content based on your preferences.
2.72.0 (latest)
2.70.0
2.67.0
2.66.0
2.65.1
2.64.1
2.63.2
2.62.0
2.61.3
2.60.0
2.59.2
2.58.0
2.57.0
2.56.0
2.54.1
2.53.0
2.52.0
2.51.0
2.50.1
2.49.0
2.48.0
2.46.0
2.45.1
2.44.0
2.43.0
2.42.0
2.41.0
2.40.0
2.39.1
2.38.0
2.37.1
2.36.0
2.34.0
2.33.0
2.32.0
2.30.0
2.29.0
2.28.0
2.27.0
2.26.0
2.25.1
2.24.0
2.23.1
2.22.1
2.21.1
2.15.0
2.14.3
2.13.0
2.12.0
2.11.0
2.10.0
2.9.6
2.8.4
2.7.4
public final class AuthRequirement extends GeneratedMessageV3 implements AuthRequirementOrBuilder
User-defined authentication requirements, including support for
JSON Web Token
(JWT) .
Protobuf type google.api.AuthRequirement
Static Fields
AUDIENCES_FIELD_NUMBER
public static final int AUDIENCES_FIELD_NUMBER
Field Value
PROVIDER_ID_FIELD_NUMBER
public static final int PROVIDER_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AuthRequirement getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static AuthRequirement . Builder newBuilder ()
Returns
newBuilder(AuthRequirement prototype)
public static AuthRequirement . Builder newBuilder ( AuthRequirement prototype )
Parameter
Returns
public static AuthRequirement parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static AuthRequirement parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AuthRequirement parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthRequirement parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AuthRequirement parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthRequirement parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static AuthRequirement parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static AuthRequirement parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static AuthRequirement parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static AuthRequirement parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AuthRequirement parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthRequirement parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<AuthRequirement> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getAudiences()
public String getAudiences ()
NOTE: This will be deprecated soon, once AuthProvider.audiences is
implemented and accepted in all the runtime components.
The list of JWT
audiences .
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, only JWTs with audience
"https://Service_name /API_name "
will be accepted. For example, if no audiences are in the setting,
LibraryService API will only accept JWTs with the following audience
"https://library-example.googleapis.com/google.example.library.v1.LibraryService ".
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
string audiences = 2;
Returns
Type Description
String The audiences.
getAudiencesBytes()
public ByteString getAudiencesBytes ()
NOTE: This will be deprecated soon, once AuthProvider.audiences is
implemented and accepted in all the runtime components.
The list of JWT
audiences .
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, only JWTs with audience
"https://Service_name /API_name "
will be accepted. For example, if no audiences are in the setting,
LibraryService API will only accept JWTs with the following audience
"https://library-example.googleapis.com/google.example.library.v1.LibraryService ".
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
string audiences = 2;
Returns
Type Description
ByteString The bytes for audiences.
getDefaultInstanceForType()
public AuthRequirement getDefaultInstanceForType ()
Returns
getParserForType()
public Parser<AuthRequirement> getParserForType ()
Returns
Overrides
getProviderId()
public String getProviderId ()
id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
Returns
Type Description
String The providerId.
getProviderIdBytes()
public ByteString getProviderIdBytes ()
id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
Returns
Type Description
ByteString The bytes for providerId.
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public AuthRequirement . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthRequirement . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public AuthRequirement . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-19 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-19 UTC."],[],[]]
