Class AuthRequirement

User-defined authentication requirements, including support for JSON Web Token (JWT).

Inheritance
System.Object
AuthRequirement
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class AuthRequirement : IMessage<AuthRequirement>, IMessage, IEquatable<AuthRequirement>, IDeepCloneable<AuthRequirement>

Constructors

AuthRequirement()

Declaration
public AuthRequirement()

AuthRequirement(AuthRequirement)

Declaration
public AuthRequirement(AuthRequirement other)
Parameters
Type Name Description
AuthRequirement other

Fields

AudiencesFieldNumber

Field number for the "audiences" field.

Declaration
public const int AudiencesFieldNumber = 2
Field Value
Type Description
System.Int32

ProviderIdFieldNumber

Field number for the "provider_id" field.

Declaration
public const int ProviderIdFieldNumber = 1
Field Value
Type Description
System.Int32

Properties

Audiences

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][google.api.Service.name]/[API_name][google.protobuf.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

Declaration
public string Audiences { get; set; }
Property Value
Type Description
System.String

Descriptor

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

Parser

Declaration
public static MessageParser<AuthRequirement> Parser { get; }
Property Value
Type Description
MessageParser<AuthRequirement>

ProviderId

[id][google.api.AuthProvider.id] from authentication provider.

Example:

provider_id: bookstore_auth

Declaration
public string ProviderId { get; set; }
Property Value
Type Description
System.String

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public AuthRequirement Clone()
Returns
Type Description
AuthRequirement
Implements

Equals(AuthRequirement)

Declaration
public bool Equals(AuthRequirement other)
Parameters
Type Name Description
AuthRequirement other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(AuthRequirement)

Declaration
public void MergeFrom(AuthRequirement other)
Parameters
Type Name Description
AuthRequirement other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements