Module: Auth0::Api::V2::Users

Included in:
Auth0::Api::V2
Defined in:
lib/auth0/api/v2/users.rb

Overview

auth0.com/docs/apiv2#!/users

Instance Method Summary collapse

Instance Method Details

#create_user(name, options = {}) ⇒ Object

auth0.com/docs/apiv2#!/users/post_users



22
23
24
25
26
 
# File 'lib/auth0/api/v2/users.rb', line 22

def create_user(name, options={})
  request_params = Hash[options.map{|(k,v)| [k.to_sym,v]}]
  request_params[:name] = name
  post(path, request_params)
end

#delete_user(user_id) ⇒ Object

auth0.com/docs/apiv2#!/users/delete_users_by_id

Raises:



43
44
45
46
47
 
# File 'lib/auth0/api/v2/users.rb', line 43

def delete_user(user_id)
  raise Auth0::UserIdIsBlank, "if you want to remove all users user delete_users method" if user_id.to_s.empty?
  path = "/api/v2/users/" + user_id.to_s
  delete(path)
end

#delete_user_provider(user_id, provider_name) ⇒ Object

auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider



57
58
59
60
 
# File 'lib/auth0/api/v2/users.rb', line 57

def delete_user_provider(user_id, provider_name)
  path = "/api/v2/users/#{user_id}/multifactor/#{provider_name}"
  delete(path)
end

#delete_users ⇒ Object

auth0.com/docs/apiv2#!/users/delete_users



29
30
31
 
# File 'lib/auth0/api/v2/users.rb', line 29

def delete_users
  delete(path)
end

#patch_user(user_id, options) ⇒ Object

auth0.com/docs/apiv2#!/users/patch_users_by_id



51
52
53
54
 
# File 'lib/auth0/api/v2/users.rb', line 51

def patch_user(user_id, options)
  path = "/api/v2/users/" + user_id
  patch(path, options)
end

#user(user_id, fields: nil, exclude_fields: nil) ⇒ Object

auth0.com/docs/apiv2#!/users/get_users_by_id



34
35
36
37
38
39
40
 
# File 'lib/auth0/api/v2/users.rb', line 34

def user(user_id, fields: nil, exclude_fields: nil)
  path = "/api/v2/users/" + user_id.to_s
  request_params = {  fields:         fields,
                      exclude_fields: exclude_fields
                    }
  get(path, request_params)
end

#users(per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil) ⇒ Object Also known as: get_users

auth0.com/docs/apiv2#!/users/get_users



7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/auth0/api/v2/users.rb', line 7

def users( per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil )
  request_params = {  per_page:       per_page,
                      page:           page,
                      include_totals: include_totals,
                      sort:           sort,
                      connection:     connection,
                      fields:         fields,
                      exclude_fields: exclude_fields,
                      q:              q
                    }
  get(path, request_params)
end