Class: OCI::IdentityDomains::Models::AccountMgmtInfoApp

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

Overview

Application on which the account is based

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountMgmtInfoApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :ref (String) —

    The value to assign to the #ref property

  • :display (String) —

    The value to assign to the #display property

  • :description (String) —

    The value to assign to the #description property

  • :is_login_target (BOOLEAN) —

    The value to assign to the #is_login_target property

  • :show_in_my_apps (BOOLEAN) —

    The value to assign to the #show_in_my_apps property

  • :active (BOOLEAN) —

    The value to assign to the #active property

  • :login_mechanism (String) —

    The value to assign to the #login_mechanism property

  • :app_icon (String) —

    The value to assign to the #app_icon property

  • :app_thumbnail (String) —

    The value to assign to the #app_thumbnail property

  • :is_unmanaged_app (BOOLEAN) —

    The value to assign to the #is_unmanaged_app property

  • :is_managed_app (BOOLEAN) —

    The value to assign to the #is_managed_app property

  • :is_alias_app (BOOLEAN) —

    The value to assign to the #is_alias_app property

  • :is_opc_service (BOOLEAN) —

    The value to assign to the #is_opc_service property

  • :service_type_urn (String) —

    The value to assign to the #service_type_urn property

  • :is_authoritative (BOOLEAN) —

    The value to assign to the #is_authoritative property

  • :meter_as_opc_service (BOOLEAN) —

    The value to assign to the #meter_as_opc_service property

  • :is_o_auth_resource (BOOLEAN) —

    The value to assign to the #is_o_auth_resource property

  • :audience (String) —

    The value to assign to the #audience property



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 361

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

  self.ref = attributes[:'$ref'] if attributes[:'$ref']

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

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

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

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

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

  self.show_in_my_apps = attributes[:'showInMyApps'] unless attributes[:'showInMyApps'].nil?

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

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

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

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

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

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

  self.app_icon = attributes[:'appIcon'] if attributes[:'appIcon']

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

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

  self.app_thumbnail = attributes[:'appThumbnail'] if attributes[:'appThumbnail']

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

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

  self.is_unmanaged_app = attributes[:'isUnmanagedApp'] unless attributes[:'isUnmanagedApp'].nil?

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

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

  self.is_managed_app = attributes[:'isManagedApp'] unless attributes[:'isManagedApp'].nil?

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

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

  self.is_alias_app = attributes[:'isAliasApp'] unless attributes[:'isAliasApp'].nil?

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

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

  self.is_opc_service = attributes[:'isOPCService'] unless attributes[:'isOPCService'].nil?

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

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

  self.service_type_urn = attributes[:'serviceTypeURN'] if attributes[:'serviceTypeURN']

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

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

  self.is_authoritative = attributes[:'isAuthoritative'] unless attributes[:'isAuthoritative'].nil?

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

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

  self.meter_as_opc_service = attributes[:'meterAsOPCService'] unless attributes[:'meterAsOPCService'].nil?

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

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

  self.is_o_auth_resource = attributes[:'isOAuthResource'] unless attributes[:'isOAuthResource'].nil?

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

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

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

Instance Attribute Details

#active ⇒ BOOLEAN

If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App and only administrative operations can be performed.

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

Returns:

  • (BOOLEAN) 


113
114
115
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 113

def active
  @active
end

#app_icon ⇒ String

Application icon.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 139

def app_icon
  @app_icon
end

#app_thumbnail ⇒ String

Application thumbnail.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


152
153
154
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 152

def app_thumbnail
  @app_thumbnail
end

#audience ⇒ String

The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope.

Added In: 18.4.2

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


280
281
282
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 280

def audience
  @audience
end

#description ⇒ String

Application description

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 72

def description
  @description
end

#display ⇒ String

Application display name

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 58

def display
  @display
end

#is_alias_app ⇒ BOOLEAN

If true, this App is an AliasApp and it cannot be granted to an end user directly

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

Returns:

  • (BOOLEAN) 


193
194
195
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 193

def is_alias_app
  @is_alias_app
end

#is_authoritative ⇒ BOOLEAN

If true, sync from the managed app will be performed as authoritative sync.

Added In: 17.4.6

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

Returns:

  • (BOOLEAN) 


234
235
236
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 234

def is_authoritative
  @is_authoritative
end

#is_login_target ⇒ BOOLEAN

If true, this App allows runtime services to log end users in to this App automatically

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

Returns:

  • (BOOLEAN) 


85
86
87
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 85

def 
  @is_login_target
end

#is_managed_app ⇒ BOOLEAN

If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App.

Added In: 17.4.6

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

Returns:

  • (BOOLEAN) 


180
181
182
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 180

def is_managed_app
  @is_managed_app
end

