Class: OCI::IdentityDomains::Models::AppThreeLeggedOAuthCredential

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

Overview

The value of this attribute persists any OAuth access token that the system uses to connect to this ManagedApp. The system obtains this access token using an OAuth protocol flow that could be two-legged or three-legged. A two-legged flow involves only the requester and the server. A three-legged flow also requires the consent of a user – in this case the consent of an administrator.

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: complex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppThreeLeggedOAuthCredential

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :access_token (String) —

    The value to assign to the #access_token property

  • :refresh_token (String) —

    The value to assign to the #refresh_token property

  • :access_token_expiry (String) —

    The value to assign to the #access_token_expiry property



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 94

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

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

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

  self.refresh_token = attributes[:'refreshToken'] if attributes[:'refreshToken']

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

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

  self.access_token_expiry = attributes[:'accessTokenExpiry'] if attributes[:'accessTokenExpiry']

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

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

Instance Attribute Details

#access_token ⇒ String

Access Token

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

Returns:

  • (String) 


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

def access_token
  @access_token
end

#access_token_expiry ⇒ String

Access token expiry

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 61

def access_token_expiry
  @access_token_expiry
end

#refresh_token ⇒ String

Refresh Token

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 47

def refresh_token
  @refresh_token
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'access_token': :'accessToken',
    'refresh_token': :'refreshToken',
    'access_token_expiry': :'accessTokenExpiry'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 75

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'access_token': :'String',
    'refresh_token': :'String',
    'access_token_expiry': :'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



126
127
128
129
130
131
132
133
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 126

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

  self.class == other.class &&
    access_token == other.access_token &&
    refresh_token == other.refresh_token &&
    access_token_expiry == other.access_token_expiry
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 158

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


138
139
140
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 147

def hash
  [access_token, refresh_token, access_token_expiry].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 191

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



185
186
187
 
# File 'lib/oci/identity_domains/models/app_three_legged_o_auth_credential.rb', line 185

def to_s
  to_hash.to_s
end