Class: ADAL::ClientCredential

Inherits:
Object
  • Object
show all
Includes:
RequestParameters, Util
Defined in:
lib/adal/client_credential.rb

Overview

A wrapper object for a client id and secret.

Constant Summary

Constants included from RequestParameters

RequestParameters::AAD_API_VERSION, RequestParameters::ASSERTION, RequestParameters::CLIENT_ASSERTION, RequestParameters::CLIENT_ASSERTION_TYPE, RequestParameters::CLIENT_ID, RequestParameters::CLIENT_REQUEST_ID, RequestParameters::CLIENT_RETURN_CLIENT_REQUEST_ID, RequestParameters::CLIENT_SECRET, RequestParameters::CODE, RequestParameters::FORM_POST, RequestParameters::GRANT_TYPE, RequestParameters::PASSWORD, RequestParameters::REDIRECT_URI, RequestParameters::REFRESH_TOKEN, RequestParameters::RESOURCE, RequestParameters::SCOPE, RequestParameters::UNIQUE_ID, RequestParameters::USERNAME, RequestParameters::USER_INFO

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#fail_if_arguments_nil, #http, #string_hash

Constructor Details

#initialize(client_id, client_secret = nil) ⇒ ClientCredential

Returns a new instance of ClientCredential.



35
36
37
38
39
 
# File 'lib/adal/client_credential.rb', line 35

def initialize(client_id, client_secret = nil)
  fail_if_arguments_nil(client_id)
  @client_id = client_id
  @client_secret = client_secret
end

Instance Attribute Details

#client_id ⇒ Object (readonly)

Returns the value of attribute client_id.



32
33
34
 
# File 'lib/adal/client_credential.rb', line 32

def client_id
  @client_id
end

#client_secret ⇒ Object (readonly)

Returns the value of attribute client_secret.



33
34
35
 
# File 'lib/adal/client_credential.rb', line 33

def client_secret
  @client_secret
end

Instance Method Details

#request_params ⇒ Object

The relavent parameters from this credential for OAuth.



42
43
44
 
# File 'lib/adal/client_credential.rb', line 42

def request_params
  { CLIENT_ID => @client_id, CLIENT_SECRET => @client_secret }
end