Module: Auth0::Api::V2::Users
- Included in:
- Auth0::Api::V2
- Defined in:
- lib/auth0/api/v2/users.rb
Instance Method Summary (collapse)
- - (Object) create_user(name, options = {})
- - (Object) delete_user(user_id)
- - (Object) delete_user_provider(user_id, provider_name)
- - (Object) delete_users
- - (Object) patch_user(user_id, options)
- - (Object) user(user_id, fields: nil, exclude_fields: nil)
- - (Object) users(per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil) (also: #get_users)
Instance Method Details
- (Object) create_user(name, options = {})
21 22 23 24 25 |
# File 'lib/auth0/api/v2/users.rb', line 21 def create_user(name, ={}) request_params = Hash[.map{|(k,v)| [k.to_sym,v]}] request_params[:name] = name post(path, request_params) end |
- (Object) delete_user(user_id)
42 43 44 45 46 |
# File 'lib/auth0/api/v2/users.rb', line 42 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 |
- (Object) delete_user_provider(user_id, provider_name)
56 57 58 59 |
# File 'lib/auth0/api/v2/users.rb', line 56 def delete_user_provider(user_id, provider_name) path = "/api/v2/users/#{user_id}/multifactor/#{provider_name}" delete(path) end |
- (Object) delete_users
28 29 30 |
# File 'lib/auth0/api/v2/users.rb', line 28 def delete_users delete(path) end |
- (Object) patch_user(user_id, options)
50 51 52 53 |
# File 'lib/auth0/api/v2/users.rb', line 50 def patch_user(user_id, ) path = "/api/v2/users/" + user_id patch(path, ) end |
- (Object) user(user_id, fields: nil, exclude_fields: nil)
33 34 35 36 37 38 39 |
# File 'lib/auth0/api/v2/users.rb', line 33 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 |
- (Object) users(per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil) Also known as: get_users
6 7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/auth0/api/v2/users.rb', line 6 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 |