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



24
25
26
27
28
29
 
# File 'lib/auth0/api/v2/users.rb', line 24

def create_user(name, options={})
  path = "/api/v2/users"
  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:



48
49
50
51
52
 
# File 'lib/auth0/api/v2/users.rb', line 48

def delete_user(user_id)
  raise Auth0::MissingUserId, "Must supply a valid user_id" if user_id.nil? or 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



62
63
64
65
 
# File 'lib/auth0/api/v2/users.rb', line 62

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



32
33
34
35
 
# File 'lib/auth0/api/v2/users.rb', line 32

def delete_users
  path = "/api/v2/users"
  delete(path)
end

#patch_user(user_id, options) ⇒ Object

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



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

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



38
39
40
41
42
43
44
45
 
# File 'lib/auth0/api/v2/users.rb', line 38

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
19
20
 
# 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
  }
  path = "/api/v2/users"
  get(path, request_params)
end