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.



12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
 
# File 'lib/models/porcelain.rb', line 12518

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.



12497
12498
12499
 
# File 'lib/models/porcelain.rb', line 12497

def email
  @email
end

#external_id ⇒ Object

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



12499
12500
12501
 
# File 'lib/models/porcelain.rb', line 12499

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



12501
12502
12503
 
# File 'lib/models/porcelain.rb', line 12501

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



12503
12504
12505
 
# File 'lib/models/porcelain.rb', line 12503

def id
  @id
end

#last_name ⇒ Object

The User's last name.



12505
12506
12507
 
# File 'lib/models/porcelain.rb', line 12505

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.



12507
12508
12509
 
# File 'lib/models/porcelain.rb', line 12507

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.



12510
12511
12512
 
# File 'lib/models/porcelain.rb', line 12510

def password
  @password
end

#permission_level ⇒ Object

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



12512
12513
12514
 
# File 'lib/models/porcelain.rb', line 12512

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



12514
12515
12516
 
# File 'lib/models/porcelain.rb', line 12514

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12516
12517
12518
 
# File 'lib/models/porcelain.rb', line 12516

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12542
12543
12544
12545
12546
12547
12548
 
# File 'lib/models/porcelain.rb', line 12542

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