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.



11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
# File 'lib/models/porcelain.rb', line 11599

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.



11578
11579
11580
# File 'lib/models/porcelain.rb', line 11578

def email
  @email
end

#external_idObject

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



11580
11581
11582
# File 'lib/models/porcelain.rb', line 11580

def external_id
  @external_id
end

#first_nameObject

The User's first name.



11582
11583
11584
# File 'lib/models/porcelain.rb', line 11582

def first_name
  @first_name
end

#idObject

Unique identifier of the User.



11584
11585
11586
# File 'lib/models/porcelain.rb', line 11584

def id
  @id
end

#last_nameObject

The User's last name.



11586
11587
11588
# File 'lib/models/porcelain.rb', line 11586

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.



11588
11589
11590
# File 'lib/models/porcelain.rb', line 11588

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.



11591
11592
11593
# File 'lib/models/porcelain.rb', line 11591

def password
  @password
end

#permission_levelObject

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



11593
11594
11595
# File 'lib/models/porcelain.rb', line 11593

def permission_level
  @permission_level
end

#suspendedObject

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



11595
11596
11597
# File 'lib/models/porcelain.rb', line 11595

def suspended
  @suspended
end

#tagsObject

Tags is a map of key, value pairs.



11597
11598
11599
# File 'lib/models/porcelain.rb', line 11597

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



11623
11624
11625
11626
11627
11628
11629
# File 'lib/models/porcelain.rb', line 11623

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