Class: OCI::Apigateway::Models::JwtAuthenticationPolicy

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

Overview

Validate a JWT 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 = {}) ⇒ JwtAuthenticationPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 100

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

  attributes['type'] = 'JWT_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.issuers = attributes[:'issuers'] if attributes[:'issuers']

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

  self.verify_claims = attributes[:'verifyClaims'] if attributes[:'verifyClaims']

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

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

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

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

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

Instance Attribute Details

#audiencesArray<String>

[Required] The list of intended recipients for the token.

Returns:

  • (Array<String>)


33
34
35
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 33

def audiences
  @audiences
end

#issuersArray<String>

[Required] A list of parties that could have issued the token.

Returns:

  • (Array<String>)


29
30
31
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 29

def issuers
  @issuers
end

#max_clock_skew_in_secondsFloat

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

Returns:

  • (Float)


43
44
45
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 43

def max_clock_skew_in_seconds
  @max_clock_skew_in_seconds
end

#public_keysOCI::Apigateway::Models::PublicKeySet

This attribute is required.



47
48
49
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 47

def public_keys
  @public_keys
end

#token_auth_schemeString

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

Returns:

  • (String)


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

def token_auth_scheme
  @token_auth_scheme
end

#token_headerString

The name of the header containing the authentication token.

Returns:

  • (String)


15
16
17
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 15

def token_header
  @token_header
end

#token_query_paramString

The name of the query parameter containing the authentication token.

Returns:

  • (String)


19
20
21
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 19

def token_query_param
  @token_query_param
end

#verify_claimsArray<OCI::Apigateway::Models::JsonWebTokenClaim>

A list of claims which should be validated to consider the token valid.



37
38
39
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 37

def verify_claims
  @verify_claims
end

Class Method Details

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 50

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',
    'issuers': :'issuers',
    'audiences': :'audiences',
    'verify_claims': :'verifyClaims',
    'max_clock_skew_in_seconds': :'maxClockSkewInSeconds',
    'public_keys': :'publicKeys'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 68

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',
    'issuers': :'Array<String>',
    'audiences': :'Array<String>',
    'verify_claims': :'Array<OCI::Apigateway::Models::JsonWebTokenClaim>',
    'max_clock_skew_in_seconds': :'Float',
    'public_keys': :'OCI::Apigateway::Models::PublicKeySet'
    # 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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 160

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 &&
    issuers == other.issuers &&
    audiences == other.audiences &&
    verify_claims == other.verify_claims &&
    max_clock_skew_in_seconds == other.max_clock_skew_in_seconds &&
    public_keys == other.public_keys
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 199

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


179
180
181
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 179

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



188
189
190
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 188

def hash
  [is_anonymous_access_allowed, type, token_header, token_query_param, token_auth_scheme, issuers, audiences, verify_claims, max_clock_skew_in_seconds, public_keys].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 232

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



226
227
228
# File 'lib/oci/apigateway/models/jwt_authentication_policy.rb', line 226

def to_s
  to_hash.to_s
end