Reference documentation and code samples for the Google API Common Protos Client class JwtLocation.
Specifies a location to extract JWT from an API request.
Generated from protobuf message google.api.JwtLocation
Namespace
Google \ ApiMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ header
string
Specifies HTTP header name to extract JWT token.
↳ query
string
Specifies URL query parameter name to extract JWT token.
↳ cookie
string
Specifies cookie name to extract JWT token.
↳ value_prefix
string
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.
getHeader
Specifies HTTP header name to extract JWT token.
string
hasHeader
setHeader
Specifies HTTP header name to extract JWT token.
var
string
$this
getQuery
Specifies URL query parameter name to extract JWT token.
string
hasQuery
setQuery
Specifies URL query parameter name to extract JWT token.
var
string
$this
getCookie
Specifies cookie name to extract JWT token.
string
hasCookie
setCookie
Specifies cookie name to extract JWT token.
var
string
$this
getValuePrefix
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.
string
setValuePrefix
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.
var
string
$this
getIn
string