Class: TableauApi::Resources::Groups

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

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

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

Instance Method Details

#add_user(group_id:, user_id:) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/tableau_api/resources/groups.rb', line 26

def add_user(group_id:, user_id:)
  request = Builder::XmlMarkup.new.tsRequest do |ts|
    ts.user(id: user_id)
  end

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

  res.code == 200
end

#create(name:, default_site_role: 'Viewer') ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/tableau_api/resources/groups.rb', line 4

def create(name:, default_site_role: 'Viewer')
  raise 'invalid default_site_role' unless Users::SITE_ROLES.include? default_site_role

  request = Builder::XmlMarkup.new.tsRequest do |ts|
    ts.group(name: name, defaultSiteRole: default_site_role)
  end

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

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

#list ⇒ Object 



16
17
18
19
 
# File 'lib/tableau_api/resources/groups.rb', line 16

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

#remove_user(group_id:, user_id:) ⇒ Object 



36
37
38
39
40
 
# File 'lib/tableau_api/resources/groups.rb', line 36

def remove_user(group_id:, user_id:)
  res = @client.connection.api_delete("sites/#{@client.auth.site_id}/groups/#{group_id}/users/#{user_id}")

  res.code == 204
end

#users(group_id:) ⇒ Object 



21
22
23
24
 
# File 'lib/tableau_api/resources/groups.rb', line 21

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