Class: OCI::Identity::Models::ApiKey

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

Overview

A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known as an API signing key. Specifically, this is the public key from the key pair. The private key remains with the user calling the API. For information about generating a key pair in the required PEM format, see Required Keys and OCIDs.

Important: This is not the SSH key for accessing compute instances.

Each user can have a maximum of three API signing keys.

For more information about user credentials, see User Credentials.

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 = {}) ⇒ ApiKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key_id (String)

    The value to assign to the #key_id property

  • :key_value (String)

    The value to assign to the #key_value property

  • :fingerprint (String)

    The value to assign to the #fingerprint property

  • :user_id (String)

    The value to assign to the #user_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer)

    The value to assign to the #inactive_status property



108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
# File 'lib/oci/identity/models/api_key.rb', line 108

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

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

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

  self.key_value = attributes[:'keyValue'] if attributes[:'keyValue']

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

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

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

  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.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']

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

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

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

Instance Attribute Details

#fingerprintString

The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).

Returns:

  • (String)


42
43
44
# File 'lib/oci/identity/models/api_key.rb', line 42

def fingerprint
  @fingerprint
end

#inactive_statusInteger

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer)


63
64
65
# File 'lib/oci/identity/models/api_key.rb', line 63

def inactive_status
  @inactive_status
end

#key_idString

An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.

Returns:

  • (String)


34
35
36
# File 'lib/oci/identity/models/api_key.rb', line 34

def key_id
  @key_id
end

#key_valueString

The key's value.

Returns:

  • (String)


38
39
40
# File 'lib/oci/identity/models/api_key.rb', line 38

def key_value
  @key_value
end

#lifecycle_stateString

The API key's current state. After creating an ApiKey object, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

  • (String)


59
60
61
# File 'lib/oci/identity/models/api_key.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

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

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

Returns:

  • (DateTime)


53
54
55
# File 'lib/oci/identity/models/api_key.rb', line 53

def time_created
  @time_created
end

#user_idString

The OCID of the user the key belongs to.

Returns:

  • (String)


46
47
48
# File 'lib/oci/identity/models/api_key.rb', line 46

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/oci/identity/models/api_key.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'keyId',
    'key_value': :'keyValue',
    'fingerprint': :'fingerprint',
    'user_id': :'userId',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'inactive_status': :'inactiveStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/oci/identity/models/api_key.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'String',
    'key_value': :'String',
    'fingerprint': :'String',
    'user_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'inactive_status': :'Integer'
    # 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



173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/oci/identity/models/api_key.rb', line 173

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

  self.class == other.class &&
    key_id == other.key_id &&
    key_value == other.key_value &&
    fingerprint == other.fingerprint &&
    user_id == other.user_id &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    inactive_status == other.inactive_status
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



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

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


189
190
191
# File 'lib/oci/identity/models/api_key.rb', line 189

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



198
199
200
# File 'lib/oci/identity/models/api_key.rb', line 198

def hash
  [key_id, key_value, fingerprint, user_id, time_created, lifecycle_state, inactive_status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
# File 'lib/oci/identity/models/api_key.rb', line 242

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



236
237
238
# File 'lib/oci/identity/models/api_key.rb', line 236

def to_s
  to_hash.to_s
end