Class: OCI::IdentityDomains::Models::AppExtensionFormFillAppApp

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb

Overview

This extension provides attributes for Form-Fill facet of App

Constant Summary collapse

FORM_TYPE_ENUM = 
[
  FORM_TYPE_WEB_APPLICATION = 'WebApplication'.freeze,
  FORM_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FORM_CRED_METHOD_ENUM = 
[
  FORM_CRED_METHOD_ADMIN_SETS_CREDENTIALS = 'ADMIN_SETS_CREDENTIALS'.freeze,
  FORM_CRED_METHOD_ADMIN_SETS_SHARED_CREDENTIALS = 'ADMIN_SETS_SHARED_CREDENTIALS'.freeze,
  FORM_CRED_METHOD_USER_SETS_PASSWORD_ONLY = 'USER_SETS_PASSWORD_ONLY'.freeze,
  FORM_CRED_METHOD_USER_SETS_CREDENTIALS = 'USER_SETS_CREDENTIALS'.freeze,
  FORM_CRED_METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppExtensionFormFillAppApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 199

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

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

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

  self.form_credential_sharing_group_id = attributes[:'formCredentialSharingGroupID'] if attributes[:'formCredentialSharingGroupID']

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

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

  self.reveal_password_on_form = attributes[:'revealPasswordOnForm'] unless attributes[:'revealPasswordOnForm'].nil?

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

  self.reveal_password_on_form = attributes[:'reveal_password_on_form'] unless attributes[:'reveal_password_on_form'].nil?

  self.user_name_form_template = attributes[:'userNameFormTemplate'] if attributes[:'userNameFormTemplate']

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

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

  self.user_name_form_expression = attributes[:'userNameFormExpression'] if attributes[:'userNameFormExpression']

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

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

  self.form_cred_method = attributes[:'formCredMethod'] if attributes[:'formCredMethod']

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

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

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

  self.sync_from_template = attributes[:'syncFromTemplate'] unless attributes[:'syncFromTemplate'].nil?

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

  self.sync_from_template = attributes[:'sync_from_template'] unless attributes[:'sync_from_template'].nil?

  self.form_fill_url_match = attributes[:'formFillUrlMatch'] if attributes[:'formFillUrlMatch']

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

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

Instance Attribute Details

#configuration ⇒ String

FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 120

def configuration
  @configuration
end

#form_cred_method ⇒ String

Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 107

def form_cred_method
  @form_cred_method
end

#form_credential_sharing_group_id ⇒ String

Credential Sharing Group to which this form-fill application belongs.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 51

def form_credential_sharing_group_id
  @form_credential_sharing_group_id
end

#form_fill_url_match ⇒ Array<OCI::IdentityDomains::Models::AppFormFillUrlMatch>

A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl.

SCIM++ Properties: - idcsCompositeKey: [formUrl] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Returns:



148
149
150
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 148

def form_fill_url_match
  @form_fill_url_match
end

#form_type ⇒ String

Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 37

def form_type
  @form_type
end

#reveal_password_on_form ⇒ BOOLEAN

If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication.

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 64

def reveal_password_on_form
  @reveal_password_on_form
end

#sync_from_template ⇒ BOOLEAN

If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate on which this App is based has disabled inheritance for these Form-Fill-related attributes.

Added In: 17.4.2

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


135
136
137
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 135

def sync_from_template
  @sync_from_template
end

#user_name_form_expression ⇒ String

Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 93

def user_name_form_expression
  @user_name_form_expression
end

#user_name_form_template ⇒ String

Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user.

SCIM++ Properties: - caseExact: false - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 79

def user_name_form_template
  @user_name_form_template
end

Class Method Details

.attribute_map ⇒ Object

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 151

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'form_type': :'formType',
    'form_credential_sharing_group_id': :'formCredentialSharingGroupID',
    'reveal_password_on_form': :'revealPasswordOnForm',
    'user_name_form_template': :'userNameFormTemplate',
    'user_name_form_expression': :'userNameFormExpression',
    'form_cred_method': :'formCredMethod',
    'configuration': :'configuration',
    'sync_from_template': :'syncFromTemplate',
    'form_fill_url_match': :'formFillUrlMatch'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 168

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'form_type': :'String',
    'form_credential_sharing_group_id': :'String',
    'reveal_password_on_form': :'BOOLEAN',
    'user_name_form_template': :'String',
    'user_name_form_expression': :'String',
    'form_cred_method': :'String',
    'configuration': :'String',
    'sync_from_template': :'BOOLEAN',
    'form_fill_url_match': :'Array<OCI::IdentityDomains::Models::AppFormFillUrlMatch>'
    # 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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 289

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

  self.class == other.class &&
    form_type == other.form_type &&
    form_credential_sharing_group_id == other.form_credential_sharing_group_id &&
    reveal_password_on_form == other.reveal_password_on_form &&
    user_name_form_template == other.user_name_form_template &&
    user_name_form_expression == other.user_name_form_expression &&
    form_cred_method == other.form_cred_method &&
    configuration == other.configuration &&
    sync_from_template == other.sync_from_template &&
    form_fill_url_match == other.form_fill_url_match
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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 327

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


307
308
309
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 307

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 316

def hash
  [form_type, form_credential_sharing_group_id, reveal_password_on_form, user_name_form_template, user_name_form_expression, form_cred_method, configuration, sync_from_template, form_fill_url_match].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 360

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



354
355
356
 
# File 'lib/oci/identity_domains/models/app_extension_form_fill_app_app.rb', line 354

def to_s
  to_hash.to_s
end