Class: Auth0::Guardian::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



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

def initialize(client:)
  @client = client
end

Instance Method Details

#enrollments ⇒ Auth0::Enrollments::Client

Returns:

  • (Auth0::Enrollments::Client) 


91
92
93
 
# File 'lib/auth0/guardian/client.rb', line 91

def enrollments
  @enrollments ||= Auth0::Guardian::Enrollments::Client.new(client: @client)
end

#factors ⇒ Auth0::Factors::Client

Returns:

  • (Auth0::Factors::Client) 


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

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

#get(request_options: {}, **_params) ⇒ Auth0::Types::GetGuardianSettingsResponseContent

TODO: Link this endpoint to relevant documentation when available.

Examples:

client.guardian.get

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:



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

def get(request_options: {}, **_params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "guardian/settings",
    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::GetGuardianSettingsResponseContent.load(response.body))
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#policies ⇒ Auth0::Policies::Client

Returns:

  • (Auth0::Policies::Client) 


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

def policies
  @policies ||= Auth0::Guardian::Policies::Client.new(client: @client)
end

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

Update a tenant's guardian settings such as Remember Me

Examples:

client.guardian.set(
  display_remember_me_checkbox: true,
  remember_me_default_value: true,
  mfa_session_inactivity_timeout: 1,
  mfa_session_overall_timeout: 1
)

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)

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/auth0/guardian/client.rb', line 67

def set(request_options: {}, **params)
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "guardian/settings",
    body: Auth0::Guardian::Types::SetGuardianSettingsRequestContent.new(params).to_h,
    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::SetGuardianSettingsResponseContent.load(response.body))
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end