Class: OCI::IdentityDomains::Models::AppScopes

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

Overview

Scopes defined by this App. Used when this App acts as an OAuth Resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppScopes

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

  • :fqs (String) —

    The value to assign to the #fqs property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :requires_consent (BOOLEAN) —

    The value to assign to the #requires_consent property

  • :read_only (BOOLEAN) —

    The value to assign to the #read_only property



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
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 138

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.requires_consent = attributes[:'requiresConsent'] unless attributes[:'requiresConsent'].nil?

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

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

  self.read_only = attributes[:'readOnly'] unless attributes[:'readOnly'].nil?

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

  self.read_only = attributes[:'read_only'] unless attributes[:'read_only'].nil?
end

Instance Attribute Details

#description ⇒ String

OAuth scope description

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

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

OAuth scope display name

Added In: 19.2.1

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

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 67

def display_name
  @display_name
end

#fqs ⇒ String

The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource.

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

Returns:

  • (String) 


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

def fqs
  @fqs
end

#read_only ⇒ BOOLEAN

If true, indicates that this value must be protected.

Added In: 18.2.2

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

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 96

def read_only
  @read_only
end

#requires_consent ⇒ BOOLEAN

If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource.

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

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 81

def requires_consent
  @requires_consent
end

#value ⇒ String

[Required] OAuth scope.

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 23

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'fqs': :'fqs',
    'description': :'description',
    'display_name': :'displayName',
    'requires_consent': :'requiresConsent',
    'read_only': :'readOnly'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'fqs': :'String',
    'description': :'String',
    'display_name': :'String',
    'requires_consent': :'BOOLEAN',
    'read_only': :'BOOLEAN'
    # 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



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 176

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

  self.class == other.class &&
    value == other.value &&
    fqs == other.fqs &&
    description == other.description &&
    display_name == other.display_name &&
    requires_consent == other.requires_consent &&
    read_only == other.read_only
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 211

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


191
192
193
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 200

def hash
  [value, fqs, description, display_name, requires_consent, read_only].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 244

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



238
239
240
 
# File 'lib/oci/identity_domains/models/app_scopes.rb', line 238

def to_s
  to_hash.to_s
end