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.



11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
 
# File 'lib/models/porcelain.rb', line 11768

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.



11747
11748
11749
 
# File 'lib/models/porcelain.rb', line 11747

def email
  @email
end

#external_id ⇒ Object

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



11749
11750
11751
 
# File 'lib/models/porcelain.rb', line 11749

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



11751
11752
11753
 
# File 'lib/models/porcelain.rb', line 11751

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



11753
11754
11755
 
# File 'lib/models/porcelain.rb', line 11753

def id
  @id
end

#last_name ⇒ Object

The User's last name.



11755
11756
11757
 
# File 'lib/models/porcelain.rb', line 11755

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.



11757
11758
11759
 
# File 'lib/models/porcelain.rb', line 11757

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.



11760
11761
11762
 
# File 'lib/models/porcelain.rb', line 11760

def password
  @password
end

#permission_level ⇒ Object

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



11762
11763
11764
 
# File 'lib/models/porcelain.rb', line 11762

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



11764
11765
11766
 
# File 'lib/models/porcelain.rb', line 11764

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11766
11767
11768
 
# File 'lib/models/porcelain.rb', line 11766

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11792
11793
11794
11795
11796
11797
11798
 
# File 'lib/models/porcelain.rb', line 11792

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