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):



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 62

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']
end

Instance Attribute Details

#function_idString

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

Returns:

  • (String)


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

def function_id
  @function_id
end

#token_headerString

The name of the header containing the authentication token.

Returns:

  • (String)


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

def token_header
  @token_header
end

#token_query_paramString

The name of the query parameter containing the authentication token.

Returns:

  • (String)


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

def token_query_param
  @token_query_param
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
36
37
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 27

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 40

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



98
99
100
101
102
103
104
105
106
107
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 98

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 132

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


112
113
114
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 112

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



121
122
123
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 121

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 165

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



159
160
161
# File 'lib/oci/apigateway/models/custom_authentication_policy.rb', line 159

def to_s
  to_hash.to_s
end