class PulpcoreClient::ContentguardsRbacApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Add download permission Give users and groups the `download` permission @param r_b_a_c_content_guard_href [String] @param rbac_content_guard_permission [RBACContentGuardPermission] @param [Hash] opts the optional parameters @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 28 def assign_permission(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts = {}) data, _status_code, _headers = assign_permission_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts) data end
Add download permission Give users and groups the `download` permission @param r_b_a_c_content_guard_href [String] @param rbac_content_guard_permission [RBACContentGuardPermission] @param [Hash] opts the optional parameters @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 39 def assign_permission_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.assign_permission ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.assign_permission" end # verify the required parameter 'rbac_content_guard_permission' is set if @api_client.config.client_side_validation && rbac_content_guard_permission.nil? fail ArgumentError, "Missing the required parameter 'rbac_content_guard_permission' when calling ContentguardsRbacApi.assign_permission" end # resource path local_var_path = '{r_b_a_c_content_guard_href}assign_permission/'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_href.to_s).gsub('%2F', '/')) # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(rbac_content_guard_permission) # return_type return_type = opts[:return_type] || 'RBACContentGuardResponse' # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#assign_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param rbac_content_guard [RBACContentGuard] @param [Hash] opts the optional parameters @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 97 def create(rbac_content_guard, opts = {}) data, _status_code, _headers = create_with_http_info(rbac_content_guard, opts) data end
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. @param rbac_content_guard [RBACContentGuard] @param [Hash] opts the optional parameters @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 107 def create_with_http_info(rbac_content_guard, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.create ...' end # verify the required parameter 'rbac_content_guard' is set if @api_client.config.client_side_validation && rbac_content_guard.nil? fail ArgumentError, "Missing the required parameter 'rbac_content_guard' when calling ContentguardsRbacApi.create" end # resource path local_var_path = '/pulp/api/v3/contentguards/core/rbac/' # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(rbac_content_guard) # return_type return_type = opts[:return_type] || 'RBACContentGuardResponse' # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param r_b_a_c_content_guard_href [String] @param [Hash] opts the optional parameters @return [nil]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 161 def delete(r_b_a_c_content_guard_href, opts = {}) delete_with_http_info(r_b_a_c_content_guard_href, opts) nil end
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. @param r_b_a_c_content_guard_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 171 def delete_with_http_info(r_b_a_c_content_guard_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.delete ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.delete" end # resource path local_var_path = '{r_b_a_c_content_guard_href}'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # 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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [PaginatedRBACContentGuardResponseList]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 230 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
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. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedRBACContentGuardResponseList
, Integer, Hash)>] PaginatedRBACContentGuardResponseList
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 249 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.list ...' end # resource path local_var_path = '/pulp/api/v3/contentguards/core/rbac/' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil? query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil? query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil? query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].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] || 'PaginatedRBACContentGuardResponseList' # 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: ContentguardsRbacApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param r_b_a_c_content_guard_href [String] @param patched_rbac_content_guard [PatchedRBACContentGuard] @param [Hash] opts the optional parameters @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 308 def partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts = {}) data, _status_code, _headers = partial_update_with_http_info(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts) data end
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. @param r_b_a_c_content_guard_href [String] @param patched_rbac_content_guard [PatchedRBACContentGuard] @param [Hash] opts the optional parameters @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 319 def partial_update_with_http_info(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.partial_update ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.partial_update" end # verify the required parameter 'patched_rbac_content_guard' is set if @api_client.config.client_side_validation && patched_rbac_content_guard.nil? fail ArgumentError, "Missing the required parameter 'patched_rbac_content_guard' when calling ContentguardsRbacApi.partial_update" end # resource path local_var_path = '{r_b_a_c_content_guard_href}'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_href.to_s).gsub('%2F', '/')) # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(patched_rbac_content_guard) # return_type return_type = opts[:return_type] || 'RBACContentGuardResponse' # 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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param r_b_a_c_content_guard_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 379 def read(r_b_a_c_content_guard_href, opts = {}) data, _status_code, _headers = read_with_http_info(r_b_a_c_content_guard_href, opts) data end
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. @param r_b_a_c_content_guard_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 391 def read_with_http_info(r_b_a_c_content_guard_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.read ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.read" end # resource path local_var_path = '{r_b_a_c_content_guard_href}'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_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] || 'RBACContentGuardResponse' # 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: ContentguardsRbacApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Remove download permission Remove `download` permission from users and groups @param r_b_a_c_content_guard_href [String] @param rbac_content_guard_permission [RBACContentGuardPermission] @param [Hash] opts the optional parameters @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 446 def remove_permission(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts = {}) data, _status_code, _headers = remove_permission_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts) data end
Remove download permission Remove `download` permission from users and groups @param r_b_a_c_content_guard_href [String] @param rbac_content_guard_permission [RBACContentGuardPermission] @param [Hash] opts the optional parameters @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 457 def remove_permission_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard_permission, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.remove_permission ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.remove_permission" end # verify the required parameter 'rbac_content_guard_permission' is set if @api_client.config.client_side_validation && rbac_content_guard_permission.nil? fail ArgumentError, "Missing the required parameter 'rbac_content_guard_permission' when calling ContentguardsRbacApi.remove_permission" end # resource path local_var_path = '{r_b_a_c_content_guard_href}remove_permission/'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_href.to_s).gsub('%2F', '/')) # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(rbac_content_guard_permission) # return_type return_type = opts[:return_type] || 'RBACContentGuardResponse' # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#remove_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param r_b_a_c_content_guard_href [String] @param rbac_content_guard [RBACContentGuard] @param [Hash] opts the optional parameters @return [RBACContentGuardResponse]
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 516 def update(r_b_a_c_content_guard_href, rbac_content_guard, opts = {}) data, _status_code, _headers = update_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard, opts) data end
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. @param r_b_a_c_content_guard_href [String] @param rbac_content_guard [RBACContentGuard] @param [Hash] opts the optional parameters @return [Array<(RBACContentGuardResponse
, Integer, Hash)>] RBACContentGuardResponse
data, response status code and response headers
# File lib/pulpcore_client/api/contentguards_rbac_api.rb, line 527 def update_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentguardsRbacApi.update ...' end # verify the required parameter 'r_b_a_c_content_guard_href' is set if @api_client.config.client_side_validation && r_b_a_c_content_guard_href.nil? fail ArgumentError, "Missing the required parameter 'r_b_a_c_content_guard_href' when calling ContentguardsRbacApi.update" end # verify the required parameter 'rbac_content_guard' is set if @api_client.config.client_side_validation && rbac_content_guard.nil? fail ArgumentError, "Missing the required parameter 'rbac_content_guard' when calling ContentguardsRbacApi.update" end # resource path local_var_path = '{r_b_a_c_content_guard_href}'.sub('{' + 'r_b_a_c_content_guard_href' + '}', CGI.escape(r_b_a_c_content_guard_href.to_s).gsub('%2F', '/')) # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(rbac_content_guard) # return_type return_type = opts[:return_type] || 'RBACContentGuardResponse' # 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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentguardsRbacApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end