#is_o_auth_resource ⇒ BOOLEAN

If true, indicates that this application acts as an OAuth Resource.

Added In: 18.4.2

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

Returns:

  • (BOOLEAN) 


264
265
266
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 264

def is_o_auth_resource
  @is_o_auth_resource
end

#is_opc_service ⇒ BOOLEAN

If true, this application is an Oracle Public Cloud service-instance.

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

Returns:

  • (BOOLEAN) 


206
207
208
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 206

def is_opc_service
  @is_opc_service
end

#is_unmanaged_app ⇒ BOOLEAN

If true, indicates that this application accepts an Oracle Identity Cloud Service user as a login-identity (does not require an account) and relies on authorization of the user's memberships in AppRoles

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

Returns:

  • (BOOLEAN) 


165
166
167
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 165

def is_unmanaged_app
  @is_unmanaged_app
end

#login_mechanism ⇒ String

The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use the Security Assertion Markup Language protocol.

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


126
127
128
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 126

def 
  @login_mechanism
end

#meter_as_opc_service ⇒ BOOLEAN

If true, customer is not billed for runtime operations of the app.

Added In: 18.4.2

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

Returns:

  • (BOOLEAN) 


249
250
251
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 249

def meter_as_opc_service
  @meter_as_opc_service
end

#ref ⇒ String

Application URI

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

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 45

def ref
  @ref
end

#service_type_urn ⇒ String

This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


219
220
221
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 219

def service_type_urn
  @service_type_urn
end

#show_in_my_apps ⇒ BOOLEAN

If true, this App will be displayed in the MyApps page of each end-user who has access to the App.

Added In: 18.1.2

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

Returns:

  • (BOOLEAN) 


100
101
102
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 100

def show_in_my_apps
  @show_in_my_apps
end

#value ⇒ String

[Required] Application identifier

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 32

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 283

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'ref': :'$ref',
    'display': :'display',
    'description': :'description',
    'is_login_target': :'isLoginTarget',
    'show_in_my_apps': :'showInMyApps',
    'active': :'active',
    'login_mechanism': :'loginMechanism',
    'app_icon': :'appIcon',
    'app_thumbnail': :'appThumbnail',
    'is_unmanaged_app': :'isUnmanagedApp',
    'is_managed_app': :'isManagedApp',
    'is_alias_app': :'isAliasApp',
    'is_opc_service': :'isOPCService',
    'service_type_urn': :'serviceTypeURN',
    'is_authoritative': :'isAuthoritative',
    'meter_as_opc_service': :'meterAsOPCService',
    'is_o_auth_resource': :'isOAuthResource',
    'audience': :'audience'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 310

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'ref': :'String',
    'display': :'String',
    'description': :'String',
    'is_login_target': :'BOOLEAN',
    'show_in_my_apps': :'BOOLEAN',
    'active': :'BOOLEAN',
    'login_mechanism': :'String',
    'app_icon': :'String',
    'app_thumbnail': :'String',
    'is_unmanaged_app': :'BOOLEAN',
    'is_managed_app': :'BOOLEAN',
    'is_alias_app': :'BOOLEAN',
    'is_opc_service': :'BOOLEAN',
    'service_type_urn': :'String',
    'is_authoritative': :'BOOLEAN',
    'meter_as_opc_service': :'BOOLEAN',
    'is_o_auth_resource': :'BOOLEAN',
    'audience': :'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



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 465

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

  self.class == other.class &&
    value == other.value &&
    ref == other.ref &&
    display == other.display &&
    description == other.description &&
     == other. &&
    show_in_my_apps == other.show_in_my_apps &&
    active == other.active &&
     == other. &&
    app_icon == other.app_icon &&
    app_thumbnail == other.app_thumbnail &&
    is_unmanaged_app == other.is_unmanaged_app &&
    is_managed_app == other.is_managed_app &&
    is_alias_app == other.is_alias_app &&
    is_opc_service == other.is_opc_service &&
    service_type_urn == other.service_type_urn &&
    is_authoritative == other.is_authoritative &&
    meter_as_opc_service == other.meter_as_opc_service &&
    is_o_auth_resource == other.is_o_auth_resource &&
    audience == other.audience
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



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 513

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


493
494
495
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 493

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



502
503
504
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 502

def hash
  [value, ref, display, description, , show_in_my_apps, active, , app_icon, app_thumbnail, is_unmanaged_app, is_managed_app, is_alias_app, is_opc_service, service_type_urn, is_authoritative, meter_as_opc_service, is_o_auth_resource, audience].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



546
547
548
549
550
551
552
553
554
555
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 546

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



540
541
542
 
# File 'lib/oci/identity_domains/models/account_mgmt_info_app.rb', line 540

def to_s
  to_hash.to_s
end