Service Management V1 API - Class Google::Api::JwtLocation (v1.2.0)

Reference documentation and code samples for the Service Management 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

def cookie() -> ::String
Returns
  • (::String) — Specifies cookie name to extract JWT token.

    Note: The following fields are mutually exclusive: cookie, header, query. If a field in that set is populated, all other fields in the set will automatically be cleared.

def cookie=(value) -> ::String
Parameter
  • value (::String) — Specifies cookie name to extract JWT token.

    Note: The following fields are mutually exclusive: cookie, header, query. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Specifies cookie name to extract JWT token.

    Note: The following fields are mutually exclusive: cookie, header, query. If a field in that set is populated, all other fields in the set will automatically be cleared.

#header

def header() -> ::String
Returns
  • (::String) — Specifies HTTP header name to extract JWT token.

    Note: The following fields are mutually exclusive: header, query, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

#header=

def header=(value) -> ::String
Parameter
  • value (::String) — Specifies HTTP header name to extract JWT token.

    Note: The following fields are mutually exclusive: header, query, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Specifies HTTP header name to extract JWT token.

    Note: The following fields are mutually exclusive: header, query, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

#query

def query() -> ::String
Returns
  • (::String) — Specifies URL query parameter name to extract JWT token.

    Note: The following fields are mutually exclusive: query, header, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Specifies URL query parameter name to extract JWT token.

    Note: The following fields are mutually exclusive: query, header, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Specifies URL query parameter name to extract JWT token.

    Note: The following fields are mutually exclusive: query, header, cookie. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.