Class: OmniAuth::Strategies::Crowd::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/omniauth/strategies/crowd/configuration.rb

Constant Summary collapse

DEFAULT_SESSION_URL = 
"%s/rest/usermanagement/latest/session"
DEFAULT_AUTHENTICATION_URL = 
"%s/rest/usermanagement/latest/authentication"
DEFAULT_USER_GROUP_URL = 
"%s/rest/usermanagement/latest/user/group/direct"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ Configuration

Returns a new instance of Configuration.

Parameters:

  • params (Hash) —

    configuration options

Options Hash (params):

  • :crowd_server_url (String, nil) —

    the Crowd server root URL; probably something like ‘crowd.mycompany.com` or `crowd.mycompany.com/crowd`; optional.

  • :crowd_authentication_url (String, nil) — default: :crowd_server_url + '/rest/usermanagement/latest/authentication' —

    the URL to which to use for authenication; optional if ‘:crowd_server_url` is specified, required otherwise.

  • :application_name (String, nil) —

    the application name specified in Crowd for this application, required.

  • :application_password (String, nil) —

    the application password specified in Crowd for this application, required.

  • :disable_ssl_verification (Boolean, nil) —

    disable verification for SSL cert, helpful when you developing with a fake cert.

  • : (Boolean, true) —

    include a list of user groups when getting information ont he user

  • :crowd_user_group_url (String, nil) — default: :crowd_server_url + '/rest/usermanagement/latest/user/group/direct' —

    the URL to which to use for retrieving users groups optional if ‘:crowd_server_url` is specified, or if `:include_user_groups` is false required otherwise.



30
31
32
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 30

def initialize(params)
  parse_params params
end

Instance Attribute Details

#content_type ⇒ Object (readonly)

Returns the value of attribute content_type.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def content_type
  @content_type
end

#crowd_application_name ⇒ Object (readonly)

Returns the value of attribute crowd_application_name.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def crowd_application_name
  @crowd_application_name
end

#crowd_password ⇒ Object (readonly)

Returns the value of attribute crowd_password.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def crowd_password
  @crowd_password
end

#disable_ssl_verification ⇒ Object (readonly) Also known as: disable_ssl_verification?

Returns the value of attribute disable_ssl_verification.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def disable_ssl_verification
  @disable_ssl_verification
end

#include_users_groups ⇒ Object (readonly) Also known as: include_users_groups?

Returns the value of attribute include_users_groups.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def include_users_groups
  @include_users_groups
end

#session_url ⇒ Object (readonly)

Returns the value of attribute session_url.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def session_url
  @session_url
end

#use_sessions ⇒ Object (readonly) Also known as: use_sessions?

Returns the value of attribute use_sessions.



10
11
12
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 10

def use_sessions
  @use_sessions
end

Instance Method Details

#authentication_url(username) ⇒ String

Build a Crowd authentication URL from username.

Parameters:

  • username (String) —

    the username to validate

Returns:



39
40
41
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 39

def authentication_url(username)
  append_username @authentication_url, username
end

#user_group_url(username) ⇒ Object 



43
44
45
 
# File 'lib/omniauth/strategies/crowd/configuration.rb', line 43

def user_group_url(username)
  @user_group_url.nil? ? nil : append_username( @user_group_url, username)
end