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.



12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
 
# File 'lib/models/porcelain.rb', line 12192

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

#email ⇒ Object

The User's email address. Must be unique.



12171
12172
12173
 
# File 'lib/models/porcelain.rb', line 12171

def email
  @email
end

#external_id ⇒ Object

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



12173
12174
12175
 
# File 'lib/models/porcelain.rb', line 12173

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



12175
12176
12177
 
# File 'lib/models/porcelain.rb', line 12175

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



12177
12178
12179
 
# File 'lib/models/porcelain.rb', line 12177

def id
  @id
end

#last_name ⇒ Object

The User's last name.



12179
12180
12181
 
# File 'lib/models/porcelain.rb', line 12179

def last_name
  @last_name
end

#managed_by ⇒ Object

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



12181
12182
12183
 
# File 'lib/models/porcelain.rb', line 12181

def managed_by
  @managed_by
end

#password ⇒ Object

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



12184
12185
12186
 
# File 'lib/models/porcelain.rb', line 12184

def password
  @password
end

#permission_level ⇒ Object

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



12186
12187
12188
 
# File 'lib/models/porcelain.rb', line 12186

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



12188
12189
12190
 
# File 'lib/models/porcelain.rb', line 12188

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12190
12191
12192
 
# File 'lib/models/porcelain.rb', line 12190

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12216
12217
12218
12219
12220
12221
12222
 
# File 'lib/models/porcelain.rb', line 12216

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