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.



12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
 
# File 'lib/models/porcelain.rb', line 12263

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.



12242
12243
12244
 
# File 'lib/models/porcelain.rb', line 12242

def email
  @email
end

#external_id ⇒ Object

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



12244
12245
12246
 
# File 'lib/models/porcelain.rb', line 12244

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



12246
12247
12248
 
# File 'lib/models/porcelain.rb', line 12246

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



12248
12249
12250
 
# File 'lib/models/porcelain.rb', line 12248

def id
  @id
end

#last_name ⇒ Object

The User's last name.



12250
12251
12252
 
# File 'lib/models/porcelain.rb', line 12250

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.



12252
12253
12254
 
# File 'lib/models/porcelain.rb', line 12252

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.



12255
12256
12257
 
# File 'lib/models/porcelain.rb', line 12255

def password
  @password
end

#permission_level ⇒ Object

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



12257
12258
12259
 
# File 'lib/models/porcelain.rb', line 12257

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



12259
12260
12261
 
# File 'lib/models/porcelain.rb', line 12259

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12261
12262
12263
 
# File 'lib/models/porcelain.rb', line 12261

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12287
12288
12289
12290
12291
12292
12293
 
# File 'lib/models/porcelain.rb', line 12287

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