Module: Oktakit::Client::Factors

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/factors.rb

Instance Method Summary

• #activate_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Activate Factor.

• #enroll_factor(user_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Enroll Factor.

• #get_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Get Factor.

• #list_enrolled_factors(user_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Enrolled Factors.

• #list_factors_to_enroll(user_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Factors to Enroll.

• #list_security_questions(user_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Security Questions.

• #poll_for_verify_transaction_completion(user_id, factor_id, transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Poll for Verify Transaction Completion.

• #reset_factor(user_id, factor_id, options = {}) ⇒ Object

  Reset Factor.

• #verify_push_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Verify Push Factor.

• #verify_security_question_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Verify Security Question Factor.

• #verify_sms_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Verify SMS Factor.

• #verify_token_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Verify Token Factor.

• #verify_totp_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

  Verify TOTP Factor.

Instance Method Details

#activate_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Activate Factor

Examples:

Oktakit.activate_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  If the passcode is correct you will receive the Factor with an ACTIVE status.

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#activate-factor

# File 'lib/oktakit/client/factors.rb', line 98

def activate_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/lifecycle/activate", options)
end

#enroll_factor(user_id, options = {}) ⇒ Hash<Sawyer::Resource>

Enroll Factor

Examples:

Oktakit.enroll_factor('id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  The enrolled Factor with a status of either PENDING_ACTIVATION or ACTIVE.

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#enroll-factor

# File 'lib/oktakit/client/factors.rb', line 81

def enroll_factor(user_id, options = {})
  post("/users/#{user_id}/factors", options)
end

#get_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Factor

Examples:

Oktakit.get_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Factor

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#get-factor

# File 'lib/oktakit/client/factors.rb', line 17

def get_factor(user_id, factor_id, options = {})
  get("/users/#{user_id}/factors/#{factor_id}", options)
end

#list_enrolled_factors(user_id, options = {}) ⇒ Array<Sawyer::Resource>

List Enrolled Factors

Examples:

Oktakit.list_enrolled_factors('user_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Factors

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#list-enrolled-factors

# File 'lib/oktakit/client/factors.rb', line 33

def list_enrolled_factors(user_id, options = {})
  get("/users/#{user_id}/factors", options)
end

#list_factors_to_enroll(user_id, options = {}) ⇒ Array<Sawyer::Resource>

List Factors to Enroll

Examples:

Oktakit.list_factors_to_enroll('user_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Factors

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#list-factors-to-enroll

# File 'lib/oktakit/client/factors.rb', line 49

def list_factors_to_enroll(user_id, options = {})
  get("/users/#{user_id}/factors/catalog", options)
end

#list_security_questions(user_id, options = {}) ⇒ Array<Sawyer::Resource>

List Security Questions

Examples:

Oktakit.list_security_questions('user_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Questions

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#list-security-questions

# File 'lib/oktakit/client/factors.rb', line 65

def list_security_questions(user_id, options = {})
  get("/users/#{user_id}/factors/questions", options)
end

#poll_for_verify_transaction_completion(user_id, factor_id, transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

Poll for Verify Transaction Completion

Examples:

Oktakit.poll_for_verify_transaction_completion('user_id', 'factor_id', 'transaction_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#poll-for-verify-transaction-completion

# File 'lib/oktakit/client/factors.rb', line 201

def poll_for_verify_transaction_completion(user_id, factor_id, transaction_id, options = {})
  get("/users/#{user_id}/factors/#{factor_id}/transactions/#{transaction_id}", options)
end

#reset_factor(user_id, factor_id, options = {}) ⇒ Object

Reset Factor

Examples:

Oktakit.reset_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#reset-factor

# File 'lib/oktakit/client/factors.rb', line 115

def reset_factor(user_id, factor_id, options = {})
  delete("/users/#{user_id}/factors/#{factor_id}", options)
end

#verify_push_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Verify Push Factor

Examples:

Oktakit.verify_push_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result (waiting, success, rejected, or timeout)

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#verify-push-factor

# File 'lib/oktakit/client/factors.rb', line 183

def verify_push_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/verify", options)
end

#verify_security_question_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Verify Security Question Factor

Examples:

Oktakit.verify_security_question_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#verify-security-question-factor

# File 'lib/oktakit/client/factors.rb', line 132

def verify_security_question_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/verify", options)
end

#verify_sms_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Verify SMS Factor

Examples:

Oktakit.verify_sms_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#verify-sms-factor

# File 'lib/oktakit/client/factors.rb', line 149

def verify_sms_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/verify", options)
end

#verify_token_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Verify Token Factor

Examples:

Oktakit.verify_token_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#verify-token-factor

# File 'lib/oktakit/client/factors.rb', line 218

def verify_token_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/verify", options)
end

#verify_totp_factor(user_id, factor_id, options = {}) ⇒ Hash<Sawyer::Resource>

Verify TOTP Factor

Examples:

Oktakit.verify_totp_factor('user_id', 'factor_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Verification result

See Also:

• http://developer.okta.com/docs/api/resources/factors.html#verify-totp-factor

# File 'lib/oktakit/client/factors.rb', line 166

def verify_totp_factor(user_id, factor_id, options = {})
  post("/users/#{user_id}/factors/#{factor_id}/verify", options)
end