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.



14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
 
# File 'lib/models/porcelain.rb', line 14838

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.



14811
14812
14813
 
# File 'lib/models/porcelain.rb', line 14811

def email
  @email
end

#external_id ⇒ Object

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



14813
14814
14815
 
# File 'lib/models/porcelain.rb', line 14813

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



14815
14816
14817
 
# File 'lib/models/porcelain.rb', line 14815

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



14817
14818
14819
 
# File 'lib/models/porcelain.rb', line 14817

def id
  @id
end

#last_name ⇒ Object

The User's last name.



14819
14820
14821
 
# File 'lib/models/porcelain.rb', line 14819

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.



14821
14822
14823
 
# File 'lib/models/porcelain.rb', line 14821

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.



14823
14824
14825
 
# File 'lib/models/porcelain.rb', line 14823

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.



14826
14827
14828
 
# File 'lib/models/porcelain.rb', line 14826

def password
  @password
end

#permission_level ⇒ Object

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



14828
14829
14830
 
# File 'lib/models/porcelain.rb', line 14828

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.



14832
14833
14834
 
# File 'lib/models/porcelain.rb', line 14832

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.



14809
14810
14811
 
# File 'lib/models/porcelain.rb', line 14809

def scim
  @scim
end

#suspended ⇒ Object

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



14834
14835
14836
 
# File 'lib/models/porcelain.rb', line 14834

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14836
14837
14838
 
# File 'lib/models/porcelain.rb', line 14836

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14868
14869
14870
14871
14872
14873
14874
 
# File 'lib/models/porcelain.rb', line 14868

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