Class: OCI::Apigateway::Models::CustomAuthenticationPolicy

Inherits:
AuthenticationPolicy show all
Defined in:
lib/oci/apigateway/models/custom_authentication_policy.rb

Overview

Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

Constant Summary

Constants inherited from AuthenticationPolicy

AuthenticationPolicy::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from AuthenticationPolicy

#is_anonymous_access_allowed, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AuthenticationPolicy

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CustomAuthenticationPolicy

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 86

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'CUSTOM_AUTHENTICATION'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.function_id = attributes[:'functionId'] if attributes[:'functionId']

  raise 'You cannot provide both :functionId and :function_id' if attributes.key?(:'functionId') && attributes.key?(:'function_id')

  self.function_id = attributes[:'function_id'] if attributes[:'function_id']

  self.token_header = attributes[:'tokenHeader'] if attributes[:'tokenHeader']

  raise 'You cannot provide both :tokenHeader and :token_header' if attributes.key?(:'tokenHeader') && attributes.key?(:'token_header')

  self.token_header = attributes[:'token_header'] if attributes[:'token_header']

  self.token_query_param = attributes[:'tokenQueryParam'] if attributes[:'tokenQueryParam']

  raise 'You cannot provide both :tokenQueryParam and :token_query_param' if attributes.key?(:'tokenQueryParam') && attributes.key?(:'token_query_param')

  self.token_query_param = attributes[:'token_query_param'] if attributes[:'token_query_param']

  self.parameters = attributes[:'parameters'] if attributes[:'parameters']

  self.cache_key = attributes[:'cacheKey'] if attributes[:'cacheKey']

  raise 'You cannot provide both :cacheKey and :cache_key' if attributes.key?(:'cacheKey') && attributes.key?(:'cache_key')

  self.cache_key = attributes[:'cache_key'] if attributes[:'cache_key']

  self.validation_failure_policy = attributes[:'validationFailurePolicy'] if attributes[:'validationFailurePolicy']

  raise 'You cannot provide both :validationFailurePolicy and :validation_failure_policy' if attributes.key?(:'validationFailurePolicy') && attributes.key?(:'validation_failure_policy')

  self.validation_failure_policy = attributes[:'validation_failure_policy'] if attributes[:'validation_failure_policy']
end

Instance Attribute Details

#cache_key ⇒ Array<String>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

Returns:

  • (Array<String>) 


36
37
38
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 36

def cache_key
  @cache_key
end

#function_id ⇒ String

[Required] The OCID of the Oracle Functions function resource.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 17

def function_id
  @function_id
end

#parameters ⇒ Hash<String, String>

A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {\"foo\": \"request.header[abc]\"}

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 31

def parameters
  @parameters
end

#token_header ⇒ String

The name of the header containing the authentication token.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 21

def token_header
  @token_header
end

#token_query_param ⇒ String

The name of the query parameter containing the authentication token.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 25

def token_query_param
  @token_query_param
end

#validation_failure_policy ⇒ OCI::Apigateway::Models::ValidationFailurePolicy

Returns:



39
40
41
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 39

def validation_failure_policy
  @validation_failure_policy
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_anonymous_access_allowed': :'isAnonymousAccessAllowed',
    'type': :'type',
    'function_id': :'functionId',
    'token_header': :'tokenHeader',
    'token_query_param': :'tokenQueryParam',
    'parameters': :'parameters',
    'cache_key': :'cacheKey',
    'validation_failure_policy': :'validationFailurePolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_anonymous_access_allowed': :'BOOLEAN',
    'type': :'String',
    'function_id': :'String',
    'token_header': :'String',
    'token_query_param': :'String',
    'parameters': :'Hash<String, String>',
    'cache_key': :'Array<String>',
    'validation_failure_policy': :'OCI::Apigateway::Models::ValidationFailurePolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 136

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    is_anonymous_access_allowed == other.is_anonymous_access_allowed &&
    type == other.type &&
    function_id == other.function_id &&
    token_header == other.token_header &&
    token_query_param == other.token_query_param &&
    parameters == other.parameters &&
    cache_key == other.cache_key &&
    validation_failure_policy == other.validation_failure_policy
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 173

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 162

def hash
  [is_anonymous_access_allowed, type, function_id, token_header, token_query_param, parameters, cache_key, validation_failure_policy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 206

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



200
201
202
 
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 200

def to_s
  to_hash.to_s
end