Class Authentication (2.15.0)

public sealed class Authentication : IMessage<Authentication>, IEquatable<Authentication>, IDeepCloneable<Authentication>, IBufferMessage, IMessage

Authentication defines the authentication configuration for API methods provided by an API service.

Example:

name: calendar.googleapis.com
authentication:
  providers:
  - id: google_calendar_auth
    jwks_uri: https://www.googleapis.com/oauth2/v1/certs
    issuer: https://securetoken.google.com
  rules:
  - selector: "*"
    requirements:
      provider_id: google_calendar_auth
  - selector: google.calendar.Delegate
    oauth:
      canonical_scopes: https://www.googleapis.com/auth/calendar.read

Inheritance

object > Authentication

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Authentication()

public Authentication()

Authentication(Authentication)

public Authentication(Authentication other)
Parameter
Name Description
other Authentication

Fields

ProvidersFieldNumber

public const int ProvidersFieldNumber = 4

Field number for the "providers" field.

Field Value
Type Description
int

RulesFieldNumber

public const int RulesFieldNumber = 3

Field number for the "rules" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Parser

public static MessageParser<Authentication> Parser { get; }
Property Value
Type Description
MessageParserAuthentication

Providers

public RepeatedField<AuthProvider> Providers { get; }

Defines a set of authentication providers that a service supports.

Property Value
Type Description
RepeatedFieldAuthProvider

Rules

public RepeatedField<AuthenticationRule> Rules { get; }

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Property Value
Type Description
RepeatedFieldAuthenticationRule

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public Authentication Clone()

Creates a deep clone of this object.

Returns
Type Description
Authentication

A deep clone of this object.

Equals(Authentication)

public bool Equals(Authentication other)
Parameter
Name Description
other Authentication
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(Authentication)

public void MergeFrom(Authentication other)

Merges the given message into this one.

Parameter
Name Description
other Authentication
Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.