Class: OCI::Identity::Models::OAuth2ClientCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/o_auth2_client_credential.rb

Overview

User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2ClientCredential

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :scopes (Array<OCI::Identity::Models::FullyQualifiedScope>) —

    The value to assign to the #scopes property

  • :password (String) —

    The value to assign to the #password property

  • :user_id (String) —

    The value to assign to the #user_id property

  • :expires_on (DateTime) —

    The value to assign to the #expires_on property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 122

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

  self.expires_on = attributes[:'expiresOn'] if attributes[:'expiresOn']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the Oauth credential.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 47

def compartment_id
  @compartment_id
end

#description ⇒ String

The description of the Oauth credential.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 55

def description
  @description
end

#expires_on ⇒ DateTime

Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 39

def expires_on
  @expires_on
end

#id ⇒ String

The OCID of the Oauth credential.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 43

def id
  @id
end

#lifecycle_state ⇒ String

The credential's current state. After creating a Oauth credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 61

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name of the Oauth credential.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 51

def name
  @name
end

#password ⇒ String

Returned during create and update with password reset requests.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 27

def password
  @password
end

#scopes ⇒ Array<OCI::Identity::Models::FullyQualifiedScope>

Allowed scopes for the given oauth credential.

Returns:



23
24
25
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 23

def scopes
  @scopes
end

#time_created ⇒ DateTime

Date and time the OAuth2ClientCredential object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 68

def time_created
  @time_created
end

#user_id ⇒ String

The OCID of the user the Oauth credential belongs to.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 31

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'scopes': :'scopes',
    'password': :'password',
    'user_id': :'userId',
    'expires_on': :'expiresOn',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'scopes': :'Array<OCI::Identity::Models::FullyQualifiedScope>',
    'password': :'String',
    'user_id': :'String',
    'expires_on': :'DateTime',
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime'
    # 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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 189

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

  self.class == other.class &&
    scopes == other.scopes &&
    password == other.password &&
    user_id == other.user_id &&
    expires_on == other.expires_on &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 228

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


208
209
210
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 208

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 217

def hash
  [scopes, password, user_id, expires_on, id, compartment_id, name, description, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 261

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



255
256
257
 
# File 'lib/oci/identity/models/o_auth2_client_credential.rb', line 255

def to_s
  to_hash.to_s
end