Class: Auth0::Guardian::Factors::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/auth0/guardian/factors/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



10
11
12
 
# File 'lib/auth0/guardian/factors/client.rb', line 10

def initialize(client:)
  @client = client
end

Instance Method Details

#duo ⇒ Auth0::Duo::Client

Returns:

  • (Auth0::Duo::Client) 


117
118
119
 
# File 'lib/auth0/guardian/factors/client.rb', line 117

def duo
  @duo ||= Auth0::Guardian::Factors::Duo::Client.new(client: @client)
end

#email ⇒ Auth0::Email::Client

Returns:

  • (Auth0::Email::Client) 


97
98
99
 
# File 'lib/auth0/guardian/factors/client.rb', line 97

def email
  @email ||= Auth0::Guardian::Factors::Email::Client.new(client: @client)
end

#list(request_options: {}, **_params) ⇒ Array[Auth0::Types::GuardianFactor]

Retrieve details of all multi-factor authentication factors associated with your tenant.

Examples:

client.guardian.factors.list

Parameters:

  • request_options (Hash) (defaults to: {})
  • _params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/auth0/guardian/factors/client.rb', line 30

def list(request_options: {}, **_params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "guardian/factors",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Auth0::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Auth0::Internal::Types::Utils.coerce(Internal::Types::Array[Auth0::Types::GuardianFactor], (response.body.to_s.empty? ? nil : JSON.parse(response.body, symbolize_names: true)))
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#phone ⇒ Auth0::Phone::Client

Returns:

  • (Auth0::Phone::Client) 


102
103
104
 
# File 'lib/auth0/guardian/factors/client.rb', line 102

def phone
  @phone ||= Auth0::Guardian::Factors::Phone::Client.new(client: @client)
end

#push_notification ⇒ Auth0::PushNotification::Client

Returns:

  • (Auth0::PushNotification::Client) 


107
108
109
 
# File 'lib/auth0/guardian/factors/client.rb', line 107

def push_notification
  @push_notification ||= Auth0::Guardian::Factors::PushNotification::Client.new(client: @client)
end

#set(request_options: {}, **params) ⇒ Auth0::Types::SetGuardianFactorResponseContent

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

Examples:

client.guardian.factors.set(
  name: "push-notification",
  enabled: true
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/auth0/guardian/factors/client.rb', line 69

def set(request_options: {}, **params)
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
  request_data = Auth0::Guardian::Factors::Types::SetGuardianFactorRequestContent.new(params).to_h
  non_body_param_names = %w[name]
  body = request_data.except(*non_body_param_names)

  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "guardian/factors/#{URI.encode_uri_component(params[:name].to_s)}",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Auth0::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorResponseContent.load(response.body))
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#sms ⇒ Auth0::Sms::Client

Returns:

  • (Auth0::Sms::Client) 


112
113
114
 
# File 'lib/auth0/guardian/factors/client.rb', line 112

def sms
  @sms ||= Auth0::Guardian::Factors::Sms::Client.new(client: @client)
end