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(scim: nil, email: nil, external_id: nil, first_name: nil, id: nil, last_name: nil, managed_by: nil, manager_id: nil, password: nil, permission_level: nil, resolved_manager_id: nil, suspended: nil, tags: nil) ⇒ User

Returns a new instance of User.



16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
 
# File 'lib/models/porcelain.rb', line 16348

def initialize(
  scim: nil,
  email: nil,
  external_id: nil,
  first_name: nil,
  id: nil,
  last_name: nil,
  managed_by: nil,
  manager_id: nil,
  password: nil,
  permission_level: nil,
  resolved_manager_id: nil,
  suspended: nil,
  tags: nil
)
  @scim = scim == nil ? "" : scim
  @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
  @manager_id = manager_id == nil ? "" : manager_id
  @password = password == nil ? "" : password
  @permission_level = permission_level == nil ? "" : permission_level
  @resolved_manager_id = resolved_manager_id == nil ? "" : resolved_manager_id
  @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.



16321
16322
16323
 
# File 'lib/models/porcelain.rb', line 16321

def email
  @email
end

#external_id ⇒ Object

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



16323
16324
16325
 
# File 'lib/models/porcelain.rb', line 16323

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



16325
16326
16327
 
# File 'lib/models/porcelain.rb', line 16325

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



16327
16328
16329
 
# File 'lib/models/porcelain.rb', line 16327

def id
  @id
end

#last_name ⇒ Object

The User's last name.



16329
16330
16331
 
# File 'lib/models/porcelain.rb', line 16329

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.



16331
16332
16333
 
# File 'lib/models/porcelain.rb', line 16331

def managed_by
  @managed_by
end

#manager_id ⇒ Object

Manager ID is the ID of the user's manager. This field is empty when the user has no manager.



16333
16334
16335
 
# File 'lib/models/porcelain.rb', line 16333

def manager_id
  @manager_id
end

#password ⇒ Object

Password is a write-only field that can be used to set the user's password. Currently only supported for update.



16336
16337
16338
 
# File 'lib/models/porcelain.rb', line 16336

def password
  @password
end

#permission_level ⇒ Object

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



16338
16339
16340
 
# File 'lib/models/porcelain.rb', line 16338

def permission_level
  @permission_level
end

#resolved_manager_id ⇒ Object

Resolved Manager ID is the ID of the user's manager derived from the manager_id, if present, or from the SCIM metadata. This is a read-only field that's only populated for get and list.



16342
16343
16344
 
# File 'lib/models/porcelain.rb', line 16342

def resolved_manager_id
  @resolved_manager_id
end

#scim ⇒ Object

SCIM contains the raw SCIM metadata for the user. This is a read-only field.



16319
16320
16321
 
# File 'lib/models/porcelain.rb', line 16319

def scim
  @scim
end

#suspended ⇒ Object

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



16344
16345
16346
 
# File 'lib/models/porcelain.rb', line 16344

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



16346
16347
16348
 
# File 'lib/models/porcelain.rb', line 16346

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



16378
16379
16380
16381
16382
16383
16384
 
# File 'lib/models/porcelain.rb', line 16378

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