Class: OCI::Apigateway::Models::TokenAuthenticationPolicy

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

Overview

Validate a token present in the header or query parameter. 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 = {}) ⇒ TokenAuthenticationPolicy

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
128
129
130
131
132
133
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 86

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

  attributes['type'] = 'TOKEN_AUTHENTICATION'

  super(attributes)

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

  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.token_auth_scheme = attributes[:'tokenAuthScheme'] if attributes[:'tokenAuthScheme']

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

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

  self.max_clock_skew_in_seconds = attributes[:'maxClockSkewInSeconds'] if attributes[:'maxClockSkewInSeconds']
  self.max_clock_skew_in_seconds = 0.0 if max_clock_skew_in_seconds.nil? && !attributes.key?(:'maxClockSkewInSeconds') # rubocop:disable Style/StringLiterals

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

  self.max_clock_skew_in_seconds = attributes[:'max_clock_skew_in_seconds'] if attributes[:'max_clock_skew_in_seconds']
  self.max_clock_skew_in_seconds = 0.0 if max_clock_skew_in_seconds.nil? && !attributes.key?(:'maxClockSkewInSeconds') && !attributes.key?(:'max_clock_skew_in_seconds') # rubocop:disable Style/StringLiterals

  self.validation_policy = attributes[:'validationPolicy'] if attributes[:'validationPolicy']

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

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

  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

#max_clock_skew_in_seconds ⇒ Float

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Returns:

  • (Float) 


32
33
34
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 32

def max_clock_skew_in_seconds
  @max_clock_skew_in_seconds
end

#token_auth_scheme ⇒ String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 26

def token_auth_scheme
  @token_auth_scheme
end

#token_header ⇒ String

The name of the header containing the authentication token.

Returns:

  • (String) 


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

def token_header
  @token_header
end

#token_query_param ⇒ String

The name of the query parameter containing the authentication token.

Returns:

  • (String) 


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

def token_query_param
  @token_query_param
end

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

Returns:



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

def validation_failure_policy
  @validation_failure_policy
end

#validation_policy ⇒ OCI::Apigateway::Models::TokenAuthenticationValidationPolicy

This attribute is required.

Returns:



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

def validation_policy
  @validation_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/token_authentication_policy.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_anonymous_access_allowed': :'isAnonymousAccessAllowed',
    'type': :'type',
    'token_header': :'tokenHeader',
    'token_query_param': :'tokenQueryParam',
    'token_auth_scheme': :'tokenAuthScheme',
    'max_clock_skew_in_seconds': :'maxClockSkewInSeconds',
    'validation_policy': :'validationPolicy',
    '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/token_authentication_policy.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_anonymous_access_allowed': :'BOOLEAN',
    'type': :'String',
    'token_header': :'String',
    'token_query_param': :'String',
    'token_auth_scheme': :'String',
    'max_clock_skew_in_seconds': :'Float',
    'validation_policy': :'OCI::Apigateway::Models::TokenAuthenticationValidationPolicy',
    '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



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 142

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

  self.class == other.class &&
    is_anonymous_access_allowed == other.is_anonymous_access_allowed &&
    type == other.type &&
    token_header == other.token_header &&
    token_query_param == other.token_query_param &&
    token_auth_scheme == other.token_auth_scheme &&
    max_clock_skew_in_seconds == other.max_clock_skew_in_seconds &&
    validation_policy == other.validation_policy &&
    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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 179

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 168

def hash
  [is_anonymous_access_allowed, type, token_header, token_query_param, token_auth_scheme, max_clock_skew_in_seconds, validation_policy, 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



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 212

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



206
207
208
 
# File 'lib/oci/apigateway/models/token_authentication_policy.rb', line 206

def to_s
  to_hash.to_s
end