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](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).

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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm).

Constant Summary collapse

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

Instance Attribute 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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
 
# File 'lib/oci/identity/models/api_key.rb', line 71

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}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#fingerprint ⇒ String

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

Returns:

  • (String) 


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

def fingerprint
  @fingerprint
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


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

def inactive_status
  @inactive_status
end

#key_id ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/api_key.rb', line 30

def key_id
  @key_id
end

#key_value ⇒ String

The key’s value.

Returns:

  • (String) 


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

def key_value
  @key_value
end

#lifecycle_state ⇒ String

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) 


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

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/identity/models/api_key.rb', line 49

def time_created
  @time_created
end

#user_id ⇒ String

The OCID of the user the key belongs to.

Returns:

  • (String) 


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

def user_id
  @user_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/identity/models/api_key.rb', line 155

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      key_id == other_object.key_id &&
      key_value == other_object.key_value &&
      fingerprint == other_object.fingerprint &&
      user_id == other_object.user_id &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/identity/models/api_key.rb', line 182

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/oci/identity/models/api_key.rb', line 169

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



175
176
177
 
# File 'lib/oci/identity/models/api_key.rb', line 175

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/identity/models/api_key.rb', line 207

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



201
202
203
 
# File 'lib/oci/identity/models/api_key.rb', line 201

def to_s
  to_hash.to_s
end