# PulpFileClient::GroupsRolesApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**groups_roles_create**](GroupsRolesApi.md#groups_roles_create) | **POST** {group_href}roles/ | Create a group role [**groups_roles_delete**](GroupsRolesApi.md#groups_roles_delete) | **DELETE** {groups_group_role_href} | Delete a group role [**groups_roles_list**](GroupsRolesApi.md#groups_roles_list) | **GET** {group_href}roles/ | List group roles [**groups_roles_read**](GroupsRolesApi.md#groups_roles_read) | **GET** {groups_group_role_href} | Inspect a group role ## groups_roles_create > GroupRoleResponse groups_roles_create(group_href, group_role) Create a group role ViewSet for GroupRole. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::GroupsRolesApi.new group_href = 'group_href_example' # String | group_role = PulpFileClient::GroupRole.new # GroupRole | begin #Create a group role result = api_instance.groups_roles_create(group_href, group_role) p result rescue PulpFileClient::ApiError => e puts "Exception when calling GroupsRolesApi->groups_roles_create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_href** | **String**| | **group_role** | [**GroupRole**](GroupRole.md)| | ### Return type [**GroupRoleResponse**](GroupRoleResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## groups_roles_delete > groups_roles_delete(groups_group_role_href) Delete a group role ViewSet for GroupRole. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::GroupsRolesApi.new groups_group_role_href = 'groups_group_role_href_example' # String | begin #Delete a group role api_instance.groups_roles_delete(groups_group_role_href) rescue PulpFileClient::ApiError => e puts "Exception when calling GroupsRolesApi->groups_roles_delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **groups_group_role_href** | **String**| | ### Return type nil (empty response body) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## groups_roles_list > PaginatedGroupRoleResponseList groups_roles_list(group_href, opts) List group roles ViewSet for GroupRole. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::GroupsRolesApi.new group_href = 'group_href_example' # String | opts = { content_object: 'content_object_example', # String | content_object domain: 'domain_example', # String | Foreign Key referenced by HREF 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 * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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 | role: 'role_example', # String | role__contains: 'role__contains_example', # String | role__icontains: 'role__icontains_example', # String | role__in: ['role__in_example'], # Array | Multiple values may be separated by commas. role__startswith: 'role__startswith_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 group roles result = api_instance.groups_roles_list(group_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling GroupsRolesApi->groups_roles_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_href** | **String**| | **content_object** | **String**| content_object | [optional] **domain** | [**String**](.md)| Foreign Key referenced by HREF | [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 * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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] **role** | **String**| | [optional] **role__contains** | **String**| | [optional] **role__icontains** | **String**| | [optional] **role__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **role__startswith** | **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 [**PaginatedGroupRoleResponseList**](PaginatedGroupRoleResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## groups_roles_read > GroupRoleResponse groups_roles_read(groups_group_role_href, opts) Inspect a group role ViewSet for GroupRole. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::GroupsRolesApi.new groups_group_role_href = 'groups_group_role_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 group role result = api_instance.groups_roles_read(groups_group_role_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling GroupsRolesApi->groups_roles_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **groups_group_role_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 [**GroupRoleResponse**](GroupRoleResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json