Class: Grafana::Api::Users

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

Defined Under Namespace

Classes: Orgs, Teams

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Users

Returns a new instance of Users.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/grafana-api/api/users.rb', line 9

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

  @connection.call(
    :GET,
    '/users/{user_id}'
      .gsub('{user_id}', ERB::Util.url_encode(user_id.to_s)),
    type: Grafana::Api::Models::UserProfileDTO,
    auth: ['api_key', 'basic']
  )
end

#list(perpage: nil, page: nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/grafana-api/api/users.rb', line 21

def list(perpage: nil, page: nil)
  @connection.call(
    :GET,
    '/users',
    type: [Grafana::Api::Models::UserSearchHitDTO],
    auth: ['api_key', 'basic'],
    query: { 'perpage' => perpage, 'page' => page }
  )
end

#lookup(login_or_email:) ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/grafana-api/api/users.rb', line 31

def lookup(login_or_email:)
  raise ArgumentError, 'login_or_email is required' if .nil?

  @connection.call(
    :GET,
    '/users/lookup',
    type: Grafana::Api::Models::UserProfileDTO,
    auth: ['api_key', 'basic'],
    query: { 'loginOrEmail' =>  }
  )
end

#search ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'lib/grafana-api/api/users.rb', line 43

def search
  @connection.call(
    :GET,
    '/users/search',
    type: Grafana::Api::Models::SearchUserQueryResult,
    auth: ['api_key', 'basic']
  )
end

#update(user_id:, update_user_command:) ⇒ Object

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/grafana-api/api/users.rb', line 52

def update(user_id:, update_user_command:)
  raise ArgumentError, 'user_id is required' if user_id.nil?
  raise ArgumentError, 'update_user_command is required' if update_user_command.nil?

  @connection.call(
    :PUT,
    '/users/{user_id}'
      .gsub('{user_id}', ERB::Util.url_encode(user_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: update_user_command
  )
end