rbac-api-client 1.0.0

data/docs/PolicyExtended.md

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

data/docs/PolicyExtendedAllOf.md

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

data/docs/PolicyIn.md

@@ -0,0 +1,23 @@
+# RBACApiClient::PolicyIn
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**group** | **String** |  | 
+**roles** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PolicyIn.new(name: PolicyA,
+                                 description: A description of PolicyA,
+                                 group: 83ee048e-3c1d-43ef-b945-108225ae52f4,
+                                 roles: null)
+```
+
+

data/docs/PolicyInAllOf.md

@@ -0,0 +1,19 @@
+# RBACApiClient::PolicyInAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **String** |  | 
+**roles** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PolicyInAllOf.new(group: 83ee048e-3c1d-43ef-b945-108225ae52f4,
+                                 roles: null)
+```
+
+

data/docs/PolicyPagination.md

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

data/docs/PolicyPaginationAllOf.md

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

data/docs/Principal.md

@@ -0,0 +1,25 @@
+# RBACApiClient::Principal
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | 
+**email** | **String** |  | 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**is_active** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::Principal.new(username: smithj,
+                                 email: smithj@mytechco.com,
+                                 first_name: John,
+                                 last_name: Smith,
+                                 is_active: null)
+```
+
+

data/docs/PrincipalApi.md

@@ -0,0 +1,68 @@
+# RBACApiClient::PrincipalApi
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_principals**](PrincipalApi.md#list_principals) | **GET** /principals/ | List the principals for a tenant
+
+
+
+## list_principals
+
+> PrincipalPagination list_principals(opts)
+
+List the principals 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::PrincipalApi.new
+opts = {
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0, # Integer | Parameter for selecting the offset of data.
+  usernames: 'usernames_example', # String | Usernames of principals to get
+  sort_order: 'sort_order_example' # String | The sort order of the query, either ascending or descending
+}
+
+begin
+  #List the principals for a tenant
+  result = api_instance.list_principals(opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling PrincipalApi->list_principals: #{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]
+ **usernames** | **String**| Usernames of principals to get | [optional] 
+ **sort_order** | **String**| The sort order of the query, either ascending or descending | [optional] 
+
+### Return type
+
+[**PrincipalPagination**](PrincipalPagination.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PrincipalIn.md

@@ -0,0 +1,17 @@
+# RBACApiClient::PrincipalIn
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PrincipalIn.new(username: smithj)
+```
+
+

data/docs/PrincipalOut.md

@@ -0,0 +1,27 @@
+# RBACApiClient::PrincipalOut
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | 
+**email** | **String** |  | 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**is_active** | **Boolean** |  | [optional] 
+**uuid** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::PrincipalOut.new(username: smithj,
+                                 email: smithj@mytechco.com,
+                                 first_name: John,
+                                 last_name: Smith,
+                                 is_active: null,
+                                 uuid: 57e60f90-8c0c-4bd1-87a0-2143759aae1c)
+```
+
+

data/docs/PrincipalPagination.md

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

data/docs/PrincipalPaginationAllOf.md

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

data/docs/ResourceDefinition.md

@@ -0,0 +1,17 @@
+# RBACApiClient::ResourceDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_filter** | [**ResourceDefinitionFilter**](ResourceDefinitionFilter.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::ResourceDefinition.new(attribute_filter: null)
+```
+
+

data/docs/ResourceDefinitionFilter.md

