Class: Hanko::Api::Admin::Users

Inherits:

BaseResource

• Object
• BaseResource
• Hanko::Api::Admin::Users

Defined in:

lib/hanko/api/admin/users.rb

Overview

Admin resource for managing users. Inherits list, get, create, update, delete from BaseResource.

Defined Under Namespace

Classes: UserContext

Instance Method Summary

• #call(user_id) ⇒ UserContext

  Return a user-scoped context for accessing sub-resources.

• #initialize(connection) ⇒ Users constructor

  Initialize the users resource.

Methods inherited from BaseResource

#create, #delete, #get, #list, #update

Constructor Details

#initialize(connection) ⇒ Users

Initialize the users resource.

Parameters:

• connection (Hanko::Connection) —

  the HTTP connection to use

# File 'lib/hanko/api/admin/users.rb', line 13

def initialize(connection)
  super(connection, '/users')
  @connection = connection
end

Instance Method Details

#call(user_id) ⇒ UserContext

Return a user-scoped context for accessing sub-resources.

Parameters:

• user_id (String) —

  the unique identifier of the user

Returns:

• (UserContext) —

  a context scoped to the given user

# File 'lib/hanko/api/admin/users.rb', line 22

def call(user_id)
  UserContext.new(@connection, user_id)
end