Class JwtLocation (2.17.0)

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

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

Fields

CookieFieldNumber

  public 
  
 const 
  
 int 
  
 CookieFieldNumber 
  
 = 
  
 4 
 

Field number for the "cookie" field.

Field Value
Type
Description
int

HeaderFieldNumber

  public 
  
 const 
  
 int 
  
 HeaderFieldNumber 
  
 = 
  
 1 
 

Field number for the "header" field.

Field Value
Type
Description
int

QueryFieldNumber

  public 
  
 const 
  
 int 
  
 QueryFieldNumber 
  
 = 
  
 2 
 

Field number for the "query" field.

Field Value
Type
Description
int

ValuePrefixFieldNumber

  public 
  
 const 
  
 int 
  
 ValuePrefixFieldNumber 
  
 = 
  
 3 
 

Field number for the "value_prefix" field.

Field Value
Type
Description
int

Properties

 public string Cookie { get; set; } 

Specifies cookie name to extract JWT token.

Property Value
Type
Description

Descriptor

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

HasCookie

 public bool HasCookie { get; } 

Gets whether the "cookie" field is set

Property Value
Type
Description

HasHeader

 public bool HasHeader { get; } 

Gets whether the "header" field is set

Property Value
Type
Description

HasQuery

 public bool HasQuery { get; } 

Gets whether the "query" field is set

Property Value
Type
Description

Header

 public string Header { get; set; } 

Specifies HTTP header name to extract JWT token.

Property Value
Type
Description

InCase

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

Parser

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

Query

 public string Query { get; set; } 

Specifies URL query parameter name to extract JWT token.

Property Value
Type
Description

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

Methods

CalculateSize()

 public int CalculateSize() 
Returns
Type
Description
int

ClearCookie()

 public void ClearCookie() 

Clears the value of the oneof if it's currently set to "cookie"

ClearHeader()

 public void ClearHeader() 

Clears the value of the oneof if it's currently set to "header"

ClearIn()

 public void ClearIn() 

ClearQuery()

 public void ClearQuery() 

Clears the value of the oneof if it's currently set to "query"

Clone()

 public JwtLocation Clone() 
Returns
Type
Description

Equals(JwtLocation)

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

Equals(object)

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

GetHashCode()

 public override int GetHashCode() 
Returns
Type
Description
int
Overrides

MergeFrom(JwtLocation)

 public void MergeFrom(JwtLocation other) 
Parameter
Name
Description
other

MergeFrom(CodedInputStream)

 public void MergeFrom(CodedInputStream input) 
Parameter
Name
Description

ToString()

 public override string ToString() 
Returns
Type
Description
Overrides

WriteTo(CodedOutputStream)

 public void WriteTo(CodedOutputStream output) 
Parameter
Name
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: