Module: Grafana::Teams

Included in:
Client
Defined in:
lib/grafana/teams.rb

Overview

docs.grafana.org/http_api/team/

This API can be used to create/update/delete Teams and to add/remove users to Teams. All actions require that the user has the Admin role for the organization.

Instance Method Summary collapse

Instance Method Details

#add_team(params) ⇒ Object

docs.grafana.org/http_api/team/#add-team

The Team name needs to be unique. name is required and email is optional. POST /api/teams

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/grafana/teams.rb', line 110

def add_team( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing \'params\'') if( params.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  name  = validate( params, required: true, var: 'name'  , type: String )
  email = validate( params, required: false, var: 'email', type: String )

  o_team = search_team(name: name)

  status      = o_team.dig('status')
  total_count = o_team.dig('totalCount')
#         teams = o_team.dig('teams')
#         team  = teams.detect { |x| x['name'] == name }

  return { 'status' => 404, 'message' => format('team \'%s\' alread exists', name) } if(status == 200 && total_count > 0)

  endpoint = '/api/teams'

  payload = {
    name: name,
    email: email
  }
  payload.reject!{ |_, y| y.nil? }

  @logger.debug("Creating team: #{name} (POST #{endpoint})") if @debug

  post( endpoint, payload.to_json )
end

#add_team_member(params) ⇒ Object

docs.grafana.org/http_api/team/#add-team-member

POST /api/teams/:teamId/members

Raises:

  • (ArgumentError) 


268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/grafana/teams.rb', line 268

def add_team_member(params)

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing \'params\'') if( params.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  team_id = validate( params, required: true , var: 'team_id' )
  user_id = validate( params, required: false, var: 'user_id' )

  if( user_id.is_a?(String) && user_id.is_a?(Integer) )
    raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an User name) or an Integer (for an User Id), given \'%s\'', user_id.class.to_s))
  end
  raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)
    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }

    team_id = team.dig('id')
  end

  if(user_id.is_a?(String))
    usr     = user(user_id)
    status  = usr.dig('status')
    user_id  = usr.dig('id')

    return { 'status' => 404, 'message' => format( 'No User \'%s\' found', user_id) } unless(status == 200)
  end

  payload = {
    userId: user_id
  }
  payload.reject!{ |_, y| y.nil? }

  endpoint = format( '/api/teams/%d/members', team_id )

  post( endpoint, payload.to_json )
end

#delete_team(team_id) ⇒ Object

docs.grafana.org/http_api/team/#delete-team-by-id

DELETE /api/teams/:id

Raises:

  • (ArgumentError) 


194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/grafana/teams.rb', line 194

def delete_team(team_id)

  if( team_id.is_a?(String) && team_id.is_a?(Integer) )
    raise ArgumentError.new(format('wrong type. user \'team_id\' must be an String (for an Team name) or an Integer (for an Team Id), given \'%s\'', team_id.class.to_s))
  end
  raise ArgumentError.new('missing \'team_id\'') if( team_id.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)

    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }

    team_id = team.dig('id')
  end

  endpoint = format( '/api/teams/%s', team_id )

  @logger.debug("delete team Id #{team_id} (GET #{endpoint})") if @debug
  delete(endpoint)
end

#remove_team_member(params) ⇒ Object

docs.grafana.org/http_api/team/#remove-member-from-team

DELETE /api/teams/:teamId/members/:userId

Raises:

  • (ArgumentError) 


321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/grafana/teams.rb', line 321

def remove_team_member(params)

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing \'params\'') if( params.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  team_id = validate( params, required: true , var: 'team_id' )
  user_id = validate( params, required: false, var: 'user_id' )

  if( user_id.is_a?(String) && user_id.is_a?(Integer) )
    raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an User name) or an Integer (for an User Id), given \'%s\'', user_id.class.to_s))
  end
  raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)
    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }

    team_id = team.dig('id')
  end

  if(user_id.is_a?(String))
    usr     = user(user_id)
    status  = usr.dig('status')
    usr_id  = usr.dig('id')

    return { 'status' => 404, 'message' => format( 'No User \'%s\' found', user_id) } unless(status == 200)
  end

  endpoint = format( '/api/teams/%d/members/%d', team_id, usr_id )

  delete(endpoint)
end

#search_team(params) ⇒ Object

Status Codes:

200 - Ok 401 - Unauthorized 403 - Permission denied 404 - Team not found (if searching by name)

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/grafana/teams.rb', line 37

def search_team( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing \'params\'') if( params.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  perpage = validate( params, required: false, var: 'perpage', type: Integer ) || 1000
  page    = validate( params, required: false, var: 'page'   , type: Integer ) || 1
  query   = validate( params, required: false, var: 'query'  , type: String )
  name    = validate( params, required: false, var: 'name'   , type: String )

  if(name.nil?)
    api     = []
    api << format( 'perpage=%s', perpage ) unless( perpage.nil? )
    api << format( 'page=%s', page ) unless( page.nil? )
    api << format( 'query=%s', CGI.escape( query ) ) unless( query.nil? )

    api = api.join( '&' )

    endpoint = format('/api/teams/search?%s', api)
  else
    endpoint = format('/api/teams/search?name=%s',CGI.escape(name))
  end

  @logger.debug("Attempting to search for alerts (GET #{endpoint})") if @debug

  r = get(endpoint)
  r['status'] = 404 if( r.dig('totalCount').zero? )
  r
end

#team(team_id) ⇒ Object

docs.grafana.org/http_api/team/#get-team-by-id

Get Team By Id GET /api/teams/:id

Raises:

  • (ArgumentError) 


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/grafana/teams.rb', line 76

def team( team_id )

  if( team_id.is_a?(String) && team_id.is_a?(Integer) )
    raise ArgumentError.new(format('wrong type. user \'team_id\' must be an String (for an Team name) or an Integer (for an Team Id), given \'%s\'', team_id.class.to_s))
  end
  raise ArgumentError.new('missing \'team_id\'') if( team_id.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)
    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }
    team_id = team.dig('id')
  end

  endpoint = format( '/api/teams/%s', team_id )

  @logger.debug("Getting team by Id #{team_id} (GET #{endpoint})") if @debug
  get(endpoint)
end

#team_members(team_id) ⇒ Object

docs.grafana.org/http_api/team/#get-team-members

GET /api/teams/:teamId/members

Raises:

  • (ArgumentError) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/grafana/teams.rb', line 231

def team_members(team_id)

  if( team_id.is_a?(String) && team_id.is_a?(Integer) )
    raise ArgumentError.new(format('wrong type. user \'team_id\' must be an String (for an Team name) or an Integer (for an Team Id), given \'%s\'', team_id.class.to_s))
  end
  raise ArgumentError.new('missing \'team_id\'') if( team_id.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)

    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }

    team_id = team.dig('id')
  end

  endpoint = format( '/api/teams/%s/members', team_id )

  @logger.debug("Getting team by Id #{team_id} (GET #{endpoint})") if @debug

  get(endpoint)
end

#update_team(params) ⇒ Object

docs.grafana.org/http_api/team/#update-team

There are two fields that can be updated for a team: name and email. PUT /api/teams/:id

Raises:

  • (ArgumentError) 


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/grafana/teams.rb', line 148

def update_team( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing \'params\'') if( params.size.zero? )

  v, mv = version.values
  return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)

  team_id = validate( params, required: true , var: 'team_id' )
  name    = validate( params, required: false, var: 'name' , type: String )
  email   = validate( params, required: true , var: 'email', type: String )

  if(team_id.is_a?(String))
    o_team = search_team(name: team_id)
    status      = o_team.dig('status')
    total_count = o_team.dig('totalCount')

    return { 'status' => 404, 'message' => format( 'No Team \'%s\' found', team_id) } unless(status == 200 && total_count > 0)

    teams = o_team.dig('teams')
    team  = teams.detect { |x| x['name'] == team_id }

    team_id = team.dig('id')
  end

  payload = {
    email: email,
    name: name
  }
  payload.reject!{ |_, y| y.nil? }

  endpoint = format( '/api/teams/%d', team_id )
  @logger.debug("Updating team with Id #{team_id} (PUT #{endpoint})") if @debug

  put( endpoint, payload.to_json )
end