Class AuthenticationRule (2.17.0)
public sealed class AuthenticationRule : IMessage<AuthenticationRule>, IEquatable<AuthenticationRule>, IDeepCloneable<AuthenticationRule>, IBufferMessage, IMessage
Authentication rules for the service.
By default, if a method has any authentication requirements, every request
must include a valid credential matching one of the requirements.
It's an error to include more than one kind of credential in a single
request.
If a method doesn't have any auth requirements, request credentials will be
ignored.
Inheritance
object >
AuthenticationRule
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
AuthenticationRule()
public AuthenticationRule()
AuthenticationRule(AuthenticationRule)
public AuthenticationRule(AuthenticationRule other)
Fields
AllowWithoutCredentialFieldNumber
public const int AllowWithoutCredentialFieldNumber = 5
Field number for the "allow_without_credential" field.
Field Value |
Type |
Description |
int |
|
OauthFieldNumber
public const int OauthFieldNumber = 2
Field number for the "oauth" field.
Field Value |
Type |
Description |
int |
|
RequirementsFieldNumber
public const int RequirementsFieldNumber = 7
Field number for the "requirements" field.
Field Value |
Type |
Description |
int |
|
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
Field Value |
Type |
Description |
int |
|
Properties
AllowWithoutCredential
public bool AllowWithoutCredential { get; set; }
If true, the service accepts API keys without any other credential.
This flag only applies to HTTP and gRPC requests.
Property Value |
Type |
Description |
bool |
|
Descriptor
public static MessageDescriptor Descriptor { get; }
Oauth
public OAuthRequirements Oauth { get; set; }
The requirements for OAuth credentials.
Parser
public static MessageParser<AuthenticationRule> Parser { get; }
Requirements
public RepeatedField<AuthRequirement> Requirements { get; }
Requirements for additional authentication providers.
Selector
public string Selector { get; set; }
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Property Value |
Type |
Description |
string |
|
Methods
CalculateSize()
public int CalculateSize()
Returns |
Type |
Description |
int |
|
Clone()
public AuthenticationRule Clone()
Equals(AuthenticationRule)
public bool Equals(AuthenticationRule other)
Returns |
Type |
Description |
bool |
|
Equals(object)
public override bool Equals(object other)
Parameter |
Name |
Description |
other |
object
|
Returns |
Type |
Description |
bool |
|
Overrides
GetHashCode()
public override int GetHashCode()
Returns |
Type |
Description |
int |
|
Overrides
MergeFrom(AuthenticationRule)
public void MergeFrom(AuthenticationRule other)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
Returns |
Type |
Description |
string |
|
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
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 2025-10-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]