Class: OCI::Oda::Models::UpdateAuthenticationProviderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/update_authentication_provider_details.rb

Overview

Properties to update an Authentication Provider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAuthenticationProviderDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 134

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

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

  self.token_endpoint_url = attributes[:'tokenEndpointUrl'] if attributes[:'tokenEndpointUrl']

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

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

  self.authorization_endpoint_url = attributes[:'authorizationEndpointUrl'] if attributes[:'authorizationEndpointUrl']

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

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

  self.short_authorization_code_request_url = attributes[:'shortAuthorizationCodeRequestUrl'] if attributes[:'shortAuthorizationCodeRequestUrl']

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

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

  self.revoke_token_endpoint_url = attributes[:'revokeTokenEndpointUrl'] if attributes[:'revokeTokenEndpointUrl']

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

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

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.client_secret = attributes[:'clientSecret'] if attributes[:'clientSecret']

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

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

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

  self.subject_claim = attributes[:'subjectClaim'] if attributes[:'subjectClaim']

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

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

  self.refresh_token_retention_period_in_days = attributes[:'refreshTokenRetentionPeriodInDays'] if attributes[:'refreshTokenRetentionPeriodInDays']

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

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

  self.redirect_url = attributes[:'redirectUrl'] if attributes[:'redirectUrl']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#authorization_endpoint_url ⇒ String

The IDPs URL for the page that users authenticate with by entering the user name and password.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 17

def authorization_endpoint_url
  @authorization_endpoint_url
end

#client_id ⇒ String

The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 37

def client_id
  @client_id
end

#client_secret ⇒ String

The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 43

def client_secret
  @client_secret
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


74
75
76
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 74

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


68
69
70
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 68

def freeform_tags
  @freeform_tags
end

#redirect_url ⇒ String

The OAuth Redirect URL.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 62

def redirect_url
  @redirect_url
end

#refresh_token_retention_period_in_days ⇒ Integer

The number of days to keep the refresh token in the Digital Assistant cache.

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 58

def refresh_token_retention_period_in_days
  @refresh_token_retention_period_in_days
end

#revoke_token_endpoint_url ⇒ String

If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 31

def revoke_token_endpoint_url
  @revoke_token_endpoint_url
end

#scopes ⇒ String

A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope thatu2019s necessary to get the refresh token (typically offline_access).

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 50

def scopes
  @scopes
end

#short_authorization_code_request_url ⇒ String

A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 24

def short_authorization_code_request_url
  @short_authorization_code_request_url
end

#subject_claim ⇒ String

The access-token profile claim to use to identify the user.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 54

def subject_claim
  @subject_claim
end

#token_endpoint_url ⇒ String

The IDPs URL for requesting access tokens.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 13

def token_endpoint_url
  @token_endpoint_url
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'token_endpoint_url': :'tokenEndpointUrl',
    'authorization_endpoint_url': :'authorizationEndpointUrl',
    'short_authorization_code_request_url': :'shortAuthorizationCodeRequestUrl',
    'revoke_token_endpoint_url': :'revokeTokenEndpointUrl',
    'client_id': :'clientId',
    'client_secret': :'clientSecret',
    'scopes': :'scopes',
    'subject_claim': :'subjectClaim',
    'refresh_token_retention_period_in_days': :'refreshTokenRetentionPeriodInDays',
    'redirect_url': :'redirectUrl',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'token_endpoint_url': :'String',
    'authorization_endpoint_url': :'String',
    'short_authorization_code_request_url': :'String',
    'revoke_token_endpoint_url': :'String',
    'client_id': :'String',
    'client_secret': :'String',
    'scopes': :'String',
    'subject_claim': :'String',
    'refresh_token_retention_period_in_days': :'Integer',
    'redirect_url': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 216

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

  self.class == other.class &&
    token_endpoint_url == other.token_endpoint_url &&
    authorization_endpoint_url == other.authorization_endpoint_url &&
    short_authorization_code_request_url == other.short_authorization_code_request_url &&
    revoke_token_endpoint_url == other.revoke_token_endpoint_url &&
    client_id == other.client_id &&
    client_secret == other.client_secret &&
    scopes == other.scopes &&
    subject_claim == other.subject_claim &&
    refresh_token_retention_period_in_days == other.refresh_token_retention_period_in_days &&
    redirect_url == other.redirect_url &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 257

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


237
238
239
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 237

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



246
247
248
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 246

def hash
  [token_endpoint_url, authorization_endpoint_url, short_authorization_code_request_url, revoke_token_endpoint_url, client_id, client_secret, scopes, subject_claim, refresh_token_retention_period_in_days, redirect_url, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 290

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



284
285
286
 
# File 'lib/oci/oda/models/update_authentication_provider_details.rb', line 284

def to_s
  to_hash.to_s
end