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.



13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
 
# File 'lib/models/porcelain.rb', line 13362

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.



13341
13342
13343
 
# File 'lib/models/porcelain.rb', line 13341

def email
  @email
end

#external_id ⇒ Object

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



13343
13344
13345
 
# File 'lib/models/porcelain.rb', line 13343

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



13345
13346
13347
 
# File 'lib/models/porcelain.rb', line 13345

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



13347
13348
13349
 
# File 'lib/models/porcelain.rb', line 13347

def id
  @id
end

#last_name ⇒ Object

The User's last name.



13349
13350
13351
 
# File 'lib/models/porcelain.rb', line 13349

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.



13351
13352
13353
 
# File 'lib/models/porcelain.rb', line 13351

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.



13354
13355
13356
 
# File 'lib/models/porcelain.rb', line 13354

def password
  @password
end

#permission_level ⇒ Object

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



13356
13357
13358
 
# File 'lib/models/porcelain.rb', line 13356

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



13358
13359
13360
 
# File 'lib/models/porcelain.rb', line 13358

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13360
13361
13362
 
# File 'lib/models/porcelain.rb', line 13360

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13386
13387
13388
13389
13390
13391
13392
 
# File 'lib/models/porcelain.rb', line 13386

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