rbac-api-client 1.0.0

data/docs/GroupOut.md

@@ -0,0 +1,33 @@
+# RBACApiClient::GroupOut
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**uuid** | **String** |  | 
+**created** | **DateTime** |  | 
+**modified** | **DateTime** |  | 
+**principal_count** | **Integer** |  | [optional] 
+**role_count** | **Integer** |  | [optional] 
+**system** | **Boolean** |  | [optional] [default to false]
+**platform_default** | **Boolean** |  | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::GroupOut.new(name: GroupA,
+                                 description: A description of GroupA,
+                                 uuid: 57e60f90-8c0c-4bd1-87a0-2143759aae1c,
+                                 created: 2019-01-21T17:32:28Z,
+                                 modified: 2019-03-04T07:25:58Z,
+                                 principal_count: null,
+                                 role_count: null,
+                                 system: null,
+                                 platform_default: null)
+```
+
+

data/docs/GroupPagination.md

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

data/docs/GroupPaginationAllOf.md

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

data/docs/GroupPrincipalIn.md

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

data/docs/GroupRoleIn.md

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

data/docs/GroupRolesPagination.md

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

data/docs/GroupWithPrincipals.md

@@ -0,0 +1,27 @@
+# RBACApiClient::GroupWithPrincipals
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**uuid** | **String** |  | 
+**created** | **DateTime** |  | 
+**modified** | **DateTime** |  | 
+**principals** | [**Array<Principal>**](Principal.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::GroupWithPrincipals.new(name: GroupA,
+                                 description: A description of GroupA,
+                                 uuid: 57e60f90-8c0c-4bd1-87a0-2143759aae1c,
+                                 created: 2019-01-21T17:32:28Z,
+                                 modified: 2019-03-04T07:25:58Z,
+                                 principals: null)
+```
+
+

data/docs/GroupWithPrincipalsAllOf.md

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

data/docs/GroupWithPrincipalsAndRoles.md

@@ -0,0 +1,29 @@
+# RBACApiClient::GroupWithPrincipalsAndRoles
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**uuid** | **String** |  | 
+**created** | **DateTime** |  | 
+**modified** | **DateTime** |  | 
+**principals** | [**Array<Principal>**](Principal.md) |  | 
+**roles** | [**Array<RoleOut>**](RoleOut.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::GroupWithPrincipalsAndRoles.new(name: GroupA,
+                                 description: A description of GroupA,
+                                 uuid: 57e60f90-8c0c-4bd1-87a0-2143759aae1c,
+                                 created: 2019-01-21T17:32:28Z,
+                                 modified: 2019-03-04T07:25:58Z,
+                                 principals: null,
+                                 roles: null)
+```
+
+

data/docs/GroupWithPrincipalsAndRolesAllOf.md

@@ -0,0 +1,19 @@
+# RBACApiClient::GroupWithPrincipalsAndRolesAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**principals** | [**Array<Principal>**](Principal.md) |  | 
+**roles** | [**Array<RoleOut>**](RoleOut.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::GroupWithPrincipalsAndRolesAllOf.new(principals: null,
+                                 roles: null)
+```
+
+

data/docs/InlineResponse200.md

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

data/docs/ListPagination.md

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

data/docs/PaginationLinks.md

@@ -0,0 +1,23 @@
+# RBACApiClient::PaginationLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**last** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PaginationLinks.new(first: /api/v1/(resources)/?offset=0&limit=10,
+                                 previous: /api/v1/(resources)/?offset=20&limit=10,
+                                 _next: /api/v1/(resources)/?offset=40&limit=10,
+                                 last: /api/v1/(resources)/?offset=90&limit=10)
+```
+
+

data/docs/PaginationMeta.md

@@ -0,0 +1,17 @@
+# RBACApiClient::PaginationMeta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PaginationMeta.new(count: 30)
+```
+
+

data/docs/Policy.md

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

data/docs/PolicyApi.md

@@ -0,0 +1,283 @@
+# RBACApiClient::PolicyApi
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_policies**](PolicyApi.md#create_policies) | **POST** /policies/ | Create a policy in a tenant
+[**delete_policy**](PolicyApi.md#delete_policy) | **DELETE** /policies/{uuid}/ | Delete a policy in the tenant
+[**get_policy**](PolicyApi.md#get_policy) | **GET** /policies/{uuid}/ | Get a policy in the tenant
+[**list_policies**](PolicyApi.md#list_policies) | **GET** /policies/ | List the policies in the tenant
+[**update_policy**](PolicyApi.md#update_policy) | **PUT** /policies/{uuid}/ | Update a policy in the tenant
+
+
+
+## create_policies
+
+> PolicyExtended create_policies(policy_in)
+
+Create a policy 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::PolicyApi.new
+policy_in = RBACApiClient::PolicyIn.new # PolicyIn | Policy to create
+
+begin
+  #Create a policy in a tenant
+  result = api_instance.create_policies(policy_in)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PolicyApi->create_policies: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **policy_in** | [**PolicyIn**](PolicyIn.md)| Policy to create | 
+
+### Return type
+
+[**PolicyExtended**](PolicyExtended.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_policy
+
+> delete_policy(uuid)
+
+Delete a policy 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::PolicyApi.new
+uuid = 'uuid_example' # String | ID of policy to delete
+
+begin
+  #Delete a policy in the tenant
+  api_instance.delete_policy(uuid)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PolicyApi->delete_policy: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of policy 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
+
+
+## get_policy
+
+> PolicyExtended get_policy(uuid)
+
+Get a policy 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::PolicyApi.new
+uuid = 'uuid_example' # String | ID of policy to get
+
+begin
+  #Get a policy in the tenant
+  result = api_instance.get_policy(uuid)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PolicyApi->get_policy: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of policy to get | 
+
+### Return type
+
+[**PolicyExtended**](PolicyExtended.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_policies
+
+> PolicyPagination list_policies(opts)
+
+List the policies 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::PolicyApi.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.
+  group_name: 'group_name_example', # String | Parameter for filtering resource by group name using string contains search.
+  group_uuid: 'group_uuid_example', # String | Parameter for filtering resource by group uuid using UUID exact match.
+  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 policies in the tenant
+  result = api_instance.list_policies(opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PolicyApi->list_policies: #{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 'account']
+ **group_name** | **String**| Parameter for filtering resource by group name using string contains search. | [optional] 
+ **group_uuid** | [**String**](.md)| Parameter for filtering resource by group uuid using UUID exact match. | [optional] 
+ **order_by** | **String**| Parameter for ordering resource by value. For inverse ordering, supply '-' before the param value, such as: ?order_by=-name | [optional] 
+
+### Return type
+
+[**PolicyPagination**](PolicyPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_policy
+
+> PolicyExtended update_policy(uuid, policy_in)
+
+Update a policy 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::PolicyApi.new
+uuid = 'uuid_example' # String | ID of policy to update
+policy_in = RBACApiClient::PolicyIn.new # PolicyIn | Policy to update
+
+begin
+  #Update a policy in the tenant
+  result = api_instance.update_policy(uuid, policy_in)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PolicyApi->update_policy: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of policy to update | 
+ **policy_in** | [**PolicyIn**](PolicyIn.md)| Policy to update | 
+
+### Return type
+
+[**PolicyExtended**](PolicyExtended.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+