# PulpcoreClient::AccessPoliciesApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**list**](AccessPoliciesApi.md#list) | **GET** /pulp/api/v3/access_policies/ | List access policys [**partial_update**](AccessPoliciesApi.md#partial_update) | **PATCH** {access_policy_href} | Update an access policy [**read**](AccessPoliciesApi.md#read) | **GET** {access_policy_href} | Inspect an access policy [**reset**](AccessPoliciesApi.md#reset) | **POST** {access_policy_href}reset/ | [**update**](AccessPoliciesApi.md#update) | **PUT** {access_policy_href} | Update an access policy ## list > PaginatedAccessPolicyResponseList list(opts) List access policys ViewSet for AccessPolicy. ### 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::AccessPoliciesApi.new opts = { customized: true, # Boolean | Filter results where customized matches value 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 | 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) * `creation_hooks` - Creation hooks * `-creation_hooks` - Creation hooks (descending) * `statements` - Statements * `-statements` - Statements (descending) * `viewset_name` - Viewset name * `-viewset_name` - Viewset name (descending) * `customized` - Customized * `-customized` - Customized (descending) * `queryset_scoping` - Queryset scoping * `-queryset_scoping` - Queryset scoping (descending) * `pk` - Pk * `-pk` - Pk (descending) prn__in: ['prn__in_example'], # Array | Multiple values may be separated by commas. 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 | Filter results by using NOT, AND and OR operations on other filters viewset_name: 'viewset_name_example', # String | Filter results where viewset_name matches value viewset_name__contains: 'viewset_name__contains_example', # String | Filter results where viewset_name contains value viewset_name__icontains: 'viewset_name__icontains_example', # String | Filter results where viewset_name contains value viewset_name__iexact: 'viewset_name__iexact_example', # String | Filter results where viewset_name matches value viewset_name__in: ['viewset_name__in_example'], # Array | Filter results where viewset_name is in a comma-separated list of values viewset_name__iregex: 'viewset_name__iregex_example', # String | Filter results where viewset_name matches regex value viewset_name__istartswith: 'viewset_name__istartswith_example', # String | Filter results where viewset_name starts with value viewset_name__regex: 'viewset_name__regex_example', # String | Filter results where viewset_name matches regex value viewset_name__startswith: 'viewset_name__startswith_example', # String | Filter results where viewset_name starts with value 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 access policys result = api_instance.list(opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling AccessPoliciesApi->list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **customized** | **Boolean**| Filter results where customized matches value | [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<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) * `creation_hooks` - Creation hooks * `-creation_hooks` - Creation hooks (descending) * `statements` - Statements * `-statements` - Statements (descending) * `viewset_name` - Viewset name * `-viewset_name` - Viewset name (descending) * `customized` - Customized * `-customized` - Customized (descending) * `queryset_scoping` - Queryset scoping * `-queryset_scoping` - Queryset scoping (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] **prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [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**| Filter results by using NOT, AND and OR operations on other filters | [optional] **viewset_name** | **String**| Filter results where viewset_name matches value | [optional] **viewset_name__contains** | **String**| Filter results where viewset_name contains value | [optional] **viewset_name__icontains** | **String**| Filter results where viewset_name contains value | [optional] **viewset_name__iexact** | **String**| Filter results where viewset_name matches value | [optional] **viewset_name__in** | [**Array<String>**](String.md)| Filter results where viewset_name is in a comma-separated list of values | [optional] **viewset_name__iregex** | **String**| Filter results where viewset_name matches regex value | [optional] **viewset_name__istartswith** | **String**| Filter results where viewset_name starts with value | [optional] **viewset_name__regex** | **String**| Filter results where viewset_name matches regex value | [optional] **viewset_name__startswith** | **String**| Filter results where viewset_name starts with value | [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 [**PaginatedAccessPolicyResponseList**](PaginatedAccessPolicyResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## partial_update > AccessPolicyResponse partial_update(access_policy_href, patched_access_policy) Update an access policy ViewSet for AccessPolicy. ### 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::AccessPoliciesApi.new access_policy_href = 'access_policy_href_example' # String | patched_access_policy = PulpcoreClient::PatchedAccessPolicy.new # PatchedAccessPolicy | begin #Update an access policy result = api_instance.partial_update(access_policy_href, patched_access_policy) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling AccessPoliciesApi->partial_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **access_policy_href** | **String**| | **patched_access_policy** | [**PatchedAccessPolicy**](PatchedAccessPolicy.md)| | ### Return type [**AccessPolicyResponse**](AccessPolicyResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## read > AccessPolicyResponse read(access_policy_href, opts) Inspect an access policy ViewSet for AccessPolicy. ### 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::AccessPoliciesApi.new access_policy_href = 'access_policy_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 an access policy result = api_instance.read(access_policy_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling AccessPoliciesApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **access_policy_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 [**AccessPolicyResponse**](AccessPolicyResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## reset > AccessPolicyResponse reset(access_policy_href) Reset the access policy to its uncustomized default value. ### 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::AccessPoliciesApi.new access_policy_href = 'access_policy_href_example' # String | begin result = api_instance.reset(access_policy_href) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling AccessPoliciesApi->reset: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **access_policy_href** | **String**| | ### Return type [**AccessPolicyResponse**](AccessPolicyResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## update > AccessPolicyResponse update(access_policy_href, access_policy) Update an access policy ViewSet for AccessPolicy. ### 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::AccessPoliciesApi.new access_policy_href = 'access_policy_href_example' # String | access_policy = PulpcoreClient::AccessPolicy.new # AccessPolicy | begin #Update an access policy result = api_instance.update(access_policy_href, access_policy) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling AccessPoliciesApi->update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **access_policy_href** | **String**| | **access_policy** | [**AccessPolicy**](AccessPolicy.md)| | ### Return type [**AccessPolicyResponse**](AccessPolicyResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json