module Oktakit::Client::Factors
Public Instance Methods
Activate Factor
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] If the passcode is correct you will receive the Factor with an ACTIVE status. @see developer.okta.com/docs/api/resources/factors.html#activate-factor @example
Oktakit.activate_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] The enrolled Factor with a status of either PENDING_ACTIVATION or ACTIVE. @see developer.okta.com/docs/api/resources/factors.html#enroll-factor @example
Oktakit.enroll_factor('id')
# File lib/oktakit/client/factors.rb, line 81 def enroll_factor(user_id, options = {}) post("/users/#{user_id}/factors", options) end
Get Factor
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Factor @see developer.okta.com/docs/api/resources/factors.html#get-factor @example
Oktakit.get_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Factors
@see developer.okta.com/docs/api/resources/factors.html#list-enrolled-factors @example
Oktakit.list_enrolled_factors('user_id')
# 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
@params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Factors
@see developer.okta.com/docs/api/resources/factors.html#list-factors-to-enroll @example
Oktakit.list_factors_to_enroll('user_id')
# 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
@params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Questions @see developer.okta.com/docs/api/resources/factors.html#list-security-questions @example
Oktakit.list_security_questions('user_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @params transaction_id [string] Transaction ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result @see developer.okta.com/docs/api/resources/factors.html#poll-for-verify-transaction-completion @example
Oktakit.poll_for_verify_transaction_completion('user_id', 'factor_id', 'transaction_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return 204 No Content @see developer.okta.com/docs/api/resources/factors.html#reset-factor @example
Oktakit.reset_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result (waiting, success, rejected, or timeout) @see developer.okta.com/docs/api/resources/factors.html#verify-push-factor @example
Oktakit.verify_push_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result @see developer.okta.com/docs/api/resources/factors.html#verify-security-question-factor @example
Oktakit.verify_security_question_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result @see developer.okta.com/docs/api/resources/factors.html#verify-sms-factor @example
Oktakit.verify_sms_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result @see developer.okta.com/docs/api/resources/factors.html#verify-token-factor @example
Oktakit.verify_token_factor('user_id', 'factor_id')
# 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
@params user_id [string] User ID @params factor_id [string] Factor ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Verification result @see developer.okta.com/docs/api/resources/factors.html#verify-totp-factor @example
Oktakit.verify_totp_factor('user_id', 'factor_id')
# 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