Class: Grafana::Api::Admin::Users

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Users

Returns a new instance of Users.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#auth_tokens(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#create(admin_create_user_form:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def create(admin_create_user_form:)
  raise ArgumentError, 'admin_create_user_form is required' if admin_create_user_form.nil?

  @connection.call(
    :POST,
    '/admin/users',
    type: Grafana::Api::Models::AdminCreateUserResponse,
    auth: ['basic'],
    body: admin_create_user_form
  )
end

#delete(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#disable(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/grafana-api/api/admin/users.rb', line 45

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

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

#enable(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/grafana-api/api/admin/users.rb', line 57

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

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

#logout(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/grafana-api/api/admin/users.rb', line 69

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

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

#password(user_id:, admin_update_user_password_form:) ⇒ Object

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/grafana-api/api/admin/users.rb', line 81

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

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

#permissions(user_id:, admin_update_user_permissions_form:) ⇒ Object

Raises:

  • (ArgumentError) 


95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/grafana-api/api/admin/users.rb', line 95

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

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

#quotas(user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/grafana-api/api/admin/users.rb', line 109

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

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

#quotas_put(quota_target:, user_id:, update_quota_cmd:) ⇒ Object

Raises:

  • (ArgumentError) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/grafana-api/api/admin/users.rb', line 121

def quotas_put(quota_target:, user_id:, update_quota_cmd:)
  raise ArgumentError, 'quota_target is required' if quota_target.nil?
  raise ArgumentError, 'user_id is required' if user_id.nil?
  raise ArgumentError, 'update_quota_cmd is required' if update_quota_cmd.nil?

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

#revoke_auth_token(user_id:, revoke_auth_token_cmd:) ⇒ Object

Raises:

  • (ArgumentError) 


137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/grafana-api/api/admin/users.rb', line 137

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

  @connection.call(
    :POST,
    '/admin/users/{user_id}/revoke-auth-token'
      .gsub('{user_id}', ERB::Util.url_encode(user_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['basic'],
    body: revoke_auth_token_cmd
  )
end