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.



12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
 
# File 'lib/models/porcelain.rb', line 12436

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.



12415
12416
12417
 
# File 'lib/models/porcelain.rb', line 12415

def email
  @email
end

#external_id ⇒ Object

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



12417
12418
12419
 
# File 'lib/models/porcelain.rb', line 12417

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



12419
12420
12421
 
# File 'lib/models/porcelain.rb', line 12419

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



12421
12422
12423
 
# File 'lib/models/porcelain.rb', line 12421

def id
  @id
end

#last_name ⇒ Object

The User's last name.



12423
12424
12425
 
# File 'lib/models/porcelain.rb', line 12423

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.



12425
12426
12427
 
# File 'lib/models/porcelain.rb', line 12425

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.



12428
12429
12430
 
# File 'lib/models/porcelain.rb', line 12428

def password
  @password
end

#permission_level ⇒ Object

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



12430
12431
12432
 
# File 'lib/models/porcelain.rb', line 12430

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



12432
12433
12434
 
# File 'lib/models/porcelain.rb', line 12432

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12434
12435
12436
 
# File 'lib/models/porcelain.rb', line 12434

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12460
12461
12462
12463
12464
12465
12466
 
# File 'lib/models/porcelain.rb', line 12460

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