Class: OCI::IdentityDataPlane::Models::GenerateUserSecurityTokenDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_data_plane/models/generate_user_security_token_details.rb

Overview

Request parameters in body for obtaining a user principal session token (UPST) for self.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateUserSecurityTokenDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 52

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

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

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

  self.session_expiration_in_minutes = attributes[:'sessionExpirationInMinutes'] if attributes[:'sessionExpirationInMinutes']

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

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

Instance Attribute Details

#public_key ⇒ String

[Required] The user-owned public key in PEM format that corresponds to the RSA key pair used for signing requests. The user also owns the corresponding private key. This public key will be put inside the user security token by the auth service after successful validation of the request.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 16

def public_key
  @public_key
end

#session_expiration_in_minutes ⇒ Integer

User session expiration in minutes to which the requested user principal session token (UPST) is bounded. Valid values are from 5 to 60 for all realms.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 22

def session_expiration_in_minutes
  @session_expiration_in_minutes
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'public_key': :'publicKey',
    'session_expiration_in_minutes': :'sessionExpirationInMinutes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 35

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



78
79
80
81
82
83
84
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 78

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

  self.class == other.class &&
    public_key == other.public_key &&
    session_expiration_in_minutes == other.session_expiration_in_minutes
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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 109

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


89
90
91
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 89

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



98
99
100
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 98

def hash
  [public_key, session_expiration_in_minutes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 142

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



136
137
138
 
# File 'lib/oci/identity_data_plane/models/generate_user_security_token_details.rb', line 136

def to_s
  to_hash.to_s
end