# PulpcoreClient::GroupsObjectPermissionsApi

All URIs are relative to *http://pulp*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](GroupsObjectPermissionsApi.md#create) | **POST** {auth_auth_groups_permission_href}object_permissions/ | Create a permission
[**delete**](GroupsObjectPermissionsApi.md#delete) | **DELETE** {auth_auth_groups_permission_href} | Delete a permission
[**list**](GroupsObjectPermissionsApi.md#list) | **GET** {auth_group_href}object_permissions/ | List permissions
[**read**](GroupsObjectPermissionsApi.md#read) | **GET** {auth_auth_groups_permission_href} | Inspect a permission



## create

> PermissionResponse create(auth_auth_groups_permission_href, body)

Create a permission

Add an object permission to a group.

### 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::GroupsObjectPermissionsApi.new
auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 
body = nil # Object | 

begin
  #Create a permission
  result = api_instance.create(auth_auth_groups_permission_href, body)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling GroupsObjectPermissionsApi->create: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **auth_auth_groups_permission_href** | **String**|  | 
 **body** | **Object**|  | 

### Return type

[**PermissionResponse**](PermissionResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json


## delete

> delete(auth_auth_groups_permission_href)

Delete a permission

Remove an object permission from a group.

### 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::GroupsObjectPermissionsApi.new
auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 

begin
  #Delete a permission
  api_instance.delete(auth_auth_groups_permission_href)
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling GroupsObjectPermissionsApi->delete: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **auth_auth_groups_permission_href** | **String**|  | 

### Return type

nil (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


## list

> InlineResponse2005 list(auth_group_href, opts)

List permissions

List group object permissions.

### 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::GroupsObjectPermissionsApi.new
auth_group_href = 'auth_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.
  ordering: 'ordering_example', # String | Which field to use when ordering the results.
  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
  #List permissions
  result = api_instance.list(auth_group_href, opts)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling GroupsObjectPermissionsApi->list: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **auth_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] 
 **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

[**InlineResponse2005**](InlineResponse2005.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## read

> PermissionResponse read(auth_auth_groups_permission_href, opts)

Inspect a permission

Retrieve a model permission from a group.

### 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::GroupsObjectPermissionsApi.new
auth_auth_groups_permission_href = 'auth_auth_groups_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.
}

begin
  #Inspect a permission
  result = api_instance.read(auth_auth_groups_permission_href, opts)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling GroupsObjectPermissionsApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **auth_auth_groups_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] 

### Return type

[**PermissionResponse**](PermissionResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json