Class: LockstepSdk::StatusModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/status_model.rb

Overview

Represents the status of a user's credentials

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ StatusModel

Initialize the StatusModel using the provided prototype



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 24

def initialize(params = {})
    @user_name = params.dig(:user_name)
    @account_name = params.dig(:account_name)
    @account_company_id = params.dig(:account_company_id)
    @user_id = params.dig(:user_id)
    @group_key = params.dig(:group_key)
    @logged_in = params.dig(:logged_in)
    @error_message = params.dig(:error_message)
    @roles = params.dig(:roles)
    @last_logged_in = params.dig(:last_logged_in)
    @api_key_id = params.dig(:api_key_id)
    @user_status = params.dig(:user_status)
    @environment = params.dig(:environment)
    @version = params.dig(:version)
    @dependencies = params.dig(:dependencies)
end

Instance Attribute Details

#account_company_id ⇒ Uuid

Returns If authentication is successful, contains subscription account company id of logged-in user.

Returns:

  • (Uuid) —

    If authentication is successful, contains subscription account company id of logged-in user.



46
47
48
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 46

def 
  @account_company_id
end

#account_name ⇒ String

Returns If authentication is successful, contains subscription account name of logged-in user.

Returns:

  • (String) —

    If authentication is successful, contains subscription account name of logged-in user.



44
45
46
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 44

def 
  @account_name
end

#api_key_id ⇒ Uuid

Returns The id of the API key used to authenticate.

Returns:

  • (Uuid) —

    The id of the API key used to authenticate.



60
61
62
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 60

def api_key_id
  @api_key_id
end

#dependencies ⇒ Object

Returns Statuses for the dependencies of this api. OK if the dependency is working.

Returns:

  • (Object) —

    Statuses for the dependencies of this api. OK if the dependency is working.



68
69
70
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 68

def dependencies
  @dependencies
end

#environment ⇒ String

Returns The environment currently being used.

Returns:

  • (String) —

    The environment currently being used



64
65
66
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 64

def environment
  @environment
end

#error_message ⇒ String

Returns The error message.

Returns:

  • (String) —

    The error message.



54
55
56
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 54

def error_message
  @error_message
end

#group_key ⇒ Uuid

Returns If authentication is successful, contains the group key of the logged-in user.

Returns:

  • (Uuid) —

    If authentication is successful, contains the group key of the logged-in user.



50
51
52
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 50

def group_key
  @group_key
end

#last_logged_in ⇒ Date-time

Returns Date and time user has last logged into Azure B2C.

Returns:

  • (Date-time) —

    Date and time user has last logged into Azure B2C.



58
59
60
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 58

def last_logged_in
  @last_logged_in
end

#logged_in ⇒ Boolean

Returns true if authentication for this API was successful.

Returns:

  • (Boolean) —

    Returns true if authentication for this API was successful.



52
53
54
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 52

def logged_in
  @logged_in
end

#roles ⇒ String

Returns The set of roles for this user.

Returns:

  • (String) —

    The set of roles for this user.



56
57
58
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 56

def roles
  @roles
end

#user_id ⇒ Uuid

Returns If authentication is successful, contains the unique identifier of the logged-in user.

Returns:

  • (Uuid) —

    If authentication is successful, contains the unique identifier of the logged-in user.



48
49
50
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 48

def user_id
  @user_id
end

#user_name ⇒ String

Returns If authentication is successful, contains the username of the logged-in user.

Returns:

  • (String) —

    If authentication is successful, contains the username of the logged-in user.



42
43
44
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 42

def user_name
  @user_name
end

#user_status ⇒ String

Returns If authentication is successful, contains the user status of the logged-in user.

Returns:

  • (String) —

    If authentication is successful, contains the user status of the logged-in user.



62
63
64
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 62

def user_status
  @user_status
end

#version ⇒ String

Returns The version currently being used.

Returns:

  • (String) —

    The version currently being used



66
67
68
 
# File 'lib/lockstep_sdk/models/status_model.rb', line 66

def version
  @version
end