pulpcore_client 3.69.2 → 3.70.0

data/docs/UsersApi.md

@@ -2,29 +2,28 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](UsersApi.md#create) | **POST** /pulp/api/v3/users/ | Create an user
-[**delete**](UsersApi.md#delete) | **DELETE** {auth_user_href} | Delete an user
-[**list**](UsersApi.md#list) | **GET** /pulp/api/v3/users/ | List users
-[**partial_update**](UsersApi.md#partial_update) | **PATCH** {auth_user_href} | Update an user
-[**read**](UsersApi.md#read) | **GET** {auth_user_href} | Inspect an user
-[**update**](UsersApi.md#update) | **PUT** {auth_user_href} | Update an user
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](UsersApi.md#create) | **POST** /pulp/api/v3/users/ | Create an user |
+| [**delete**](UsersApi.md#delete) | **DELETE** {auth_user_href} | Delete an user |
+| [**list**](UsersApi.md#list) | **GET** /pulp/api/v3/users/ | List users |
+| [**partial_update**](UsersApi.md#partial_update) | **PATCH** {auth_user_href} | Update an user |
+| [**read**](UsersApi.md#read) | **GET** {auth_user_href} | Inspect an user |
+| [**update**](UsersApi.md#update) | **PUT** {auth_user_href} | Update an user |
 
 
 ## create
 
-> UserResponse create(user)
+> <UserResponse> create(user)
 
 Create an user
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -34,23 +33,40 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::UsersApi.new
-user = PulpcoreClient::User.new # User | 
+user = PulpcoreClient::User.new({username: 'username_example'}) # User | 
 
 begin
-  #Create an user
+  # Create an user
   result = api_instance.create(user)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->create: #{e}"
+  puts "Error when calling UsersApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> create_with_http_info(user)
+
+```ruby
+begin
+  # Create an user
+  data, status_code, headers = api_instance.create_with_http_info(user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user** | [**User**](User.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  |  |
 
 ### Return type
 
@@ -74,10 +90,10 @@ Delete an user
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -90,19 +106,36 @@ api_instance = PulpcoreClient::UsersApi.new
 auth_user_href = 'auth_user_href_example' # String | 
 
 begin
-  #Delete an user
+  # Delete an user
   api_instance.delete(auth_user_href)
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->delete: #{e}"
+  puts "Error when calling UsersApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
 
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
+> <Array(nil, Integer, Hash)> delete_with_http_info(auth_user_href)
+
+```ruby
+begin
+  # Delete an user
+  data, status_code, headers = api_instance.delete_with_http_info(auth_user_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_href** | **String** |  |  |
 
 ### Return type
 
@@ -120,16 +153,16 @@ nil (empty response body)
 
 ## list
 
-> PaginatedUserResponseList list(opts)
+> <PaginatedUserResponseList> list(opts)
 
 List users
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -144,80 +177,97 @@ opts = {
   email__contains: 'email__contains_example', # String | Filter results where email contains value
   email__icontains: 'email__icontains_example', # String | Filter results where email contains value
   email__iexact: 'email__iexact_example', # String | Filter results where email matches value
-  email__in: ['email__in_example'], # Array<String> | Filter results where email is in a comma-separated list of values
+  email__in: ['inner_example'], # Array<String> | Filter results where email is in a comma-separated list of values
   first_name: 'first_name_example', # String | Filter results where first_name matches value
   first_name__contains: 'first_name__contains_example', # String | Filter results where first_name contains value
   first_name__icontains: 'first_name__icontains_example', # String | Filter results where first_name contains value
   first_name__iexact: 'first_name__iexact_example', # String | Filter results where first_name matches value
-  first_name__in: ['first_name__in_example'], # Array<String> | Filter results where first_name is in a comma-separated list of values
+  first_name__in: ['inner_example'], # Array<String> | Filter results where first_name is in a comma-separated list of values
   is_active: true, # Boolean | Filter results where is_active matches value
   is_staff: true, # Boolean | Filter results where is_staff matches value
   last_name: 'last_name_example', # String | Filter results where last_name matches value
   last_name__contains: 'last_name__contains_example', # String | Filter results where last_name contains value
   last_name__icontains: 'last_name__icontains_example', # String | Filter results where last_name contains value
   last_name__iexact: 'last_name__iexact_example', # String | Filter results where last_name matches value
-  last_name__in: ['last_name__in_example'], # Array<String> | Filter results where last_name is in a comma-separated list of values
+  last_name__in: ['inner_example'], # Array<String> | Filter results where last_name is in a comma-separated list of values
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering  * `id` - Id * `-id` - Id (descending) * `password` - Password * `-password` - Password (descending) * `last_login` - Last login * `-last_login` - Last login (descending) * `is_superuser` - Is superuser * `-is_superuser` - Is superuser (descending) * `username` - Username * `-username` - Username (descending) * `first_name` - First name * `-first_name` - First name (descending) * `last_name` - Last name * `-last_name` - Last name (descending) * `email` - Email * `-email` - Email (descending) * `is_staff` - Is staff * `-is_staff` - Is staff (descending) * `is_active` - Is active * `-is_active` - Is active (descending) * `date_joined` - Date joined * `-date_joined` - Date joined (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  ordering: ['-date_joined'], # Array<String> | Ordering  * `id` - Id * `-id` - Id (descending) * `password` - Password * `-password` - Password (descending) * `last_login` - Last login * `-last_login` - Last login (descending) * `is_superuser` - Is superuser * `-is_superuser` - Is superuser (descending) * `username` - Username * `-username` - Username (descending) * `first_name` - First name * `-first_name` - First name (descending) * `last_name` - Last name * `-last_name` - Last name (descending) * `email` - Email * `-email` - Email (descending) * `is_staff` - Is staff * `-is_staff` - Is staff (descending) * `is_active` - Is active * `-is_active` - Is active (descending) * `date_joined` - Date joined * `-date_joined` - Date joined (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
   username: 'username_example', # String | Filter results where username matches value
   username__contains: 'username__contains_example', # String | Filter results where username contains value
   username__icontains: 'username__icontains_example', # String | Filter results where username contains value
   username__iexact: 'username__iexact_example', # String | Filter results where username matches value
-  username__in: ['username__in_example'], # Array<String> | Filter results where username is in a comma-separated list of values
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  username__in: ['inner_example'], # Array<String> | Filter results where username is in a comma-separated list of values
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List users
+  # List users
   result = api_instance.list(opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->list: #{e}"
+  puts "Error when calling UsersApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedUserResponseList>, Integer, Hash)> list_with_http_info(opts)
 
+```ruby
+begin
+  # List users
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedUserResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email** | **String**| Filter results where email matches value | [optional] 
- **email__contains** | **String**| Filter results where email contains value | [optional] 
- **email__icontains** | **String**| Filter results where email contains value | [optional] 
- **email__iexact** | **String**| Filter results where email matches value | [optional] 
- **email__in** | [**Array&lt;String&gt;**](String.md)| Filter results where email is in a comma-separated list of values | [optional] 
- **first_name** | **String**| Filter results where first_name matches value | [optional] 
- **first_name__contains** | **String**| Filter results where first_name contains value | [optional] 
- **first_name__icontains** | **String**| Filter results where first_name contains value | [optional] 
- **first_name__iexact** | **String**| Filter results where first_name matches value | [optional] 
- **first_name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where first_name is in a comma-separated list of values | [optional] 
- **is_active** | **Boolean**| Filter results where is_active matches value | [optional] 
- **is_staff** | **Boolean**| Filter results where is_staff matches value | [optional] 
- **last_name** | **String**| Filter results where last_name matches value | [optional] 
- **last_name__contains** | **String**| Filter results where last_name contains value | [optional] 
- **last_name__icontains** | **String**| Filter results where last_name contains value | [optional] 
- **last_name__iexact** | **String**| Filter results where last_name matches value | [optional] 
- **last_name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where last_name is in a comma-separated list of values | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;id&#x60; - Id * &#x60;-id&#x60; - Id (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;last_login&#x60; - Last login * &#x60;-last_login&#x60; - Last login (descending) * &#x60;is_superuser&#x60; - Is superuser * &#x60;-is_superuser&#x60; - Is superuser (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;first_name&#x60; - First name * &#x60;-first_name&#x60; - First name (descending) * &#x60;last_name&#x60; - Last name * &#x60;-last_name&#x60; - Last name (descending) * &#x60;email&#x60; - Email * &#x60;-email&#x60; - Email (descending) * &#x60;is_staff&#x60; - Is staff * &#x60;-is_staff&#x60; - Is staff (descending) * &#x60;is_active&#x60; - Is active * &#x60;-is_active&#x60; - Is active (descending) * &#x60;date_joined&#x60; - Date joined * &#x60;-date_joined&#x60; - Date joined (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [optional] 
- **username** | **String**| Filter results where username matches value | [optional] 
- **username__contains** | **String**| Filter results where username contains value | [optional] 
- **username__icontains** | **String**| Filter results where username contains value | [optional] 
- **username__iexact** | **String**| Filter results where username matches value | [optional] 
- **username__in** | [**Array&lt;String&gt;**](String.md)| Filter results where username is in a comma-separated list of values | [optional] 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Filter results where email matches value | [optional] |
+| **email__contains** | **String** | Filter results where email contains value | [optional] |
+| **email__icontains** | **String** | Filter results where email contains value | [optional] |
+| **email__iexact** | **String** | Filter results where email matches value | [optional] |
+| **email__in** | [**Array&lt;String&gt;**](String.md) | Filter results where email is in a comma-separated list of values | [optional] |
+| **first_name** | **String** | Filter results where first_name matches value | [optional] |
+| **first_name__contains** | **String** | Filter results where first_name contains value | [optional] |
+| **first_name__icontains** | **String** | Filter results where first_name contains value | [optional] |
+| **first_name__iexact** | **String** | Filter results where first_name matches value | [optional] |
+| **first_name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where first_name is in a comma-separated list of values | [optional] |
+| **is_active** | **Boolean** | Filter results where is_active matches value | [optional] |
+| **is_staff** | **Boolean** | Filter results where is_staff matches value | [optional] |
+| **last_name** | **String** | Filter results where last_name matches value | [optional] |
+| **last_name__contains** | **String** | Filter results where last_name contains value | [optional] |
+| **last_name__icontains** | **String** | Filter results where last_name contains value | [optional] |
+| **last_name__iexact** | **String** | Filter results where last_name matches value | [optional] |
+| **last_name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where last_name is in a comma-separated list of values | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;id&#x60; - Id * &#x60;-id&#x60; - Id (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;last_login&#x60; - Last login * &#x60;-last_login&#x60; - Last login (descending) * &#x60;is_superuser&#x60; - Is superuser * &#x60;-is_superuser&#x60; - Is superuser (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;first_name&#x60; - First name * &#x60;-first_name&#x60; - First name (descending) * &#x60;last_name&#x60; - Last name * &#x60;-last_name&#x60; - Last name (descending) * &#x60;email&#x60; - Email * &#x60;-email&#x60; - Email (descending) * &#x60;is_staff&#x60; - Is staff * &#x60;-is_staff&#x60; - Is staff (descending) * &#x60;is_active&#x60; - Is active * &#x60;-is_active&#x60; - Is active (descending) * &#x60;date_joined&#x60; - Date joined * &#x60;-date_joined&#x60; - Date joined (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
+| **username** | **String** | Filter results where username matches value | [optional] |
+| **username__contains** | **String** | Filter results where username contains value | [optional] |
+| **username__icontains** | **String** | Filter results where username contains value | [optional] |
+| **username__iexact** | **String** | Filter results where username matches value | [optional] |
+| **username__in** | [**Array&lt;String&gt;**](String.md) | Filter results where username is in a comma-separated list of values | [optional] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -235,16 +285,16 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> UserResponse partial_update(auth_user_href, patched_user)
+> <UserResponse> partial_update(auth_user_href, patched_user)
 
 Update an user
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -258,21 +308,38 @@ auth_user_href = 'auth_user_href_example' # String |
 patched_user = PulpcoreClient::PatchedUser.new # PatchedUser | 
 
 begin
-  #Update an user
+  # Update an user
   result = api_instance.partial_update(auth_user_href, patched_user)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->partial_update: #{e}"
+  puts "Error when calling UsersApi->partial_update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<UserResponse>, Integer, Hash)> partial_update_with_http_info(auth_user_href, patched_user)
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **patched_user** | [**PatchedUser**](PatchedUser.md)|  | 
+```ruby
+begin
+  # Update an user
+  data, status_code, headers = api_instance.partial_update_with_http_info(auth_user_href, patched_user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_href** | **String** |  |  |
+| **patched_user** | [**PatchedUser**](PatchedUser.md) |  |  |
 
 ### Return type
 
@@ -290,16 +357,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> UserResponse read(auth_user_href, opts)
+> <UserResponse> read(auth_user_href, opts)
 
 Inspect an user
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -311,27 +378,44 @@ end
 api_instance = PulpcoreClient::UsersApi.new
 auth_user_href = 'auth_user_href_example' # String | 
 opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect an user
+  # Inspect an user
   result = api_instance.read(auth_user_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->read: #{e}"
+  puts "Error when calling UsersApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> read_with_http_info(auth_user_href, opts)
+
+```ruby
+begin
+  # Inspect an user
+  data, status_code, headers = api_instance.read_with_http_info(auth_user_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_href** | **String** |  |  |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -349,16 +433,16 @@ Name | Type | Description  | Notes
 
 ## update
 
-> UserResponse update(auth_user_href, user)
+> <UserResponse> update(auth_user_href, user)
 
 Update an user
 
 ViewSet for User.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -369,24 +453,41 @@ end
 
 api_instance = PulpcoreClient::UsersApi.new
 auth_user_href = 'auth_user_href_example' # String | 
-user = PulpcoreClient::User.new # User | 
+user = PulpcoreClient::User.new({username: 'username_example'}) # User | 
 
 begin
-  #Update an user
+  # Update an user
   result = api_instance.update(auth_user_href, user)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersApi->update: #{e}"
+  puts "Error when calling UsersApi->update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> update_with_http_info(auth_user_href, user)
 
+```ruby
+begin
+  # Update an user
+  data, status_code, headers = api_instance.update_with_http_info(auth_user_href, user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersApi->update_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **user** | [**User**](User.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_href** | **String** |  |  |
+| **user** | [**User**](User.md) |  |  |
 
 ### Return type