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.



15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
 
# File 'lib/models/porcelain.rb', line 15212

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.



15185
15186
15187
 
# File 'lib/models/porcelain.rb', line 15185

def email
  @email
end

#external_id ⇒ Object

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



15187
15188
15189
 
# File 'lib/models/porcelain.rb', line 15187

def external_id
  @external_id
end

#first_name ⇒ Object

The User's first name.



15189
15190
15191
 
# File 'lib/models/porcelain.rb', line 15189

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier of the User.



15191
15192
15193
 
# File 'lib/models/porcelain.rb', line 15191

def id
  @id
end

#last_name ⇒ Object

The User's last name.



15193
15194
15195
 
# File 'lib/models/porcelain.rb', line 15193

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.



15195
15196
15197
 
# File 'lib/models/porcelain.rb', line 15195

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.



15197
15198
15199
 
# File 'lib/models/porcelain.rb', line 15197

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.



15200
15201
15202
 
# File 'lib/models/porcelain.rb', line 15200

def password
  @password
end

#permission_level ⇒ Object

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



15202
15203
15204
 
# File 'lib/models/porcelain.rb', line 15202

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.



15206
15207
15208
 
# File 'lib/models/porcelain.rb', line 15206

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.



15183
15184
15185
 
# File 'lib/models/porcelain.rb', line 15183

def scim
  @scim
end

#suspended ⇒ Object

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



15208
15209
15210
 
# File 'lib/models/porcelain.rb', line 15208

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



15210
15211
15212
 
# File 'lib/models/porcelain.rb', line 15210

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15242
15243
15244
15245
15246
15247
15248
 
# File 'lib/models/porcelain.rb', line 15242

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