pulpcore_client 3.16.24 → 3.17.0

data/docs/GroupsApi.md

@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](GroupsApi.md#add_role) | **POST** {group_href}add_role/ | 
 [**create**](GroupsApi.md#create) | **POST** /pulp/api/v3/groups/ | Create a group
-[**delete**](GroupsApi.md#delete) | **DELETE** {auth_group_href} | Delete a group
+[**delete**](GroupsApi.md#delete) | **DELETE** {group_href} | Delete a group
 [**list**](GroupsApi.md#list) | **GET** /pulp/api/v3/groups/ | List groups
-[**partial_update**](GroupsApi.md#partial_update) | **PATCH** {auth_group_href} | Update a group
-[**read**](GroupsApi.md#read) | **GET** {auth_group_href} | Inspect a group
-[**update**](GroupsApi.md#update) | **PUT** {auth_group_href} | Update a group
+[**list_roles**](GroupsApi.md#list_roles) | **GET** {group_href}list_roles/ | 
+[**my_permissions**](GroupsApi.md#my_permissions) | **GET** {group_href}my_permissions/ | 
+[**partial_update**](GroupsApi.md#partial_update) | **PATCH** {group_href} | Update a group
+[**read**](GroupsApi.md#read) | **GET** {group_href} | Inspect a group
+[**remove_role**](GroupsApi.md#remove_role) | **POST** {group_href}remove_role/ | 
+[**update**](GroupsApi.md#update) | **PUT** {group_href} | Update a group
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(group_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::GroupsApi.new
+group_href = 'group_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(group_href, nested_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > GroupResponse create(group)
@@ -68,7 +126,7 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> delete(auth_group_href)
+> delete(group_href)
 
 Delete a group
 
@@ -87,11 +145,11 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 
 begin
   #Delete a group
-  api_instance.delete(auth_group_href)
+  api_instance.delete(group_href)
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsApi->delete: #{e}"
 end
@@ -102,7 +160,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
 
 ### Return type
 
@@ -195,9 +253,125 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(group_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::GroupsApi.new
+group_href = 'group_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(group_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::GroupsApi.new
+group_href = 'group_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
-> GroupResponse partial_update(auth_group_href, patched_group)
+> GroupResponse partial_update(group_href, patched_group)
 
 Update a group
 
@@ -216,12 +390,12 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 patched_group = PulpcoreClient::PatchedGroup.new # PatchedGroup | 
 
 begin
   #Update a group
-  result = api_instance.partial_update(auth_group_href, patched_group)
+  result = api_instance.partial_update(group_href, patched_group)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsApi->partial_update: #{e}"
@@ -233,7 +407,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **patched_group** | [**PatchedGroup**](PatchedGroup.md)|  | 
 
 ### Return type
@@ -252,7 +426,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> GroupResponse read(auth_group_href, opts)
+> GroupResponse read(group_href, opts)
 
 Inspect a group
 
@@ -271,7 +445,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 opts = {
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -279,7 +453,7 @@ opts = {
 
 begin
   #Inspect a group
-  result = api_instance.read(auth_group_href, opts)
+  result = api_instance.read(group_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsApi->read: #{e}"
@@ -291,7 +465,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
@@ -309,9 +483,63 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(group_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::GroupsApi.new
+group_href = 'group_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(group_href, nested_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
-> GroupResponse update(auth_group_href, group)
+> GroupResponse update(group_href, group)
 
 Update a group
 
@@ -330,12 +558,12 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 group = PulpcoreClient::Group.new # Group | 
 
 begin
   #Update a group
-  result = api_instance.update(auth_group_href, group)
+  result = api_instance.update(group_href, group)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsApi->update: #{e}"
@@ -347,7 +575,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **group** | [**Group**](Group.md)|  | 
 
 ### Return type

data/docs/GroupsModelPermissionsApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](GroupsModelPermissionsApi.md#create) | **POST** {auth_group_href}model_permissions/ | Create a permission
-[**delete**](GroupsModelPermissionsApi.md#delete) | **DELETE** {auth_groups_model_permission_href} | Delete a permission
-[**list**](GroupsModelPermissionsApi.md#list) | **GET** {auth_group_href}model_permissions/ | List permissions
-[**read**](GroupsModelPermissionsApi.md#read) | **GET** {auth_groups_model_permission_href} | Inspect a permission
+[**create**](GroupsModelPermissionsApi.md#create) | **POST** {group_href}model_permissions/ | Create a permission
+[**delete**](GroupsModelPermissionsApi.md#delete) | **DELETE** {groups_model_permission_href} | Delete a permission
+[**list**](GroupsModelPermissionsApi.md#list) | **GET** {group_href}model_permissions/ | List permissions
+[**read**](GroupsModelPermissionsApi.md#read) | **GET** {groups_model_permission_href} | Inspect a permission
 
 
 
 ## create
 
-> PermissionResponse create(auth_group_href, body)
+> PermissionResponse create(group_href, body)
 
 Create a permission
 
@@ -32,12 +32,12 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 body = nil # Object | 
 
 begin
   #Create a permission
-  result = api_instance.create(auth_group_href, body)
+  result = api_instance.create(group_href, body)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsModelPermissionsApi->create: #{e}"
@@ -49,7 +49,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **body** | **Object**|  | 
 
 ### Return type
@@ -68,7 +68,7 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> delete(auth_groups_model_permission_href)
+> delete(groups_model_permission_href)
 
 Delete a permission
 
@@ -87,11 +87,11 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-auth_groups_model_permission_href = 'auth_groups_model_permission_href_example' # String | 
+groups_model_permission_href = 'groups_model_permission_href_example' # String | 
 
 begin
   #Delete a permission
-  api_instance.delete(auth_groups_model_permission_href)
+  api_instance.delete(groups_model_permission_href)
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsModelPermissionsApi->delete: #{e}"
 end
@@ -102,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_groups_model_permission_href** | **String**|  | 
+ **groups_model_permission_href** | **String**|  | 
 
 ### Return type
 
@@ -120,7 +120,7 @@ nil (empty response body)
 
 ## list
 
-> PaginatedPermissionResponseList list(auth_group_href, opts)
+> PaginatedPermissionResponseList list(group_href, opts)
 
 List permissions
 
@@ -139,7 +139,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
@@ -150,7 +150,7 @@ opts = {
 
 begin
   #List permissions
-  result = api_instance.list(auth_group_href, opts)
+  result = api_instance.list(group_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsModelPermissionsApi->list: #{e}"
@@ -162,7 +162,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | **String**| Which field to use when ordering the results. | [optional] 
@@ -185,7 +185,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> PermissionResponse read(auth_groups_model_permission_href, opts)
+> PermissionResponse read(groups_model_permission_href, opts)
 
 Inspect a permission
 
@@ -204,7 +204,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-auth_groups_model_permission_href = 'auth_groups_model_permission_href_example' # String | 
+groups_model_permission_href = 'groups_model_permission_href_example' # String | 
 opts = {
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -212,7 +212,7 @@ opts = {
 
 begin
   #Inspect a permission
-  result = api_instance.read(auth_groups_model_permission_href, opts)
+  result = api_instance.read(groups_model_permission_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsModelPermissionsApi->read: #{e}"
@@ -224,7 +224,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_groups_model_permission_href** | **String**|  | 
+ **groups_model_permission_href** | **String**|  | 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 

data/docs/GroupsObjectPermissionsApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](GroupsObjectPermissionsApi.md#create) | **POST** {auth_group_href}object_permissions/ | Create a permission
-[**delete**](GroupsObjectPermissionsApi.md#delete) | **DELETE** {auth_groups_object_permission_href} | Delete a permission
-[**list**](GroupsObjectPermissionsApi.md#list) | **GET** {auth_group_href}object_permissions/ | List permissions
-[**read**](GroupsObjectPermissionsApi.md#read) | **GET** {auth_groups_object_permission_href} | Inspect a permission
+[**create**](GroupsObjectPermissionsApi.md#create) | **POST** {group_href}object_permissions/ | Create a permission
+[**delete**](GroupsObjectPermissionsApi.md#delete) | **DELETE** {groups_object_permission_href} | Delete a permission
+[**list**](GroupsObjectPermissionsApi.md#list) | **GET** {group_href}object_permissions/ | List permissions
+[**read**](GroupsObjectPermissionsApi.md#read) | **GET** {groups_object_permission_href} | Inspect a permission
 
 
 
 ## create
 
-> PermissionResponse create(auth_group_href, body)
+> PermissionResponse create(group_href, body)
 
 Create a permission
 
@@ -32,12 +32,12 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsObjectPermissionsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 body = nil # Object | 
 
 begin
   #Create a permission
-  result = api_instance.create(auth_group_href, body)
+  result = api_instance.create(group_href, body)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsObjectPermissionsApi->create: #{e}"
@@ -49,7 +49,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **body** | **Object**|  | 
 
 ### Return type
@@ -68,7 +68,7 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> delete(auth_groups_object_permission_href)
+> delete(groups_object_permission_href)
 
 Delete a permission
 
@@ -87,11 +87,11 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsObjectPermissionsApi.new
-auth_groups_object_permission_href = 'auth_groups_object_permission_href_example' # String | 
+groups_object_permission_href = 'groups_object_permission_href_example' # String | 
 
 begin
   #Delete a permission
-  api_instance.delete(auth_groups_object_permission_href)
+  api_instance.delete(groups_object_permission_href)
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsObjectPermissionsApi->delete: #{e}"
 end
@@ -102,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_groups_object_permission_href** | **String**|  | 
+ **groups_object_permission_href** | **String**|  | 
 
 ### Return type
 
@@ -120,7 +120,7 @@ nil (empty response body)
 
 ## list
 
-> PaginatedPermissionResponseList list(auth_group_href, opts)
+> PaginatedPermissionResponseList list(group_href, opts)
 
 List permissions
 
@@ -139,7 +139,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsObjectPermissionsApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
@@ -150,7 +150,7 @@ opts = {
 
 begin
   #List permissions
-  result = api_instance.list(auth_group_href, opts)
+  result = api_instance.list(group_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsObjectPermissionsApi->list: #{e}"
@@ -162,7 +162,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | **String**| Which field to use when ordering the results. | [optional] 
@@ -185,7 +185,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> PermissionResponse read(auth_groups_object_permission_href, opts)
+> PermissionResponse read(groups_object_permission_href, opts)
 
 Inspect a permission
 
@@ -204,7 +204,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsObjectPermissionsApi.new
-auth_groups_object_permission_href = 'auth_groups_object_permission_href_example' # String | 
+groups_object_permission_href = 'groups_object_permission_href_example' # String | 
 opts = {
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -212,7 +212,7 @@ opts = {
 
 begin
   #Inspect a permission
-  result = api_instance.read(auth_groups_object_permission_href, opts)
+  result = api_instance.read(groups_object_permission_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsObjectPermissionsApi->read: #{e}"
@@ -224,7 +224,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_groups_object_permission_href** | **String**|  | 
+ **groups_object_permission_href** | **String**|  | 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]