Class: PulpcoreClient::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



19
20
21
 
# File 'lib/pulpcore_client/api/users_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/pulpcore_client/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedUserResponseList

List users ViewSet for User. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :email (String) —

    Filter results where email matches value

  • :email__contains (String) —

    Filter results where email contains value

  • :email__icontains (String) —

    Filter results where email contains value

  • :email__iexact (String) —

    Filter results where email matches value

  • :email__in (Array<String>) —

    Filter results where email is in a comma-separated list of values

  • :first_name (String) —

    Filter results where first_name matches value

  • :first_name__contains (String) —

    Filter results where first_name contains value

  • :first_name__icontains (String) —

    Filter results where first_name contains value

  • :first_name__iexact (String) —

    Filter results where first_name matches value

  • :first_name__in (Array<String>) —

    Filter results where first_name is in a comma-separated list of values

  • :is_active (Boolean) —

    Filter results where is_active matches value

  • :is_staff (Boolean) —

    Filter results where is_staff matches value

  • :last_name (String) —

    Filter results where last_name matches value

  • :last_name__contains (String) —

    Filter results where last_name contains value

  • :last_name__icontains (String) —

    Filter results where last_name contains value

  • :last_name__iexact (String) —

    Filter results where last_name matches value

  • :last_name__in (Array<String>) —

    Filter results where last_name is in a comma-separated list of values

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :username (String) —

    Filter results where username matches value

  • :username__contains (String) —

    Filter results where username contains value

  • :username__icontains (String) —

    Filter results where username contains value

  • :username__iexact (String) —

    Filter results where username matches value

  • :username__in (Array<String>) —

    Filter results where username is in a comma-separated list of values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



53
54
55
56
 
# File 'lib/pulpcore_client/api/users_api.rb', line 53

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedUserResponseList, Integer, Hash)>

List users ViewSet for User. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :email (String) —

    Filter results where email matches value

  • :email__contains (String) —

    Filter results where email contains value

  • :email__icontains (String) —

    Filter results where email contains value

  • :email__iexact (String) —

    Filter results where email matches value

  • :email__in (Array<String>) —

    Filter results where email is in a comma-separated list of values

  • :first_name (String) —

    Filter results where first_name matches value

  • :first_name__contains (String) —

    Filter results where first_name contains value

  • :first_name__icontains (String) —

    Filter results where first_name contains value

  • :first_name__iexact (String) —

    Filter results where first_name matches value

  • :first_name__in (Array<String>) —

    Filter results where first_name is in a comma-separated list of values

  • :is_active (Boolean) —

    Filter results where is_active matches value

  • :is_staff (Boolean) —

    Filter results where is_staff matches value

  • :last_name (String) —

    Filter results where last_name matches value

  • :last_name__contains (String) —

    Filter results where last_name contains value

  • :last_name__icontains (String) —

    Filter results where last_name contains value

  • :last_name__iexact (String) —

    Filter results where last_name matches value

  • :last_name__in (Array<String>) —

    Filter results where last_name is in a comma-separated list of values

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :username (String) —

    Filter results where username matches value

  • :username__contains (String) —

    Filter results where username contains value

  • :username__icontains (String) —

    Filter results where username contains value

  • :username__iexact (String) —

    Filter results where username matches value

  • :username__in (Array<String>) —

    Filter results where username is in a comma-separated list of values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    PaginatedUserResponseList data, response status code and response headers



89
90
91
92
93
94
95
96
97
98
99
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
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/pulpcore_client/api/users_api.rb', line 89

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/users/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'email__contains'] = opts[:'email__contains'] if !opts[:'email__contains'].nil?
  query_params[:'email__icontains'] = opts[:'email__icontains'] if !opts[:'email__icontains'].nil?
  query_params[:'email__iexact'] = opts[:'email__iexact'] if !opts[:'email__iexact'].nil?
  query_params[:'email__in'] = @api_client.build_collection_param(opts[:'email__in'], :csv) if !opts[:'email__in'].nil?
  query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
  query_params[:'first_name__contains'] = opts[:'first_name__contains'] if !opts[:'first_name__contains'].nil?
  query_params[:'first_name__icontains'] = opts[:'first_name__icontains'] if !opts[:'first_name__icontains'].nil?
  query_params[:'first_name__iexact'] = opts[:'first_name__iexact'] if !opts[:'first_name__iexact'].nil?
  query_params[:'first_name__in'] = @api_client.build_collection_param(opts[:'first_name__in'], :csv) if !opts[:'first_name__in'].nil?
  query_params[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'is_staff'] = opts[:'is_staff'] if !opts[:'is_staff'].nil?
  query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
  query_params[:'last_name__contains'] = opts[:'last_name__contains'] if !opts[:'last_name__contains'].nil?
  query_params[:'last_name__icontains'] = opts[:'last_name__icontains'] if !opts[:'last_name__icontains'].nil?
  query_params[:'last_name__iexact'] = opts[:'last_name__iexact'] if !opts[:'last_name__iexact'].nil?
  query_params[:'last_name__in'] = @api_client.build_collection_param(opts[:'last_name__in'], :csv) if !opts[:'last_name__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'username__contains'] = opts[:'username__contains'] if !opts[:'username__contains'].nil?
  query_params[:'username__icontains'] = opts[:'username__icontains'] if !opts[:'username__icontains'].nil?
  query_params[:'username__iexact'] = opts[:'username__iexact'] if !opts[:'username__iexact'].nil?
  query_params[:'username__in'] = @api_client.build_collection_param(opts[:'username__in'], :csv) if !opts[:'username__in'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PaginatedUserResponseList' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#permissions(auth_user_href, opts = {}) ⇒ PermissionResponse

List user permissions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



165
166
167
168
 
# File 'lib/pulpcore_client/api/users_api.rb', line 165

def permissions(auth_user_href, opts = {})
  data, _status_code, _headers = permissions_with_http_info(auth_user_href, opts)
  data
end

#permissions_with_http_info(auth_user_href, opts = {}) ⇒ Array<(PermissionResponse, Integer, Hash)>

List user permissions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    PermissionResponse data, response status code and response headers



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/pulpcore_client/api/users_api.rb', line 176

def permissions_with_http_info(auth_user_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.permissions ...'
  end
  # verify the required parameter 'auth_user_href' is set
  if @api_client.config.client_side_validation && auth_user_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_user_href' when calling UsersApi.permissions"
  end
  # resource path
  local_var_path = '{auth_user_href}permissions/'.sub('{' + 'auth_user_href' + '}', CGI.escape(auth_user_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PermissionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#read(auth_user_href, opts = {}) ⇒ UserResponse

Inspect an user ViewSet for User. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



232
233
234
235
 
# File 'lib/pulpcore_client/api/users_api.rb', line 232

def read(auth_user_href, opts = {})
  data, _status_code, _headers = read_with_http_info(auth_user_href, opts)
  data
end

#read_with_http_info(auth_user_href, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Inspect an user ViewSet for User. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    UserResponse data, response status code and response headers



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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/pulpcore_client/api/users_api.rb', line 244

def read_with_http_info(auth_user_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.read ...'
  end
  # verify the required parameter 'auth_user_href' is set
  if @api_client.config.client_side_validation && auth_user_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_user_href' when calling UsersApi.read"
  end
  # resource path
  local_var_path = '{auth_user_href}'.sub('{' + 'auth_user_href' + '}', CGI.escape(auth_user_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'UserResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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