Class AuthRequirement (2.10.0)

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

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

Inheritance

object > AuthRequirement

Implements

IMessage AuthRequirement, IEquatable AuthRequirement, IDeepCloneable AuthRequirement, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

AuthRequirement()

public AuthRequirement()

AuthRequirement(AuthRequirement)

public AuthRequirement(AuthRequirement other)

Parameter
Name	Description
`other`	`AuthRequirement`

Fields

AudiencesFieldNumber

public const int AudiencesFieldNumber = 2

Field number for the "audiences" field.

Field Value
Type	Description
`int`

ProviderIdFieldNumber

public const int ProviderIdFieldNumber = 1

Field number for the "provider_id" field.

Field Value
Type	Description
`int`

Properties

Audiences

public string Audiences { get; set; }

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

Property Value
Type	Description
`string`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Parser

public static MessageParser<AuthRequirement> Parser { get; }

Property Value
Type	Description
`MessageParserAuthRequirement`

ProviderId

public string ProviderId { get; set; }

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

Example:

provider_id: bookstore_auth

Property Value
Type	Description
`string`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`int`

Clone()

public AuthRequirement Clone()

Returns
Type	Description
`AuthRequirement`

Equals(AuthRequirement)

public bool Equals(AuthRequirement other)

Parameter
Name	Description
`other`	`AuthRequirement`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(AuthRequirement)

public void MergeFrom(AuthRequirement other)

Parameter
Name	Description
`other`	`AuthRequirement`

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`