Class: Wavefront::Role

Inherits:
CoreApi show all
Includes:
Mixin::User
Defined in:
lib/wavefront-sdk/role.rb

Overview

Manage and query Wavefront roles

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts

Instance Method Summary collapse

Methods included from Mixin::User

#validate_account_list, #validate_role_list, #validate_user_list, #validate_usergroup_list

Methods inherited from CoreApi

#api_base, #api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms

Methods included from Mixins

#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?

Methods included from Validators

#uuid?, #wf_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::CoreApi

Instance Method Details

#add_assignees(id, assignees) ⇒ Wavefront::Response

POST /api/v2/role/id/addAssignees Add multiple users and user groups to a specific role

Parameters:

  • id (String) —

    role ID

  • assignees (Array[String]) —

    list of roles or accounts to be added

Returns:



84
85
86
87
88
 
# File 'lib/wavefront-sdk/role.rb', line 84

def add_assignees(id, assignees)
  wf_role_id?(id)
  validate_user_list(assignees)
  api.post([id, 'addAssignees'].uri_concat, assignees, 'application/json')
end

#create(body) ⇒ Wavefront::Response

POST /api/v2/role Create a specific role

Parameters:

  • body (Hash) —

    a hash of parameters describing the role. Please refer to the Wavefront Swagger docs for key:value information

Returns:

Raises:

  • (ArgumentError) 


33
34
35
36
37
 
# File 'lib/wavefront-sdk/role.rb', line 33

def create(body)
  raise ArgumentError unless body.is_a?(Hash)

  api.post('', body, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/role/id Delete a specific role

Parameters:

  • id (String) —

    ID of the role

Returns:



44
45
46
47
 
# File 'lib/wavefront-sdk/role.rb', line 44

def delete(id)
  wf_role_id?(id)
  api.delete(id)
end

#describe(id) ⇒ Wavefront::Response

GET /api/v2/role/id Get a specific role

Parameters:

  • id (String) —

    ID of the role

Returns:



54
55
56
57
 
# File 'lib/wavefront-sdk/role.rb', line 54

def describe(id)
  wf_role_id?(id)
  api.get(id)
end

#grant(permission, roles) ⇒ Wavefront::Response

POST /api/v2/role/grant/permission Grants a single permission to role(s)

Parameters:

  • permission (String) —

    permission to grant

  • roles (Array[String]) —

    list of roles to receive permission

Returns:



110
111
112
113
114
 
# File 'lib/wavefront-sdk/role.rb', line 110

def grant(permission, roles)
  wf_permission?(permission)
  validate_role_list(roles)
  api.post(['grant', permission].uri_concat, roles, 'application/json')
end

#list(offset = 0, limit = 100) ⇒ Wavefront::Response

GET /api/v2/role Get all roles for a customer

Parameters:

  • offset (Int) (defaults to: 0) —

    alert at which the list begins

  • limit (Int) (defaults to: 100) —

    the number of alerts to return

Returns:



23
24
25
 
# File 'lib/wavefront-sdk/role.rb', line 23

def list(offset = 0, limit = 100)
  api.get('', offset: offset, limit: limit)
end

#remove_assignees(id, assignees) ⇒ Wavefront::Response

POST /api/v2/role/id/removeAssignees Remove multiple users and user groups from a specific role

Parameters:

  • id (String) —

    role ID

  • assignees (Array[String]) —

    list of roles or accounts to be removed

Returns:



96
97
98
99
100
101
102
 
# File 'lib/wavefront-sdk/role.rb', line 96

def remove_assignees(id, assignees)
  wf_role_id?(id)
  validate_user_list(assignees)
  api.post([id, 'removeAssignees'].uri_concat,
           assignees,
           'application/json')
end

#revoke(permission, roles) ⇒ Wavefront::Response

POST /api/v2/role/revoke/permission Revokes a single permission from role(s)

Parameters:

  • permission (String) —

    permission to revoke

  • roles (Array[String]) —

    list of roles to lose permission

Returns:



122
123
124
125
126
 
# File 'lib/wavefront-sdk/role.rb', line 122

def revoke(permission, roles)
  wf_permission?(permission)
  validate_role_list(roles)
  api.post(['revoke', permission].uri_concat, roles, 'application/json')
end

#update(id, body, modify = true) ⇒ Wavefront::Response

PUT /api/v2/role/id Update a specific role

Parameters:

  • id (String) —

    role ID

  • body (Hash) —

    key-value hash of the parameters you wish to change

  • modify (true, false) (defaults to: true) —

    if true, use #describe() to get a hash describing the existing object, and modify that with the new body. If false, pass the new body straight through.

Returns:

Raises:

  • (ArgumentError) 


68
69
70
71
72
73
74
75
76
 
# File 'lib/wavefront-sdk/role.rb', line 68

def update(id, body, modify = true)
  wf_role_id?(id)
  raise ArgumentError unless body.is_a?(Hash)

  return api.put(id, body, 'application/json') unless modify

  api.put(id, hash_for_update(describe(id).response, body),
          'application/json')
end

#update_keys ⇒ Object 



13
14
15
 
# File 'lib/wavefront-sdk/role.rb', line 13

def update_keys
  %i[id name description]
end