Class: Yext::Api::KnowledgeApi::AccountSettings::User

Inherits:
Utils::ApiBase
  • Object
show all
Includes:
Concerns::AccountChild
Defined in:
lib/yext/api/knowledge_api/account_settings/user.rb

Overview

:administrative_api:

:account_settings:
:user:
  :actions:
    - :action: :index
      :method: :get
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users
      :path_regex: v2/accounts/[^/]+?/users
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/getUsers
      :sandbox_only: false
    - :action: :create
      :method: :post
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users
      :path_regex: v2/accounts/[^/]+?/users
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/createUser
      :sandbox_only: false
    - :action: :show
      :method: :get
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
      :path_regex: v2/accounts/[^/]+?/users/[^/]+?
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/getUser
      :sandbox_only: false
    - :action: :update
      :method: :put
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
      :path_regex: v2/accounts/[^/]+?/users/[^/]+?
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser
      :sandbox_only: false
    - :action: :destroy
      :method: :delete
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
      :path_regex: v2/accounts/[^/]+?/users/[^/]+?
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser
      :sandbox_only: false
    - :action: :change_password
      :method: :put
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}/password
      :path_regex: v2/accounts/[^/]+?/users/[^/]+?/password
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword
      :sandbox_only: false

Instance Method Summary collapse

Methods included from Concerns::AccountChild

#accountId=, association_name, ensure_relation, with_account_path

Methods included from Concerns::FaradayConnection

faraday_connection

Instance Method Details

#change_password!(new_password) ⇒ Object 



74
75
76
 
# File 'lib/yext/api/knowledge_api/account_settings/user.rb', line 74

def change_password!(new_password)
  self.class.where(id: id, account_id: ).change_password!(new_password)
end