Class: OpenapiClient::UsersElementsDataApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/users_elements_data_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersElementsDataApi

Returns a new instance of UsersElementsDataApi.



19
20
21
 
# File 'lib/openapi_client/api/users_elements_data_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/openapi_client/api/users_elements_data_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#elements_assign_role_to_user(proj_id, env_id, elements_config_id, user_id, elements_user_role_create, opts = {}) ⇒ RoleAssignmentRead

Assign role to user Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

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

    the optional parameters

Returns:



31
32
33
34
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 31

def elements_assign_role_to_user(proj_id, env_id, elements_config_id, user_id, elements_user_role_create, opts = {})
  data, _status_code, _headers = elements_assign_role_to_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_create, opts)
  data
end

#elements_assign_role_to_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_create, opts = {}) ⇒ Array<(RoleAssignmentRead, Integer, Hash)>

Assign role to user Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    RoleAssignmentRead data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 45

def elements_assign_role_to_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_assign_role_to_user ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_assign_role_to_user"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_assign_role_to_user"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_assign_role_to_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersElementsDataApi.elements_assign_role_to_user"
  end
  # verify the required parameter 'elements_user_role_create' is set
  if @api_client.config.client_side_validation && elements_user_role_create.nil?
    fail ArgumentError, "Missing the required parameter 'elements_user_role_create' when calling UsersElementsDataApi.elements_assign_role_to_user"
  end
  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.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(elements_user_role_create)

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

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

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_assign_role_to_user",
    :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: UsersElementsDataApi#elements_assign_role_to_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#elements_create_user(proj_id, env_id, elements_config_id, elements_user_create, opts = {}) ⇒ UserRead

Create user Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:



122
123
124
125
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 122

def elements_create_user(proj_id, env_id, elements_config_id, elements_user_create, opts = {})
  data, _status_code, _headers = elements_create_user_with_http_info(proj_id, env_id, elements_config_id, elements_user_create, opts)
  data
end

#elements_create_user_with_http_info(proj_id, env_id, elements_config_id, elements_user_create, opts = {}) ⇒ Array<(UserRead, Integer, Hash)>

Create user Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    UserRead data, response status code and response headers



135
136
137
138
139
140
141
142
143
144
145
146
147
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 135

def elements_create_user_with_http_info(proj_id, env_id, elements_config_id, elements_user_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_create_user ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_create_user"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_create_user"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_create_user"
  end
  # verify the required parameter 'elements_user_create' is set
  if @api_client.config.client_side_validation && elements_user_create.nil?
    fail ArgumentError, "Missing the required parameter 'elements_user_create' when calling UsersElementsDataApi.elements_create_user"
  end
  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.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(elements_user_create)

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

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

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_create_user",
    :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: UsersElementsDataApi#elements_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#elements_delete_user(proj_id, env_id, elements_config_id, user_id, opts = {}) ⇒ nil

Delete user

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

  • (nil) 


207
208
209
210
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 207

def elements_delete_user(proj_id, env_id, elements_config_id, user_id, opts = {})
  elements_delete_user_with_http_info(proj_id, env_id, elements_config_id, user_id, opts)
  nil
end

#elements_delete_user_with_http_info(proj_id, env_id, elements_config_id, user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete user

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



219
220
221
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/openapi_client/api/users_elements_data_api.rb', line 219

def elements_delete_user_with_http_info(proj_id, env_id, elements_config_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_delete_user ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_delete_user"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_delete_user"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_delete_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersElementsDataApi.elements_delete_user"
  end
  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.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] || ['HTTPBearer']

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_delete_user",
    :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: UsersElementsDataApi#elements_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#elements_list_roles(proj_id, env_id, elements_config_id, opts = {}) ⇒ Array<ElementsRoleRead>

List roles Lists all the users defined within an environment.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



289
290
291
292
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 289

def elements_list_roles(proj_id, env_id, elements_config_id, opts = {})
  data, _status_code, _headers = elements_list_roles_with_http_info(proj_id, env_id, elements_config_id, opts)
  data
end

#elements_list_roles_with_http_info(proj_id, env_id, elements_config_id, opts = {}) ⇒ Array<(Array<ElementsRoleRead>, Integer, Hash)>

List roles Lists all the users defined within an environment.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

    Array<ElementsRoleRead> data, response status code and response headers



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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 304

def elements_list_roles_with_http_info(proj_id, env_id, elements_config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_list_roles ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_list_roles"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_list_roles"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_list_roles"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UsersElementsDataApi.elements_list_roles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersElementsDataApi.elements_list_roles, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersElementsDataApi.elements_list_roles, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/roles'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # 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] || 'Array<ElementsRoleRead>'

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

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_list_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: UsersElementsDataApi#elements_list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#elements_list_users(proj_id, env_id, elements_config_id, opts = {}) ⇒ PaginatedResultUserRead

List users Lists all the users defined within an environment.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



385
386
387
388
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 385

def elements_list_users(proj_id, env_id, elements_config_id, opts = {})
  data, _status_code, _headers = elements_list_users_with_http_info(proj_id, env_id, elements_config_id, opts)
  data
end

#elements_list_users_with_http_info(proj_id, env_id, elements_config_id, opts = {}) ⇒ Array<(PaginatedResultUserRead, Integer, Hash)>

List users Lists all the users defined within an environment.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Text search for the email field

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

    PaginatedResultUserRead data, response status code and response headers



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 400

def elements_list_users_with_http_info(proj_id, env_id, elements_config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_list_users ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_list_users"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_list_users"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_list_users"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UsersElementsDataApi.elements_list_users, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersElementsDataApi.elements_list_users, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersElementsDataApi.elements_list_users, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # 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] || 'PaginatedResultUserRead'

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

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_list_users",
    :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: UsersElementsDataApi#elements_list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#elements_unassign_role_from_user(proj_id, env_id, elements_config_id, user_id, elements_user_role_remove, opts = {}) ⇒ nil

Unassign role from user Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

  • (nil) 


480
481
482
483
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 480

def elements_unassign_role_from_user(proj_id, env_id, elements_config_id, user_id, elements_user_role_remove, opts = {})
  elements_unassign_role_from_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_remove, opts)
  nil
end

#elements_unassign_role_from_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_remove, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unassign role from user Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • user_id (String) —

    Either the unique id of the user, or the URL-friendly key of the user (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 494

def elements_unassign_role_from_user_with_http_info(proj_id, env_id, elements_config_id, user_id, elements_user_role_remove, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.elements_unassign_role_from_user ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.elements_unassign_role_from_user"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.elements_unassign_role_from_user"
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.elements_unassign_role_from_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersElementsDataApi.elements_unassign_role_from_user"
  end
  # verify the required parameter 'elements_user_role_remove' is set
  if @api_client.config.client_side_validation && elements_user_role_remove.nil?
    fail ArgumentError, "Missing the required parameter 'elements_user_role_remove' when calling UsersElementsDataApi.elements_unassign_role_from_user"
  end
  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.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(elements_user_role_remove)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.elements_unassign_role_from_user",
    :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: UsersElementsDataApi#elements_unassign_role_from_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_config_active(elements_config_id, proj_id, env_id, opts = {}) ⇒ nil

Set Config Active Updates the embed_config.

Parameters:

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

  • (nil) 


570
571
572
573
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 570

def set_config_active(elements_config_id, proj_id, env_id, opts = {})
  set_config_active_with_http_info(elements_config_id, proj_id, env_id, opts)
  nil
end

#set_config_active_with_http_info(elements_config_id, proj_id, env_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Set Config Active Updates the embed_config.

Parameters:

  • elements_config_id (String) —

    Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the &quot;slug&quot;).

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/openapi_client/api/users_elements_data_api.rb', line 582

def set_config_active_with_http_info(elements_config_id, proj_id, env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersElementsDataApi.set_config_active ...'
  end
  # verify the required parameter 'elements_config_id' is set
  if @api_client.config.client_side_validation && elements_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'elements_config_id' when calling UsersElementsDataApi.set_config_active"
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling UsersElementsDataApi.set_config_active"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling UsersElementsDataApi.set_config_active"
  end
  # resource path
  local_var_path = '/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/active'.sub('{' + 'elements_config_id' + '}', CGI.escape(elements_config_id.to_s)).sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.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] || ['HTTPBearer']

  new_options = opts.merge(
    :operation => :"UsersElementsDataApi.set_config_active",
    :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: UsersElementsDataApi#set_config_active\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end