@@ -0,0 +1,21 @@
+# RBACApiClient::ResourceDefinitionFilter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | 
+**operation** | **String** |  | 
+**value** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'RBACApiClient'
+
+instance = RBACApiClient::ResourceDefinitionFilter.new(key: cost-management.aws.account,
+                                 operation: null,
+                                 value: 123456)
+```
+
+

data/docs/Role.md

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

data/docs/RoleApi.md

@@ -0,0 +1,340 @@
+# RBACApiClient::RoleApi
+
+All URIs are relative to *http://localhost/api/rbac/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_roles**](RoleApi.md#create_roles) | **POST** /roles/ | Create a roles for a tenant
+[**delete_role**](RoleApi.md#delete_role) | **DELETE** /roles/{uuid}/ | Delete a role in the tenant
+[**get_role**](RoleApi.md#get_role) | **GET** /roles/{uuid}/ | Get a role in the tenant
+[**get_role_access**](RoleApi.md#get_role_access) | **GET** /roles/{uuid}/access/ | Get access for a role in the tenant
+[**list_roles**](RoleApi.md#list_roles) | **GET** /roles/ | List the roles for a tenant
+[**update_role**](RoleApi.md#update_role) | **PUT** /roles/{uuid}/ | Update a Role in the tenant
+
+
+
+## create_roles
+
+> RoleWithAccess create_roles(role_in)
+
+Create a roles 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::RoleApi.new
+role_in = RBACApiClient::RoleIn.new # RoleIn | Role to create
+
+begin
+  #Create a roles for a tenant
+  result = api_instance.create_roles(role_in)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->create_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_in** | [**RoleIn**](RoleIn.md)| Role to create | 
+
+### Return type
+
+[**RoleWithAccess**](RoleWithAccess.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_role
+
+> delete_role(uuid)
+
+Delete a role 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::RoleApi.new
+uuid = 'uuid_example' # String | ID of role to delete
+
+begin
+  #Delete a role in the tenant
+  api_instance.delete_role(uuid)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->delete_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of role 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_role
+
+> RoleWithAccess get_role(uuid)
+
+Get a role 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::RoleApi.new
+uuid = 'uuid_example' # String | ID of role to get
+
+begin
+  #Get a role in the tenant
+  result = api_instance.get_role(uuid)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->get_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of role to get | 
+
+### Return type
+
+[**RoleWithAccess**](RoleWithAccess.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_role_access
+
+> AccessPagination get_role_access(uuid, opts)
+
+Get access for a role 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::RoleApi.new
+uuid = 'uuid_example' # String | ID of the role
+opts = {
+  limit: 10, # Integer | Parameter for selecting the amount of data returned.
+  offset: 0 # Integer | Parameter for selecting the offset of data.
+}
+
+begin
+  #Get access for a role in the tenant
+  result = api_instance.get_role_access(uuid, opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->get_role_access: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of the role | 
+ **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
+
+
+## list_roles
+
+> RolePaginationDynamic list_roles(opts)
+
+List the roles 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::RoleApi.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.
+  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
+  add_fields: ['add_fields_example'], # Array<String> | Parameter for add list of fields to display for roles.
+  username: 'username_example' # String | Unique username of the principal to obtain roles for (only available for admins, and if supplied, takes precedence over the identity header).
+}
+
+begin
+  #List the roles for a tenant
+  result = api_instance.list_roles(opts)
+  p result
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->list_roles: #{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;]
+ **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] 
+ **add_fields** | [**Array&lt;String&gt;**](String.md)| Parameter for add list of fields to display for roles. | [optional] 
+ **username** | **String**| Unique username of the principal to obtain roles for (only available for admins, and if supplied, takes precedence over the identity header). | [optional] 
+
+### Return type
+
+[**RolePaginationDynamic**](RolePaginationDynamic.md)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_role
+
+> update_role(uuid, role_with_access)
+
+Update a Role 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::RoleApi.new
+uuid = 'uuid_example' # String | ID of role to update
+role_with_access = RBACApiClient::RoleWithAccess.new # RoleWithAccess | Update to a Role
+
+begin
+  #Update a Role in the tenant
+  api_instance.update_role(uuid, role_with_access)
+rescue RBACApiClient::ApiError => e
+  puts "Exception when calling RoleApi->update_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | [**String**](.md)| ID of role to update | 
+ **role_with_access** | [**RoleWithAccess**](RoleWithAccess.md)| Update to a Role | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic_auth](../README.md#basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+