Class: Grafana::Api::AccessControl

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/access_control.rb

Defined Under Namespace

Classes: BuiltInRoles, Roles, Teams, Users

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ AccessControl

Returns a new instance of AccessControl.



5
6
7
 
# File 'lib/grafana-api/api/access_control.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(resource:, resource_id:, set_permissions_command:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/grafana-api/api/access_control.rb', line 9

def create(resource:, resource_id:, set_permissions_command:)
  raise ArgumentError, 'resource is required' if resource.nil?
  raise ArgumentError, 'resource_id is required' if resource_id.nil?
  raise ArgumentError, 'set_permissions_command is required' if set_permissions_command.nil?

  @connection.call(
    :POST,
    '/access-control/{resource}/{resourceID}'
      .gsub('{resource}', ERB::Util.url_encode(resource.to_s))
      .gsub('{resourceID}', ERB::Util.url_encode(resource_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: set_permissions_command
  )
end

#description(resource:) ⇒ Object

Raises:

  • (ArgumentError) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/grafana-api/api/access_control.rb', line 25

def description(resource:)
  raise ArgumentError, 'resource is required' if resource.nil?

  @connection.call(
    :GET,
    '/access-control/{resource}/description'
      .gsub('{resource}', ERB::Util.url_encode(resource.to_s)),
    type: Grafana::Api::Models::Description,
    auth: ['api_key', 'basic']
  )
end

#get(resource:, resource_id:) ⇒ Object

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/grafana-api/api/access_control.rb', line 37

def get(resource:, resource_id:)
  raise ArgumentError, 'resource is required' if resource.nil?
  raise ArgumentError, 'resource_id is required' if resource_id.nil?

  @connection.call(
    :GET,
    '/access-control/{resource}/{resourceID}'
      .gsub('{resource}', ERB::Util.url_encode(resource.to_s))
      .gsub('{resourceID}', ERB::Util.url_encode(resource_id.to_s)),
    type: [Grafana::Api::Models::ResourcePermissionDTO],
    auth: ['api_key', 'basic']
  )
end

#status ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/grafana-api/api/access_control.rb', line 51

def status
  @connection.call(
    :GET,
    '/access-control/status',
    type: nil,
    auth: ['api_key', 'basic']
  )
end