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.



13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
 
# File 'lib/models/porcelain.rb', line 13032

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.



13011
13012
13013
 
# File 'lib/models/porcelain.rb', line 13011

def email
  @email
end

#external_id ⇒ Object

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



13013
13014
13015
 
# File 'lib/models/porcelain.rb', line 13013

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



13015
13016
13017
 
# File 'lib/models/porcelain.rb', line 13015

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



13017
13018
13019
 
# File 'lib/models/porcelain.rb', line 13017

def id
  @id
end

#last_name ⇒ Object

The User's last name.



13019
13020
13021
 
# File 'lib/models/porcelain.rb', line 13019

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.



13021
13022
13023
 
# File 'lib/models/porcelain.rb', line 13021

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.



13024
13025
13026
 
# File 'lib/models/porcelain.rb', line 13024

def password
  @password
end

#permission_level ⇒ Object

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



13026
13027
13028
 
# File 'lib/models/porcelain.rb', line 13026

def permission_level
  @permission_level
end

#suspended ⇒ Object

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



13028
13029
13030
 
# File 'lib/models/porcelain.rb', line 13028

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13030
13031
13032
 
# File 'lib/models/porcelain.rb', line 13030

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13056
13057
13058
13059
13060
13061
13062
 
# File 'lib/models/porcelain.rb', line 13056

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