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.



14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'lib/models/porcelain.rb', line 14679

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.



14658
14659
14660
# File 'lib/models/porcelain.rb', line 14658

def email
  @email
end

#external_idObject

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



14660
14661
14662
# File 'lib/models/porcelain.rb', line 14660

def external_id
  @external_id
end

#first_nameObject

The User's first name.



14662
14663
14664
# File 'lib/models/porcelain.rb', line 14662

def first_name
  @first_name
end

#idObject

Unique identifier of the User.



14664
14665
14666
# File 'lib/models/porcelain.rb', line 14664

def id
  @id
end

#last_nameObject

The User's last name.



14666
14667
14668
# File 'lib/models/porcelain.rb', line 14666

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.



14668
14669
14670
# File 'lib/models/porcelain.rb', line 14668

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.



14671
14672
14673
# File 'lib/models/porcelain.rb', line 14671

def password
  @password
end

#permission_levelObject

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



14673
14674
14675
# File 'lib/models/porcelain.rb', line 14673

def permission_level
  @permission_level
end

#suspendedObject

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



14675
14676
14677
# File 'lib/models/porcelain.rb', line 14675

def suspended
  @suspended
end

#tagsObject

Tags is a map of key, value pairs.



14677
14678
14679
# File 'lib/models/porcelain.rb', line 14677

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



14703
14704
14705
14706
14707
14708
14709
# File 'lib/models/porcelain.rb', line 14703

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