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.



14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
 
# File 'lib/models/porcelain.rb', line 14538

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.



14517
14518
14519
 
# File 'lib/models/porcelain.rb', line 14517

def email
  @email
end

#external_id ⇒ Object

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



14519
14520
14521
 
# File 'lib/models/porcelain.rb', line 14519

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



14521
14522
14523
 
# File 'lib/models/porcelain.rb', line 14521

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



14523
14524
14525
 
# File 'lib/models/porcelain.rb', line 14523

def id
  @id
end

#last_name ⇒ Object

The User's last name.



14525
14526
14527
 
# File 'lib/models/porcelain.rb', line 14525

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.



14527
14528
14529
 
# File 'lib/models/porcelain.rb', line 14527

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.



14530
14531
14532
 
# File 'lib/models/porcelain.rb', line 14530

def password
  @password
end

#permission_level ⇒ Object

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



14532
14533
14534
 
# File 'lib/models/porcelain.rb', line 14532

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



14534
14535
14536
 
# File 'lib/models/porcelain.rb', line 14534

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14536
14537
14538
 
# File 'lib/models/porcelain.rb', line 14536

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14562
14563
14564
14565
14566
14567
14568
 
# File 'lib/models/porcelain.rb', line 14562

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