Class: LaunchDarklyApi::CustomRolesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/custom_roles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomRolesApi

Returns a new instance of CustomRolesApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_custom_role(custom_role_key, opts = {}) ⇒ nil

Delete custom role Delete a custom role by key

Parameters:

  • custom_role_key (String) —

    The custom role key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 27

def delete_custom_role(custom_role_key, opts = {})
  delete_custom_role_with_http_info(custom_role_key, opts)
  nil
end

#delete_custom_role_with_http_info(custom_role_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete custom role Delete a custom role by key

Parameters:

  • custom_role_key (String) —

    The custom role key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 37

def delete_custom_role_with_http_info(custom_role_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.delete_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.delete_custom_role"
  end
  # resource path
  local_var_path = '/api/v2/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', CGI.escape(custom_role_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"CustomRolesApi.delete_custom_role",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#delete_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_role(custom_role_key, opts = {}) ⇒ CustomRole

Get custom role Get a single custom role by key or ID

Parameters:

  • custom_role_key (String) —

    The custom role key or ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 90

def get_custom_role(custom_role_key, opts = {})
  data, _status_code, _headers = get_custom_role_with_http_info(custom_role_key, opts)
  data
end

#get_custom_role_with_http_info(custom_role_key, opts = {}) ⇒ Array<(CustomRole, Integer, Hash)>

Get custom role Get a single custom role by key or ID

Parameters:

  • custom_role_key (String) —

    The custom role key or ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomRole, Integer, Hash)>) —

    CustomRole data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
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
142
143
144
145
146
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 100

def get_custom_role_with_http_info(custom_role_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.get_custom_role"
  end
  # resource path
  local_var_path = '/api/v2/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', CGI.escape(custom_role_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomRole'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"CustomRolesApi.get_custom_role",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_roles(opts = {}) ⇒ CustomRoles

List custom roles Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it’s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you’re interested in learning more about our enterprise plans, contact [email protected].

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 152

def get_custom_roles(opts = {})
  data, _status_code, _headers = get_custom_roles_with_http_info(opts)
  data
end

#get_custom_roles_with_http_info(opts = {}) ⇒ Array<(CustomRoles, Integer, Hash)>

List custom roles Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it&#39;s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you&#39;re interested in learning more about our enterprise plans, contact [email protected].

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomRoles, Integer, Hash)>) —

    CustomRoles data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 161

def get_custom_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_roles ...'
  end
  # resource path
  local_var_path = '/api/v2/roles'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomRoles'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"CustomRolesApi.get_custom_roles",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_custom_role(custom_role_key, patch_with_comment, opts = {}) ⇒ CustomRole

Update custom role Update a single custom role. The request must be a valid JSON Patch document describing the changes to be made to the custom role. To add an element to the ‘policy` array, set the `path` to `/policy` and then append `/<array index>`. Using `/0` adds to the beginning of the array.

Parameters:

  • custom_role_key (String) —

    The custom role key

  • patch_with_comment (PatchWithComment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



211
212
213
214
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 211

def patch_custom_role(custom_role_key, patch_with_comment, opts = {})
  data, _status_code, _headers = patch_custom_role_with_http_info(custom_role_key, patch_with_comment, opts)
  data
end

#patch_custom_role_with_http_info(custom_role_key, patch_with_comment, opts = {}) ⇒ Array<(CustomRole, Integer, Hash)>

Update custom role Update a single custom role. The request must be a valid JSON Patch document describing the changes to be made to the custom role. To add an element to the &#x60;policy&#x60; array, set the &#x60;path&#x60; to &#x60;/policy&#x60; and then append &#x60;/&lt;array index&gt;&#x60;. Using &#x60;/0&#x60; adds to the beginning of the array.

Parameters:

  • custom_role_key (String) —

    The custom role key

  • patch_with_comment (PatchWithComment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomRole, Integer, Hash)>) —

    CustomRole data, response status code and response headers



222
223
224
225
226
227
228
229
230
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 222

def patch_custom_role_with_http_info(custom_role_key, patch_with_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.patch_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.patch_custom_role"
  end
  # verify the required parameter 'patch_with_comment' is set
  if @api_client.config.client_side_validation && patch_with_comment.nil?
    fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling CustomRolesApi.patch_custom_role"
  end
  # resource path
  local_var_path = '/api/v2/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', CGI.escape(custom_role_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomRole'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"CustomRolesApi.patch_custom_role",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#patch_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_custom_role(custom_role_post, opts = {}) ⇒ CustomRole

Create custom role Create a new custom role

Parameters:

  • custom_role_post (CustomRolePost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



284
285
286
287
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 284

def post_custom_role(custom_role_post, opts = {})
  data, _status_code, _headers = post_custom_role_with_http_info(custom_role_post, opts)
  data
end

#post_custom_role_with_http_info(custom_role_post, opts = {}) ⇒ Array<(CustomRole, Integer, Hash)>

Create custom role Create a new custom role

Parameters:

  • custom_role_post (CustomRolePost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomRole, Integer, Hash)>) —

    CustomRole data, response status code and response headers



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
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
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 294

def post_custom_role_with_http_info(custom_role_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.post_custom_role ...'
  end
  # verify the required parameter 'custom_role_post' is set
  if @api_client.config.client_side_validation && custom_role_post.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_post' when calling CustomRolesApi.post_custom_role"
  end
  # resource path
  local_var_path = '/api/v2/roles'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(custom_role_post)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomRole'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"CustomRolesApi.post_custom_role",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#post_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end