rbac-api-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15d1492709f5f1f1dff58bf1fb5eacc0ebbc14dbfa269cd2862c016d29cc7259
+  data.tar.gz: 279ddf83e9e936a57854cf0ad11baea36f603e35b5000f8e17b73528b82fb78e
+SHA512:
+  metadata.gz: 8388373a5735bb9b147187422394b4b6f6c15c8ae2cdb3281f7adaea8f56178b84c6d43e3e7d598d0f1a497ee6470d362536d7cf2c8f2f6535042d64f3e4255d
+  data.tar.gz: 79ff421b9118de670a49e399fe307c68861d2074d588c0225ae504aadd927d89774338f84332b98ce3477c8add5a31d2dfa40e7bedbaf3afa06012f25a09a995

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,175 @@
+# rbac-api-client
+
+RBACApiClient - the Ruby gem for the Role Based Access Control
+
+The API for Role Based Access Control.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build rbac-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./rbac-api-client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./rbac-api-client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'rbac-api-client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'rbac-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'rbac-api-client'
+
+# Setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+end
+
+api_instance = RBACApiClient::AccessApi.new
+application = 'application_example' # String | The application name to obtain access for the principal
+opts = {
+  username: 'username_example', # String | Unique username of the principal to obtain access for (only available for admins, and if supplied, takes precedence over the identity header).
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0 # Integer | Parameter for selecting the offset of data.
+}
+
+begin
+  #Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
+  result = api_instance.get_principal_access(application, opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling AccessApi->get_principal_access: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*RBACApiClient::AccessApi* | [**get_principal_access**](docs/AccessApi.md#get_principal_access) | **GET** /access/ | Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
+*RBACApiClient::GroupApi* | [**add_principal_to_group**](docs/GroupApi.md#add_principal_to_group) | **POST** /groups/{uuid}/principals/ | Add a principal to a group in the tenant
+*RBACApiClient::GroupApi* | [**add_role_to_group**](docs/GroupApi.md#add_role_to_group) | **POST** /groups/{uuid}/roles/ | Add a role to a group in the tenant
+*RBACApiClient::GroupApi* | [**create_group**](docs/GroupApi.md#create_group) | **POST** /groups/ | Create a group in a tenant
+*RBACApiClient::GroupApi* | [**delete_group**](docs/GroupApi.md#delete_group) | **DELETE** /groups/{uuid}/ | Delete a group in the tenant
+*RBACApiClient::GroupApi* | [**delete_principal_from_group**](docs/GroupApi.md#delete_principal_from_group) | **DELETE** /groups/{uuid}/principals/ | Remove a principal from a group in the tenant
+*RBACApiClient::GroupApi* | [**delete_role_from_group**](docs/GroupApi.md#delete_role_from_group) | **DELETE** /groups/{uuid}/roles/ | Remove a role from a group in the tenant
+*RBACApiClient::GroupApi* | [**get_group**](docs/GroupApi.md#get_group) | **GET** /groups/{uuid}/ | Get a group in the tenant
+*RBACApiClient::GroupApi* | [**get_principals_from_group**](docs/GroupApi.md#get_principals_from_group) | **GET** /groups/{uuid}/principals/ | Get a list of principals from a group in the tenant
+*RBACApiClient::GroupApi* | [**list_groups**](docs/GroupApi.md#list_groups) | **GET** /groups/ | List the groups for a tenant
+*RBACApiClient::GroupApi* | [**list_roles_for_group**](docs/GroupApi.md#list_roles_for_group) | **GET** /groups/{uuid}/roles/ | List the roles for a group in the tenant
+*RBACApiClient::GroupApi* | [**update_group**](docs/GroupApi.md#update_group) | **PUT** /groups/{uuid}/ | Udate a group in the tenant
+*RBACApiClient::PolicyApi* | [**create_policies**](docs/PolicyApi.md#create_policies) | **POST** /policies/ | Create a policy in a tenant
+*RBACApiClient::PolicyApi* | [**delete_policy**](docs/PolicyApi.md#delete_policy) | **DELETE** /policies/{uuid}/ | Delete a policy in the tenant
+*RBACApiClient::PolicyApi* | [**get_policy**](docs/PolicyApi.md#get_policy) | **GET** /policies/{uuid}/ | Get a policy in the tenant
+*RBACApiClient::PolicyApi* | [**list_policies**](docs/PolicyApi.md#list_policies) | **GET** /policies/ | List the policies in the tenant
+*RBACApiClient::PolicyApi* | [**update_policy**](docs/PolicyApi.md#update_policy) | **PUT** /policies/{uuid}/ | Update a policy in the tenant
+*RBACApiClient::PrincipalApi* | [**list_principals**](docs/PrincipalApi.md#list_principals) | **GET** /principals/ | List the principals for a tenant
+*RBACApiClient::RoleApi* | [**create_roles**](docs/RoleApi.md#create_roles) | **POST** /roles/ | Create a roles for a tenant
+*RBACApiClient::RoleApi* | [**delete_role**](docs/RoleApi.md#delete_role) | **DELETE** /roles/{uuid}/ | Delete a role in the tenant
+*RBACApiClient::RoleApi* | [**get_role**](docs/RoleApi.md#get_role) | **GET** /roles/{uuid}/ | Get a role in the tenant
+*RBACApiClient::RoleApi* | [**get_role_access**](docs/RoleApi.md#get_role_access) | **GET** /roles/{uuid}/access/ | Get access for a role in the tenant
+*RBACApiClient::RoleApi* | [**list_roles**](docs/RoleApi.md#list_roles) | **GET** /roles/ | List the roles for a tenant
+*RBACApiClient::RoleApi* | [**update_role**](docs/RoleApi.md#update_role) | **PUT** /roles/{uuid}/ | Update a Role in the tenant
+*RBACApiClient::StatusApi* | [**get_status**](docs/StatusApi.md#get_status) | **GET** /status/ | Obtain server status
+
+
+## Documentation for Models
+
+ - [RBACApiClient::Access](docs/Access.md)
+ - [RBACApiClient::AccessPagination](docs/AccessPagination.md)
+ - [RBACApiClient::AccessPaginationAllOf](docs/AccessPaginationAllOf.md)
+ - [RBACApiClient::AdditionalGroup](docs/AdditionalGroup.md)
+ - [RBACApiClient::Error](docs/Error.md)
+ - [RBACApiClient::Error403](docs/Error403.md)
+ - [RBACApiClient::Group](docs/Group.md)
+ - [RBACApiClient::GroupOut](docs/GroupOut.md)
+ - [RBACApiClient::GroupPagination](docs/GroupPagination.md)
+ - [RBACApiClient::GroupPaginationAllOf](docs/GroupPaginationAllOf.md)
+ - [RBACApiClient::GroupPrincipalIn](docs/GroupPrincipalIn.md)
+ - [RBACApiClient::GroupRoleIn](docs/GroupRoleIn.md)
+ - [RBACApiClient::GroupRolesPagination](docs/GroupRolesPagination.md)
+ - [RBACApiClient::GroupWithPrincipals](docs/GroupWithPrincipals.md)
+ - [RBACApiClient::GroupWithPrincipalsAllOf](docs/GroupWithPrincipalsAllOf.md)
+ - [RBACApiClient::GroupWithPrincipalsAndRoles](docs/GroupWithPrincipalsAndRoles.md)
+ - [RBACApiClient::GroupWithPrincipalsAndRolesAllOf](docs/GroupWithPrincipalsAndRolesAllOf.md)
+ - [RBACApiClient::InlineResponse200](docs/InlineResponse200.md)
+ - [RBACApiClient::ListPagination](docs/ListPagination.md)
+ - [RBACApiClient::PaginationLinks](docs/PaginationLinks.md)
+ - [RBACApiClient::PaginationMeta](docs/PaginationMeta.md)
+ - [RBACApiClient::Policy](docs/Policy.md)
+ - [RBACApiClient::PolicyExtended](docs/PolicyExtended.md)
+ - [RBACApiClient::PolicyExtendedAllOf](docs/PolicyExtendedAllOf.md)
+ - [RBACApiClient::PolicyIn](docs/PolicyIn.md)
+ - [RBACApiClient::PolicyInAllOf](docs/PolicyInAllOf.md)
+ - [RBACApiClient::PolicyPagination](docs/PolicyPagination.md)
+ - [RBACApiClient::PolicyPaginationAllOf](docs/PolicyPaginationAllOf.md)
+ - [RBACApiClient::Principal](docs/Principal.md)
+ - [RBACApiClient::PrincipalIn](docs/PrincipalIn.md)
+ - [RBACApiClient::PrincipalOut](docs/PrincipalOut.md)
+ - [RBACApiClient::PrincipalPagination](docs/PrincipalPagination.md)
+ - [RBACApiClient::PrincipalPaginationAllOf](docs/PrincipalPaginationAllOf.md)
+ - [RBACApiClient::ResourceDefinition](docs/ResourceDefinition.md)
+ - [RBACApiClient::ResourceDefinitionFilter](docs/ResourceDefinitionFilter.md)
+ - [RBACApiClient::Role](docs/Role.md)
+ - [RBACApiClient::RoleIn](docs/RoleIn.md)
+ - [RBACApiClient::RoleInAllOf](docs/RoleInAllOf.md)
+ - [RBACApiClient::RoleOut](docs/RoleOut.md)
+ - [RBACApiClient::RoleOutDynamic](docs/RoleOutDynamic.md)
+ - [RBACApiClient::RoleOutDynamicAllOf](docs/RoleOutDynamicAllOf.md)
+ - [RBACApiClient::RolePagination](docs/RolePagination.md)
+ - [RBACApiClient::RolePaginationDynamic](docs/RolePaginationDynamic.md)
+ - [RBACApiClient::RolePaginationDynamicAllOf](docs/RolePaginationDynamicAllOf.md)
+ - [RBACApiClient::RoleWithAccess](docs/RoleWithAccess.md)
+ - [RBACApiClient::Status](docs/Status.md)
+ - [RBACApiClient::Timestamped](docs/Timestamped.md)
+ - [RBACApiClient::UUID](docs/UUID.md)
+
+
+## Documentation for Authorization
+
+
+### basic_auth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/client-meta.json

@@ -0,0 +1,8 @@
+{
+	"moduleName": "RBACApiClient",
+	"gemName": "rbac-api-client",
+	"gemHomepage" : "https://github.com/ManageIQ/insights-rbac-api-client-ruby",
+	"gemAuthor" : "ManageIQ Authors",
+	"gemLicense" : "Apache-2.0",
+	"gemDescription" : "Ruby client gem to connect to Insights RBAC Service"
+}

data/docs/Access.md

@@ -0,0 +1,19 @@
+# RBACApiClient::Access
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission** | **String** |  | 
+**resource_definitions** | [**Array<ResourceDefinition>**](ResourceDefinition.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::Access.new(permission: cost-management:*:read,
+                                 resource_definitions: null)
+```
+
+

data/docs/AccessApi.md

@@ -0,0 +1,68 @@
+# RBACApiClient::AccessApi
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_principal_access**](AccessApi.md#get_principal_access) | **GET** /access/ | Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
+
+
+
+## get_principal_access
+
+> AccessPagination get_principal_access(application, opts)
+
+Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::AccessApi.new
+application = 'application_example' # String | The application name to obtain access for the principal
+opts = {
+  username: 'username_example', # String | Unique username of the principal to obtain access for (only available for admins, and if supplied, takes precedence over the identity header).
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0 # Integer | Parameter for selecting the offset of data.
+}
+
+begin
+  #Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
+  result = api_instance.get_principal_access(application, opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling AccessApi->get_principal_access: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **application** | **String**| The application name to obtain access for the principal | 
+ **username** | **String**| Unique username of the principal to obtain access for (only available for admins, and if supplied, takes precedence over the identity header). | [optional] 
+ **limit** | **Integer**| Parameter for selecting the amount of data returned. | [optional] [default to 10]
+ **offset** | **Integer**| Parameter for selecting the offset of data. | [optional] [default to 0]
+
+### Return type
+
+[**AccessPagination**](AccessPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccessPagination.md

@@ -0,0 +1,21 @@
+# RBACApiClient::AccessPagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+**links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] 
+**data** | [**Array<Access>**](Access.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::AccessPagination.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/AccessPaginationAllOf.md

@@ -0,0 +1,17 @@
+# RBACApiClient::AccessPaginationAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<Access>**](Access.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::AccessPaginationAllOf.new(data: null)
+```
+
+

data/docs/AdditionalGroup.md

@@ -0,0 +1,19 @@
+# RBACApiClient::AdditionalGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**uuid** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::AdditionalGroup.new(name: GroupA,
+                                 uuid: 234df936-abb4-4238-a1c9-d91fc540c702)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,17 @@
+# RBACApiClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | **Array<Object>** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::Error.new(errors: null)
+```
+
+

data/docs/Error403.md

@@ -0,0 +1,17 @@
+# RBACApiClient::Error403
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | **Array<Object>** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::Error403.new(errors: null)
+```
+
+

data/docs/Group.md

@@ -0,0 +1,19 @@
+# RBACApiClient::Group
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::Group.new(name: GroupA,
+                                 description: A description of GroupA)
+```
+
+

data/docs/GroupApi.md

@@ -0,0 +1,623 @@
+# RBACApiClient::GroupApi
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_principal_to_group**](GroupApi.md#add_principal_to_group) | **POST** /groups/{uuid}/principals/ | Add a principal to a group in the tenant
+[**add_role_to_group**](GroupApi.md#add_role_to_group) | **POST** /groups/{uuid}/roles/ | Add a role to a group in the tenant
+[**create_group**](GroupApi.md#create_group) | **POST** /groups/ | Create a group in a tenant
+[**delete_group**](GroupApi.md#delete_group) | **DELETE** /groups/{uuid}/ | Delete a group in the tenant
+[**delete_principal_from_group**](GroupApi.md#delete_principal_from_group) | **DELETE** /groups/{uuid}/principals/ | Remove a principal from a group in the tenant
+[**delete_role_from_group**](GroupApi.md#delete_role_from_group) | **DELETE** /groups/{uuid}/roles/ | Remove a role from a group in the tenant
+[**get_group**](GroupApi.md#get_group) | **GET** /groups/{uuid}/ | Get a group in the tenant
+[**get_principals_from_group**](GroupApi.md#get_principals_from_group) | **GET** /groups/{uuid}/principals/ | Get a list of principals from a group in the tenant
+[**list_groups**](GroupApi.md#list_groups) | **GET** /groups/ | List the groups for a tenant
+[**list_roles_for_group**](GroupApi.md#list_roles_for_group) | **GET** /groups/{uuid}/roles/ | List the roles for a group in the tenant
+[**update_group**](GroupApi.md#update_group) | **PUT** /groups/{uuid}/ | Udate a group in the tenant
+
+
+
+## add_principal_to_group
+
+> GroupWithPrincipalsAndRoles add_principal_to_group(uuid, group_principal_in)
+
+Add a principal to a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to update
+group_principal_in = RBACApiClient::GroupPrincipalIn.new # GroupPrincipalIn | Principal to add to a group
+
+begin
+  #Add a principal to a group in the tenant
+  result = api_instance.add_principal_to_group(uuid, group_principal_in)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->add_principal_to_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to update | 
+ **group_principal_in** | [**GroupPrincipalIn**](GroupPrincipalIn.md)| Principal to add to a group | 
+
+### Return type
+
+[**GroupWithPrincipalsAndRoles**](GroupWithPrincipalsAndRoles.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## add_role_to_group
+
+> InlineResponse200 add_role_to_group(uuid, group_role_in)
+
+Add a role to a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to update
+group_role_in = RBACApiClient::GroupRoleIn.new # GroupRoleIn | Role to add to a group
+
+begin
+  #Add a role to a group in the tenant
+  result = api_instance.add_role_to_group(uuid, group_role_in)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->add_role_to_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to update | 
+ **group_role_in** | [**GroupRoleIn**](GroupRoleIn.md)| Role to add to a group | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_group
+
+> GroupOut create_group(group)
+
+Create a group in a tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+group = RBACApiClient::Group.new # Group | Group to create in tenant
+
+begin
+  #Create a group in a tenant
+  result = api_instance.create_group(group)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->create_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group** | [**Group**](Group.md)| Group to create in tenant | 
+
+### Return type
+
+[**GroupOut**](GroupOut.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_group
+
+> delete_group(uuid)
+
+Delete a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to delete
+
+begin
+  #Delete a group in the tenant
+  api_instance.delete_group(uuid)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->delete_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to delete | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, */*
+
+
+## delete_principal_from_group
+
+> delete_principal_from_group(uuid, usernames)
+
+Remove a principal from a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to update
+usernames = 'usernames_example' # String | A comma separated list of usernames for principals to remove from the group
+
+begin
+  #Remove a principal from a group in the tenant
+  api_instance.delete_principal_from_group(uuid, usernames)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->delete_principal_from_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to update | 
+ **usernames** | **String**| A comma separated list of usernames for principals to remove from the group | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_role_from_group
+
+> delete_role_from_group(uuid, roles)
+
+Remove a role from a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to update
+roles = 'roles_example' # String | A comma separated list of role UUIDs for roles to remove from the group
+
+begin
+  #Remove a role from a group in the tenant
+  api_instance.delete_role_from_group(uuid, roles)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->delete_role_from_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to update | 
+ **roles** | **String**| A comma separated list of role UUIDs for roles to remove from the group | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_group
+
+> GroupWithPrincipalsAndRoles get_group(uuid)
+
+Get a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to get
+
+begin
+  #Get a group in the tenant
+  result = api_instance.get_group(uuid)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->get_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to get | 
+
+### Return type
+
+[**GroupWithPrincipalsAndRoles**](GroupWithPrincipalsAndRoles.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_principals_from_group
+
+> PrincipalPagination get_principals_from_group(uuid, opts)
+
+Get a list of principals from a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group from which to get principals
+opts = {
+  principal_username: 'principal_username_example' # String | Parameter for filtering group principals by principal `username` using string contains search.
+}
+
+begin
+  #Get a list of principals from a group in the tenant
+  result = api_instance.get_principals_from_group(uuid, opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->get_principals_from_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group from which to get principals | 
+ **principal_username** | **String**| Parameter for filtering group principals by principal `username` using string contains search. | [optional] 
+
+### Return type
+
+[**PrincipalPagination**](PrincipalPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_groups
+
+> GroupPagination list_groups(opts)
+
+List the groups for a tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+opts = {
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0, # Integer | Parameter for selecting the offset of data.
+  name: 'name_example', # String | Parameter for filtering resource by name using string contains search.
+  scope: 'account', # String | Parameter for filtering resource by scope.
+  username: 'username_example', # String | A username for a principal to filter for groups
+  uuid: ['uuid_example'], # Array<String> | A list of UUIDs to filter listed groups.
+  role_names: ['role_names_example'], # Array<String> | List of role name to filter for groups. It is exact match but case-insensitive
+  role_discriminator: 'role_discriminator_example', # String | Discriminator that works with role_names to indicate matching all/any of the role names
+  order_by: 'order_by_example' # String | Parameter for ordering resource by value. For inverse ordering, supply '-' before the param value, such as: ?order_by=-name
+}
+
+begin
+  #List the groups for a tenant
+  result = api_instance.list_groups(opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->list_groups: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Parameter for selecting the amount of data returned. | [optional] [default to 10]
+ **offset** | **Integer**| Parameter for selecting the offset of data. | [optional] [default to 0]
+ **name** | **String**| Parameter for filtering resource by name using string contains search. | [optional] 
+ **scope** | **String**| Parameter for filtering resource by scope. | [optional] [default to &#39;account&#39;]
+ **username** | **String**| A username for a principal to filter for groups | [optional] 
+ **uuid** | [**Array&lt;String&gt;**](String.md)| A list of UUIDs to filter listed groups. | [optional] 
+ **role_names** | [**Array&lt;String&gt;**](String.md)| List of role name to filter for groups. It is exact match but case-insensitive | [optional] 
+ **role_discriminator** | **String**| Discriminator that works with role_names to indicate matching all/any of the role names | [optional] 
+ **order_by** | **String**| Parameter for ordering resource by value. For inverse ordering, supply &#39;-&#39; before the param value, such as: ?order_by&#x3D;-name | [optional] 
+
+### Return type
+
+[**GroupPagination**](GroupPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_roles_for_group
+
+> GroupRolesPagination list_roles_for_group(uuid, opts)
+
+List the roles for a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group
+opts = {
+  exclude: false, # Boolean | If this is set to true, the result would be roles excluding the ones in the group
+  role_name: 'role_name_example', # String | Parameter for filtering group roles by role `name` using string contains search.
+  role_description: 'role_description_example', # String | Parameter for filtering group roles by role `description` using string contains search.
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0, # Integer | Parameter for selecting the offset of data.
+  order_by: 'order_by_example' # String | Parameter for ordering resource by value. For inverse ordering, supply '-' before the param value, such as: ?order_by=-name
+}
+
+begin
+  #List the roles for a group in the tenant
+  result = api_instance.list_roles_for_group(uuid, opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->list_roles_for_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group | 
+ **exclude** | **Boolean**| If this is set to true, the result would be roles excluding the ones in the group | [optional] [default to false]
+ **role_name** | **String**| Parameter for filtering group roles by role &#x60;name&#x60; using string contains search. | [optional] 
+ **role_description** | **String**| Parameter for filtering group roles by role &#x60;description&#x60; using string contains search. | [optional] 
+ **limit** | **Integer**| Parameter for selecting the amount of data returned. | [optional] [default to 10]
+ **offset** | **Integer**| Parameter for selecting the offset of data. | [optional] [default to 0]
+ **order_by** | **String**| Parameter for ordering resource by value. For inverse ordering, supply &#39;-&#39; before the param value, such as: ?order_by&#x3D;-name | [optional] 
+
+### Return type
+
+[**GroupRolesPagination**](GroupRolesPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_group
+
+> GroupOut update_group(uuid, group)
+
+Udate a group in the tenant
+
+### Example
+
+```ruby
+# load the gem
+require 'rbac-api-client'
+# setup authorization
+RBACApiClient.configure do |config|
+  # Configure HTTP basic authorization: basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = RBACApiClient::GroupApi.new
+uuid = 'uuid_example' # String | ID of group to update
+group = RBACApiClient::Group.new # Group | Group to update in tenant
+
+begin
+  #Udate a group in the tenant
+  result = api_instance.update_group(uuid, group)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling GroupApi->update_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of group to update | 
+ **group** | [**Group**](Group.md)| Group to update in tenant | 
+
+### Return type
+
+[**GroupOut**](GroupOut.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, */*
+