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.



12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
 
# File 'lib/models/porcelain.rb', line 12952

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.



12931
12932
12933
 
# File 'lib/models/porcelain.rb', line 12931

def email
  @email
end

#external_id ⇒ Object

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



12933
12934
12935
 
# File 'lib/models/porcelain.rb', line 12933

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



12935
12936
12937
 
# File 'lib/models/porcelain.rb', line 12935

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



12937
12938
12939
 
# File 'lib/models/porcelain.rb', line 12937

def id
  @id
end

#last_name ⇒ Object

The User's last name.



12939
12940
12941
 
# File 'lib/models/porcelain.rb', line 12939

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.



12941
12942
12943
 
# File 'lib/models/porcelain.rb', line 12941

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.



12944
12945
12946
 
# File 'lib/models/porcelain.rb', line 12944

def password
  @password
end

#permission_level ⇒ Object

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



12946
12947
12948
 
# File 'lib/models/porcelain.rb', line 12946

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



12948
12949
12950
 
# File 'lib/models/porcelain.rb', line 12948

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12950
12951
12952
 
# File 'lib/models/porcelain.rb', line 12950

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12976
12977
12978
12979
12980
12981
12982
 
# File 'lib/models/porcelain.rb', line 12976

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