Class: SDM::User

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

A User can connect to resources they are granted directly, or granted via roles.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email: nil, external_id: nil, first_name: nil, id: nil, last_name: nil, managed_by: nil, password: nil, permission_level: nil, suspended: nil, tags: nil) ⇒ User

Returns a new instance of User.



13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
# File 'lib/models/porcelain.rb', line 13103

def initialize(
  email: nil,
  external_id: nil,
  first_name: nil,
  id: nil,
  last_name: nil,
  managed_by: nil,
  password: nil,
  permission_level: nil,
  suspended: nil,
  tags: nil
)
  @email = email == nil ? "" : email
  @external_id = external_id == nil ? "" : external_id
  @first_name = first_name == nil ? "" : first_name
  @id = id == nil ? "" : id
  @last_name = last_name == nil ? "" : last_name
  @managed_by = managed_by == nil ? "" : managed_by
  @password = password == nil ? "" : password
  @permission_level = permission_level == nil ? "" : permission_level
  @suspended = suspended == nil ? false : suspended
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#emailObject

The User's email address. Must be unique.



13082
13083
13084
# File 'lib/models/porcelain.rb', line 13082

def email
  @email
end

#external_idObject

External ID is an alternative unique ID this user is represented by within an external service.



13084
13085
13086
# File 'lib/models/porcelain.rb', line 13084

def external_id
  @external_id
end

#first_nameObject

The User's first name.



13086
13087
13088
# File 'lib/models/porcelain.rb', line 13086

def first_name
  @first_name
end

#idObject

Unique identifier of the User.



13088
13089
13090
# File 'lib/models/porcelain.rb', line 13088

def id
  @id
end

#last_nameObject

The User's last name.



13090
13091
13092
# File 'lib/models/porcelain.rb', line 13090

def last_name
  @last_name
end

#managed_byObject

Managed By is a read only field for what service manages this user, e.g. StrongDM, Okta, Azure.



13092
13093
13094
# File 'lib/models/porcelain.rb', line 13092

def managed_by
  @managed_by
end

#passwordObject

Password is a write-only field that can be used to set the user's password. Currently only supported for update.



13095
13096
13097
# File 'lib/models/porcelain.rb', line 13095

def password
  @password
end

#permission_levelObject

PermissionLevel is the user's permission level e.g. admin, DBA, user.



13097
13098
13099
# File 'lib/models/porcelain.rb', line 13097

def permission_level
  @permission_level
end

#suspendedObject

Suspended is a read only field for the User's suspended state.



13099
13100
13101
# File 'lib/models/porcelain.rb', line 13099

def suspended
  @suspended
end

#tagsObject

Tags is a map of key, value pairs.



13101
13102
13103
# File 'lib/models/porcelain.rb', line 13101

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



13127
13128
13129
13130
13131
13132
13133
# File 'lib/models/porcelain.rb', line 13127

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end