Class: Hanko::Api::AdminNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/hanko/api/admin.rb

Overview

Entry point for the Hanko Admin API, providing access to admin sub-resources.

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ AdminNamespace

Initialize the admin namespace.

Parameters:



24
25
26
 
# File 'lib/hanko/api/admin.rb', line 24

def initialize(connection)
  @connection = connection
end

Instance Method Details

#audit_logs ⇒ Admin::AuditLogs

Access the audit logs resource.

Returns:



47
48
49
 
# File 'lib/hanko/api/admin.rb', line 47

def audit_logs
  Admin::AuditLogs.new(@connection)
end

#users(user_id = nil) ⇒ Admin::Users, Admin::Users::UserContext

Access the users resource, optionally scoped to a specific user.

Parameters:

  • user_id (String, nil) (defaults to: nil) —

    optional user ID to scope to a single user context

Returns:



32
33
34
35
 
# File 'lib/hanko/api/admin.rb', line 32

def users(user_id = nil)
  users_resource = Admin::Users.new(@connection)
  user_id ? users_resource.call(user_id) : users_resource
end

#webhooks ⇒ Admin::Webhooks

Access the webhooks resource.

Returns:



40
41
42
 
# File 'lib/hanko/api/admin.rb', line 40

def webhooks
  Admin::Webhooks.new(@connection)
end