# PulpcoreClient::ContentguardsRbacApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**contentguards_core_rbac_add_role**](ContentguardsRbacApi.md#contentguards_core_rbac_add_role) | **POST** {r_b_a_c_content_guard_href}add_role/ | Add a role [**contentguards_core_rbac_create**](ContentguardsRbacApi.md#contentguards_core_rbac_create) | **POST** /pulp/api/v3/contentguards/core/rbac/ | Create a rbac content guard [**contentguards_core_rbac_delete**](ContentguardsRbacApi.md#contentguards_core_rbac_delete) | **DELETE** {r_b_a_c_content_guard_href} | Delete a rbac content guard [**contentguards_core_rbac_list**](ContentguardsRbacApi.md#contentguards_core_rbac_list) | **GET** /pulp/api/v3/contentguards/core/rbac/ | List rbac content guards [**contentguards_core_rbac_list_roles**](ContentguardsRbacApi.md#contentguards_core_rbac_list_roles) | **GET** {r_b_a_c_content_guard_href}list_roles/ | List roles [**contentguards_core_rbac_my_permissions**](ContentguardsRbacApi.md#contentguards_core_rbac_my_permissions) | **GET** {r_b_a_c_content_guard_href}my_permissions/ | List user permissions [**contentguards_core_rbac_partial_update**](ContentguardsRbacApi.md#contentguards_core_rbac_partial_update) | **PATCH** {r_b_a_c_content_guard_href} | Update a rbac content guard [**contentguards_core_rbac_read**](ContentguardsRbacApi.md#contentguards_core_rbac_read) | **GET** {r_b_a_c_content_guard_href} | Inspect a rbac content guard [**contentguards_core_rbac_remove_role**](ContentguardsRbacApi.md#contentguards_core_rbac_remove_role) | **POST** {r_b_a_c_content_guard_href}remove_role/ | Remove a role [**contentguards_core_rbac_update**](ContentguardsRbacApi.md#contentguards_core_rbac_update) | **PUT** {r_b_a_c_content_guard_href} | Update a rbac content guard ## contentguards_core_rbac_add_role > NestedRoleResponse contentguards_core_rbac_add_role(r_b_a_c_content_guard_href, nested_role) Add a 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Add a role result = api_instance.contentguards_core_rbac_add_role(r_b_a_c_content_guard_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_add_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_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 ## contentguards_core_rbac_create > RBACContentGuardResponse contentguards_core_rbac_create(rbac_content_guard) Create a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new rbac_content_guard = PulpcoreClient::RBACContentGuard.new # RBACContentGuard | begin #Create a rbac content guard result = api_instance.contentguards_core_rbac_create(rbac_content_guard) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rbac_content_guard** | [**RBACContentGuard**](RBACContentGuard.md)| | ### Return type [**RBACContentGuardResponse**](RBACContentGuardResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## contentguards_core_rbac_delete > contentguards_core_rbac_delete(r_b_a_c_content_guard_href) Delete a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | begin #Delete a rbac content guard api_instance.contentguards_core_rbac_delete(r_b_a_c_content_guard_href) rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | ### Return type nil (empty response body) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## contentguards_core_rbac_list > PaginatedRBACContentGuardResponseList contentguards_core_rbac_list(opts) List rbac content guards Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new opts = { limit: 56, # Integer | Number of results to return per page. name: 'name_example', # String | Filter results where name matches value name__contains: 'name__contains_example', # String | Filter results where name contains value name__icontains: 'name__icontains_example', # String | Filter results where name contains value name__iexact: 'name__iexact_example', # String | Filter results where name matches value name__in: ['name__in_example'], # Array | Filter results where name is in a comma-separated list of values name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value name__regex: 'name__regex_example', # String | Filter results where name matches regex value name__startswith: 'name__startswith_example', # String | Filter results where name starts with value offset: 56, # Integer | The initial index from which to return the results. ordering: ['ordering_example'], # Array | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) pulp_href__in: ['pulp_href__in_example'], # Array | Multiple values may be separated by commas. pulp_id__in: ['pulp_id__in_example'], # Array | Multiple values may be separated by commas. q: 'q_example', # String | fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List rbac content guards result = api_instance.contentguards_core_rbac_list(opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| Number of results to return per page. | [optional] **name** | **String**| Filter results where name matches value | [optional] **name__contains** | **String**| Filter results where name contains value | [optional] **name__icontains** | **String**| Filter results where name contains value | [optional] **name__iexact** | **String**| Filter results where name matches value | [optional] **name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional] **name__iregex** | **String**| Filter results where name matches regex value | [optional] **name__istartswith** | **String**| Filter results where name starts with value | [optional] **name__regex** | **String**| Filter results where name matches regex value | [optional] **name__startswith** | **String**| Filter results where name starts with value | [optional] **offset** | **Integer**| The initial index from which to return the results. | [optional] **ordering** | [**Array<String>**](String.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] **pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **q** | **String**| | [optional] **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional] ### Return type [**PaginatedRBACContentGuardResponseList**](PaginatedRBACContentGuardResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## contentguards_core_rbac_list_roles > ObjectRolesResponse contentguards_core_rbac_list_roles(r_b_a_c_content_guard_href, opts) List roles 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List roles result = api_instance.contentguards_core_rbac_list_roles(r_b_a_c_content_guard_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_list_roles: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](String.md)| 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 ## contentguards_core_rbac_my_permissions > MyPermissionsResponse contentguards_core_rbac_my_permissions(r_b_a_c_content_guard_href, opts) List user permissions 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List user permissions result = api_instance.contentguards_core_rbac_my_permissions(r_b_a_c_content_guard_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_my_permissions: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](String.md)| 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 ## contentguards_core_rbac_partial_update > RBACContentGuardResponse contentguards_core_rbac_partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard) Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | patched_rbac_content_guard = PulpcoreClient::PatchedRBACContentGuard.new # PatchedRBACContentGuard | begin #Update a rbac content guard result = api_instance.contentguards_core_rbac_partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_partial_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | **patched_rbac_content_guard** | [**PatchedRBACContentGuard**](PatchedRBACContentGuard.md)| | ### Return type [**RBACContentGuardResponse**](RBACContentGuardResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## contentguards_core_rbac_read > RBACContentGuardResponse contentguards_core_rbac_read(r_b_a_c_content_guard_href, opts) Inspect a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #Inspect a rbac content guard result = api_instance.contentguards_core_rbac_read(r_b_a_c_content_guard_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional] ### Return type [**RBACContentGuardResponse**](RBACContentGuardResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## contentguards_core_rbac_remove_role > NestedRoleResponse contentguards_core_rbac_remove_role(r_b_a_c_content_guard_href, nested_role) Remove a 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Remove a role result = api_instance.contentguards_core_rbac_remove_role(r_b_a_c_content_guard_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_remove_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_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 ## contentguards_core_rbac_update > RBACContentGuardResponse contentguards_core_rbac_update(r_b_a_c_content_guard_href, rbac_content_guard) Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard. ### 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::ContentguardsRbacApi.new r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # String | rbac_content_guard = PulpcoreClient::RBACContentGuard.new # RBACContentGuard | begin #Update a rbac content guard result = api_instance.contentguards_core_rbac_update(r_b_a_c_content_guard_href, rbac_content_guard) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling ContentguardsRbacApi->contentguards_core_rbac_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **r_b_a_c_content_guard_href** | **String**| | **rbac_content_guard** | [**RBACContentGuard**](RBACContentGuard.md)| | ### Return type [**RBACContentGuardResponse**](RBACContentGuardResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json