Reference documentation and code samples for the Service Usage V1 API class Google::Api::JwtLocation.
Specifies a location to extract JWT from an API request.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#header
def header() -> ::String
Returns
- (::String) — Specifies HTTP header name to extract JWT token.
#header=
def header=(value) -> ::String
Parameter
- value (::String) — Specifies HTTP header name to extract JWT token.
Returns
- (::String) — Specifies HTTP header name to extract JWT token.
#query
def query() -> ::String
Returns
- (::String) — Specifies URL query parameter name to extract JWT token.
#query=
def query=(value) -> ::String
Parameter
- value (::String) — Specifies URL query parameter name to extract JWT token.
Returns
- (::String) — Specifies URL query parameter name to extract JWT token.
#value_prefix
def value_prefix() -> ::String
Returns
-
(::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.
#value_prefix=
def value_prefix=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.