Class: LoginRadius::ConfigurationApi

Inherits:
Object
  • Object
show all
Includes:
RequestClient
Defined in:
lib/login_radius/api/advanced/configuration_api.rb

Overview

ConfigurationApi module

Constant Summary

Constants included from RequestClient

RequestClient::API_V2_BASE_URL, RequestClient::API_V2_BASE_URL_CONFIG, RequestClient::INIT_VECTOR, RequestClient::KEY_SIZE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RequestClient

#build_new_uri_obj, #create_hash_secret, #delete_request, #getValidationMessage, #get_request, #get_sott, #isNullOrWhiteSpace, #local_generate_sott, #post_request, #put_request

Constructor Details

#initialize ⇒ ConfigurationApi

Initializes a LoginRadius Account object with an apikey and secret Takes in a hash containing site_name(required), api_key(required), api_secret(required)

Raises:



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 16

def initialize
  @site_name = ENV['SITE_NAME']
  @api_key = ENV['API_KEY']
  @api_secret = ENV['API_SECRET']
  raise LoginRadius::Error.new, "'site_name' is a required option for Account class initialization." \
    unless @site_name != '' && @site_name != nil
  raise LoginRadius::Error.new, "'api_key' is a required option for Account class initialization." \
    unless @api_key != '' && @api_key != nil
  raise LoginRadius::Error.new, "'api_secret is a required option for Account class initialization." \
    unless @api_secret != '' && @api_secret != nil
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



12
13
14
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 12

def api_key
  @api_key
end

#api_secret ⇒ Object

Returns the value of attribute api_secret.



12
13
14
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 12

def api_secret
  @api_secret
end

#site_name ⇒ Object

Returns the value of attribute site_name.



12
13
14
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 12

def site_name
  @site_name
end

Instance Method Details

#get_configurations ⇒ Object

This API is used to get the configurations which are set in the LoginRadius Dashboard for a particular LoginRadius site/environment

100

Returns:

  • Response containing LoginRadius App configurations which are set in the LoginRadius Dashboard for a particular LoginRadius site/environment



31
32
33
34
35
36
37
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 31

def get_configurations()
  resource_path = 'ciam/appinfo'
  query_parameters = {}
  query_parameters['apikey'] = @api_key

  get_request(resource_path, query_parameters, nil)
end

#get_server_info(time_difference = '') ⇒ Object

This API allows you to query your LoginRadius account for basic server information and server time information which is useful when generating an SOTT token.

3.1

Parameters:

  • time_difference (defaults to: '') —

    • The time difference you would like to pass, If you not pass difference then the default value is 10 minutes

Returns:

  • Response containing Definition of Complete service info data



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/login_radius/api/advanced/configuration_api.rb', line 45

def get_server_info(time_difference = '')

  query_parameters = {}
  query_parameters['apiKey'] = @api_key
  unless time_difference == false
    query_parameters['timeDifference'] = time_difference
  end

  resource_path = 'identity/v2/serverinfo'
  get_request(resource_path, query_parameters, {})
end