Class JwtLocation (2.2.0) 

public sealed class JwtLocation : Protobuf.IMessage<JwtLocation>, Protobuf.IBufferMessage

Specifies a location to extract JWT from an API request.

Inheritance

Object > JwtLocation

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

JwtLocation()

public JwtLocation()

JwtLocation(JwtLocation)

public JwtLocation(JwtLocation other)
Parameter
Name Description
other JwtLocation

Fields

HeaderFieldNumber

public const int HeaderFieldNumber = 1

Field number for the "header" field.

Field Value
Type Description
Int32

QueryFieldNumber

public const int QueryFieldNumber = 2

Field number for the "query" field.

Field Value
Type Description
Int32

ValuePrefixFieldNumber

public const int ValuePrefixFieldNumber = 3

Field number for the "value_prefix" field.

Field Value
Type Description
Int32

Properties

Descriptor

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

Header

public string Header { get; set; }

Specifies HTTP header name to extract JWT token.

Property Value
Type Description
String

InCase

public JwtLocation.InOneofCase InCase { get; }
Property Value
Type Description
JwtLocation.InOneofCase

Parser

public static Protobuf.MessageParser<JwtLocation> Parser { get; }
Property Value
Type Description
Protobuf.MessageParser<JwtLocation>

Query

public string Query { get; set; }

Specifies URL query parameter name to extract JWT token.

Property Value
Type Description
String

ValuePrefix

public string ValuePrefix { get; set; }

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed.

For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Property Value
Type Description
String

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
Int32

ClearIn()

public void ClearIn()

Clone()

public JwtLocation Clone()
Returns
Type Description
JwtLocation

Equals(JwtLocation)

public bool Equals(JwtLocation other)
Parameter
Name Description
other JwtLocation
Returns
Type Description
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
Name Description
other Object
Returns
Type Description
Boolean

GetHashCode()

public override int GetHashCode()
Returns
Type Description
Int32

MergeFrom(JwtLocation)

public void MergeFrom(JwtLocation other)
Parameter
Name Description
other JwtLocation

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
Name Description
input Protobuf.CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
Name Description
output Protobuf.CodedOutputStream