Class: LockstepSdk::ConnectorInfoModel

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

Overview

Represents all possible data required to set up an app enrollment for a connector. Only send required fields for the given connector.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ConnectorInfoModel

Initialize the ConnectorInfoModel using the provided prototype



29
30
31
32
33
34
# File 'lib/lockstep_sdk/models/connector_info_model.rb', line 29

def initialize(params = {})
    @auth_code = params.dig(:auth_code)
    @realm_id = params.dig(:realm_id)
    @redirect_uri = params.dig(:redirect_uri)
    @email = params.dig(:email)
end

Instance Attribute Details

#auth_codeString

Returns The authorization code returned from the first step of the OAuth2 flow oauth.net/2/grant-types/authorization-code/.

Returns:



38
39
40
# File 'lib/lockstep_sdk/models/connector_info_model.rb', line 38

def auth_code
  @auth_code
end

#emailString

Returns The email an email connection is being created for.

Returns:

  • (String)

    The email an email connection is being created for.



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

def email
  @email
end

#realm_idString

Returns The realm id of the account being granted permissions to access.

Returns:

  • (String)

    The realm id of the account being granted permissions to access



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

def realm_id
  @realm_id
end

#redirect_uriString

Returns The redirect uri used for step one of the OAuth2.0 flow.

Returns:

  • (String)

    The redirect uri used for step one of the OAuth2.0 flow.



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

def redirect_uri
  @redirect_uri
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object)

    This object as a JSON key-value structure



54
55
56
57
58
59
60
61
# File 'lib/lockstep_sdk/models/connector_info_model.rb', line 54

def as_json(options={})
    {
        'authCode' => @auth_code,
        'realmId' => @realm_id,
        'redirectUri' => @redirect_uri,
        'email' => @email,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String)

    This object converted to a JSON string



65
66
67
# File 'lib/lockstep_sdk/models/connector_info_model.rb', line 65

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end