Class: TableauApi::Resources::Users

Inherits:
Base
  • Object
show all
Defined in:
lib/tableau_api/resources/users.rb

Constant Summary collapse

SITE_ROLES = 
%w[
  Creator
  Explorer
  ExplorerCanPublish
  SiteAdministratorCreator
  SiteAdministratorExplorer
  ServerAdministrator
  Unlicensed
  Viewer
].freeze

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from TableauApi::Resources::Base

Instance Method Details

#create(username:, site_role: 'Viewer') ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/tableau_api/resources/users.rb', line 15

def create(username:, site_role: 'Viewer')
  raise 'invalid site_role' unless SITE_ROLES.include? site_role

  request = Builder::XmlMarkup.new.tsRequest do |ts|
    ts.user(name: username, siteRole: site_role)
  end

  res = @client.connection.api_post("sites/#{@client.auth.site_id}/users", body: request)

  res['tsResponse']['user'] if res.code == 201
end

#list ⇒ Object 



27
28
29
30
 
# File 'lib/tableau_api/resources/users.rb', line 27

def list
  url = "sites/#{@client.auth.site_id}/users"
  @client.connection.api_get_collection(url, 'users.user')
end

#update_user(user_id:, site_role:) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/tableau_api/resources/users.rb', line 32

def update_user(user_id:, site_role:)
  raise 'invalid site_role' unless SITE_ROLES.include? site_role

  res = @client.connection.api_get("sites/#{@client.auth.site_id}/users/#{user_id}")

  raise 'failed to find user' if res.code != 200
  user = res['tsResponse']['user']

  request = Builder::XmlMarkup.new.tsRequest do |ts|
    ts.user(name: user['name'], siteRole: site_role)
  end

  res = @client.connection.api_put("sites/#{@client.auth.site_id}/users/#{user_id}", body: request)

  res['tsResponse']['user'] if res.code == 200
end