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.



12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
# File 'lib/models/porcelain.rb', line 12881

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.



12860
12861
12862
# File 'lib/models/porcelain.rb', line 12860

def email
  @email
end

#external_idObject

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



12862
12863
12864
# File 'lib/models/porcelain.rb', line 12862

def external_id
  @external_id
end

#first_nameObject

The User's first name.



12864
12865
12866
# File 'lib/models/porcelain.rb', line 12864

def first_name
  @first_name
end

#idObject

Unique identifier of the User.



12866
12867
12868
# File 'lib/models/porcelain.rb', line 12866

def id
  @id
end

#last_nameObject

The User's last name.



12868
12869
12870
# File 'lib/models/porcelain.rb', line 12868

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.



12870
12871
12872
# File 'lib/models/porcelain.rb', line 12870

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.



12873
12874
12875
# File 'lib/models/porcelain.rb', line 12873

def password
  @password
end

#permission_levelObject

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



12875
12876
12877
# File 'lib/models/porcelain.rb', line 12875

def permission_level
  @permission_level
end

#suspendedObject

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



12877
12878
12879
# File 'lib/models/porcelain.rb', line 12877

def suspended
  @suspended
end

#tagsObject

Tags is a map of key, value pairs.



12879
12880
12881
# File 'lib/models/porcelain.rb', line 12879

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



12905
12906
12907
12908
12909
12910
12911
# File 'lib/models/porcelain.rb', line 12905

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