Class: Google::Api::JwtLocation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/auth.rb

Overview

Specifies a location to extract JWT from an API request.

Instance Attribute Summary collapse

Instance Attribute Details

Returns Specifies cookie name to extract JWT token.

Returns:

  • (::String) —

    Specifies cookie name to extract JWT token.



103
104
105
106
 
# File 'proto_docs/google/api/auth.rb', line 103

class JwtLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#header ⇒ ::String

Returns Specifies HTTP header name to extract JWT token.

Returns:

  • (::String) —

    Specifies HTTP header name to extract JWT token.



103
104
105
106
 
# File 'proto_docs/google/api/auth.rb', line 103

class JwtLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns Specifies URL query parameter name to extract JWT token.

Returns:

  • (::String) —

    Specifies URL query parameter name to extract JWT token.



103
104
105
106
 
# File 'proto_docs/google/api/auth.rb', line 103

class JwtLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value_prefix ⇒ ::String

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



103
104
105
106
 
# File 'proto_docs/google/api/auth.rb', line 103

class JwtLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end