swagger_aem 2.5.0 → 3.4.0

data/docs/GraniteApi.md

@@ -0,0 +1,75 @@
+# SwaggerAemClient::GraniteApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ssl_setup**](GraniteApi.md#ssl_setup) | **POST** /libs/granite/security/post/sslSetup.html | 
+
+
+
+## ssl_setup
+
+> String ssl_setup(keystore_password, keystore_password_confirm, truststore_password, truststore_password_confirm, https_hostname, https_port, opts)
+
+
+
+### Example
+
+```ruby
+# load the gem
+require 'swagger_aem'
+# setup authorization
+SwaggerAemClient.configure do |config|
+  # Configure HTTP basic authorization: aemAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerAemClient::GraniteApi.new
+keystore_password = 'keystore_password_example' # String | 
+keystore_password_confirm = 'keystore_password_confirm_example' # String | 
+truststore_password = 'truststore_password_example' # String | 
+truststore_password_confirm = 'truststore_password_confirm_example' # String | 
+https_hostname = 'https_hostname_example' # String | 
+https_port = 'https_port_example' # String | 
+opts = {
+  privatekey_file: File.new('/path/to/file'), # File | 
+  certificate_file: File.new('/path/to/file') # File | 
+}
+
+begin
+  result = api_instance.ssl_setup(keystore_password, keystore_password_confirm, truststore_password, truststore_password_confirm, https_hostname, https_port, opts)
+  p result
+rescue SwaggerAemClient::ApiError => e
+  puts "Exception when calling GraniteApi->ssl_setup: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **keystore_password** | **String**|  | 
+ **keystore_password_confirm** | **String**|  | 
+ **truststore_password** | **String**|  | 
+ **truststore_password_confirm** | **String**|  | 
+ **https_hostname** | **String**|  | 
+ **https_port** | **String**|  | 
+ **privatekey_file** | **File**|  | [optional] 
+ **certificate_file** | **File**|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[aemAuth](../README.md#aemAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: text/plain
+

data/docs/InlineObject.md

@@ -0,0 +1,17 @@
+# SwaggerAemClient::InlineObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject.new(file: null)
+```
+
+

data/docs/InlineObject1.md

@@ -0,0 +1,17 @@
+# SwaggerAemClient::InlineObject1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**package** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject1.new(package: null)
+```
+
+

data/docs/InlineObject2.md

@@ -0,0 +1,17 @@
+# SwaggerAemClient::InlineObject2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**certificate** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject2.new(certificate: null)
+```
+
+

data/docs/InlineObject3.md

@@ -0,0 +1,17 @@
+# SwaggerAemClient::InlineObject3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**truststore_p12** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject3.new(truststore_p12: null)
+```
+
+

data/docs/InlineObject4.md

@@ -0,0 +1,21 @@
+# SwaggerAemClient::InlineObject4
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_chain** | **File** |  | [optional] 
+**pk** | **File** |  | [optional] 
+**key_store** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject4.new(cert_chain: null,
+                                 pk: null,
+                                 key_store: null)
+```
+
+

data/docs/InlineObject5.md

@@ -0,0 +1,19 @@
+# SwaggerAemClient::InlineObject5
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**privatekey_file** | **File** |  | [optional] 
+**certificate_file** | **File** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InlineObject5.new(privatekey_file: null,
+                                 certificate_file: null)
+```
+
+

data/docs/InstallStatus.md

@@ -1,8 +1,17 @@
 # SwaggerAemClient::InstallStatus
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **status** | [**InstallStatusStatus**](InstallStatusStatus.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InstallStatus.new(status: null)
+```
+
 

data/docs/InstallStatusStatus.md

@@ -1,9 +1,19 @@
 # SwaggerAemClient::InstallStatusStatus
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**finished** | **BOOLEAN** |  | [optional] 
+**finished** | **Boolean** |  | [optional] 
 **item_count** | **Integer** |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::InstallStatusStatus.new(finished: null,
+                                 item_count: null)
+```
+
 

data/docs/KeystoreChainItems.md

@@ -1,6 +1,7 @@
 # SwaggerAemClient::KeystoreChainItems
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **subject** | **String** | e.g. \"CN=localhost\" | [optional] 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **not_after** | **String** | e.g. \"Sun Jun 30 23:59:50 AEST 2019\" | [optional] 
 **serial_number** | **Integer** | 18165099476682912368 | [optional] 
 
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::KeystoreChainItems.new(subject: null,
+                                 issuer: null,
+                                 not_before: null,
+                                 not_after: null,
+                                 serial_number: null)
+```
+
 

data/docs/KeystoreInfo.md

@@ -1,9 +1,19 @@
 # SwaggerAemClient::KeystoreInfo
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **aliases** | [**Array<KeystoreItems>**](KeystoreItems.md) |  | [optional] 
-**exists** | **BOOLEAN** | False if truststore don't exist | [optional] 
+**exists** | **Boolean** | False if truststore don't exist | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::KeystoreInfo.new(aliases: null,
+                                 exists: null)
+```
 
 

data/docs/KeystoreItems.md

@@ -1,6 +1,7 @@
 # SwaggerAemClient::KeystoreItems
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **_alias** | **String** | Keystore alias name | [optional] 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **format** | **String** | e.g. \"PKCS#8\" | [optional] 
 **chain** | [**Array<KeystoreChainItems>**](KeystoreChainItems.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::KeystoreItems.new(_alias: null,
+                                 entry_type: null,
+                                 algorithm: null,
+                                 format: null,
+                                 chain: null)
+```
+
 

data/docs/SamlConfigurationInfo.md

@@ -1,6 +1,7 @@
 # SwaggerAemClient::SamlConfigurationInfo
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pid** | **String** | Persistent Identity (PID) | [optional] 
@@ -8,6 +9,19 @@ Name | Type | Description | Notes
 **description** | **String** | Title | [optional] 
 **bundle_location** | **String** | needed for configuration binding | [optional] 
 **service_location** | **String** | needed for configuraiton binding | [optional] 
-**properties** | **Object** |  | [optional] 
+**properties** | [**SamlConfigurationProperties**](SamlConfigurationProperties.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::SamlConfigurationInfo.new(pid: null,
+                                 title: null,
+                                 description: null,
+                                 bundle_location: null,
+                                 service_location: null,
+                                 properties: null)
+```
 
 

data/docs/SamlConfigurationProperties.md

@@ -1,31 +1,63 @@
 # SwaggerAemClient::SamlConfigurationProperties
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**path** | [**Array<SamlConfigurationPropertyItemsArray>**](SamlConfigurationPropertyItemsArray.md) | Repository path for which this authentication handler should be used by Sling. If this is empty, the authentication handler will be disabled. | [optional] 
-**service_ranking** | [**Array<SamlConfigurationPropertyItemsLong>**](SamlConfigurationPropertyItemsLong.md) | OSGi Framework Service Ranking value to indicate the order in which to call this service. This is an int value where higher values designate higher precedence. Default value is 0. | [optional] 
-**idp_url** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | URL of the IDP where the SAML Authentication Request should be sent to. If this property is empty the authentication handler is disabled. (idpUrl) | [optional] 
-**idp_cert_alias** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The alias of the IdP's certificate in the global truststore. If this property is empty the authentication handler is disabled. | [optional] 
-**idp_http_redirect** | [**Array<SamlConfigurationPropertyItemsBoolean>**](SamlConfigurationPropertyItemsBoolean.md) | Use an HTTP Redirect to the IDP URL instead of sending an AuthnRequest-message to request credentials. Use this for IDP initiated authentication. | [optional] 
-**service_provider_entity_id** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | ID which uniquely identifies this service provider with the identity provider. If this property is empty the authentication handler is disabled. | [optional] 
-**assertion_consumer_service_url** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The (optional) AssertionConsumerServiceURL attribute of an Authn request specifies the location to which a <Response> message MUST be sent to the requester. | [optional] 
-**sp_private_key_alias** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The alias of the SP's private key in the key-store of the 'authentication-service' system user. If this property is empty the handler will not be able to sign or decrypt messages. | [optional] 
-**key_store_password** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The password of the key-store of the 'authentication-service' system user. | [optional] 
-**default_redirect_url** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The default location to redirect to after successful authentication. | [optional] 
-**user_id_attribute** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The name of the attribute containing the user ID used to authenticate and create the user in the CRX repository. Leave empty to use the Subject:NameId. | [optional] 
-**use_encryption** | [**Array<SamlConfigurationPropertyItemsBoolean>**](SamlConfigurationPropertyItemsBoolean.md) | Whether or not this authentication handler expects encrypted SAML assertions. If this is enabled the SP's private key must be provided in the key-store of the 'authentication-service' system user (see SP Private Key Alias above). | [optional] 
-**create_user** | [**Array<SamlConfigurationPropertyItemsBoolean>**](SamlConfigurationPropertyItemsBoolean.md) | Whether or not to autocreate nonexisting users in the repository. | [optional] 
-**add_group_memberships** | [**Array<SamlConfigurationPropertyItemsBoolean>**](SamlConfigurationPropertyItemsBoolean.md) | Whether or not a user should be automatically added to CRX groups after successful authentication. | [optional] 
-**group_membership_attribute** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The name of the attribute containing a list of CRX groups this user should be added to. | [optional] 
-**default_groups** | [**Array<SamlConfigurationPropertyItemsArray>**](SamlConfigurationPropertyItemsArray.md) | A list of default CRX groups users are added to after successful authentication. | [optional] 
-**name_id_format** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The value of the NameIDPolicy format parameter to send in the AuthnRequest message. | [optional] 
-**synchronize_attributes** | [**Array<SamlConfigurationPropertyItemsArray>**](SamlConfigurationPropertyItemsArray.md) | A list of attribute mappings (in the format \\attributename=path/relative/to/user/node\\) which should be stored in the repository on user-synchronization. | [optional] 
-**handle_logout** | [**Array<SamlConfigurationPropertyItemsBoolean>**](SamlConfigurationPropertyItemsBoolean.md) | Whether or not logout (dropCredentials) requests will be processed by this handler. | [optional] 
-**logout_url** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | URL of the IDP where the SAML Logout Request should be sent to. If this property is empty the authentication handler won't handle logouts. | [optional] 
-**clock_tolerance** | [**Array<SamlConfigurationPropertyItemsLong>**](SamlConfigurationPropertyItemsLong.md) | Time tolerance in seconds to compensate clock skew between IDP and SP when validating Assertions. | [optional] 
-**digest_method** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The digest algorithm to use when signing a SAML message. | [optional] 
-**signature_method** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | The signature algorithm to use when signing a SAML message. | [optional] 
-**user_intermediate_path** | [**Array<SamlConfigurationPropertyItemsString>**](SamlConfigurationPropertyItemsString.md) | User intermediate path to store created users. | [optional] 
+**path** | [**SamlConfigurationPropertyItemsArray**](SamlConfigurationPropertyItemsArray.md) |  | [optional] 
+**service_ranking** | [**SamlConfigurationPropertyItemsLong**](SamlConfigurationPropertyItemsLong.md) |  | [optional] 
+**idp_url** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**idp_cert_alias** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**idp_http_redirect** | [**SamlConfigurationPropertyItemsBoolean**](SamlConfigurationPropertyItemsBoolean.md) |  | [optional] 
+**service_provider_entity_id** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**assertion_consumer_service_url** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**sp_private_key_alias** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**key_store_password** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**default_redirect_url** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**user_id_attribute** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**use_encryption** | [**SamlConfigurationPropertyItemsBoolean**](SamlConfigurationPropertyItemsBoolean.md) |  | [optional] 
+**create_user** | [**SamlConfigurationPropertyItemsBoolean**](SamlConfigurationPropertyItemsBoolean.md) |  | [optional] 
+**add_group_memberships** | [**SamlConfigurationPropertyItemsBoolean**](SamlConfigurationPropertyItemsBoolean.md) |  | [optional] 
+**group_membership_attribute** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**default_groups** | [**SamlConfigurationPropertyItemsArray**](SamlConfigurationPropertyItemsArray.md) |  | [optional] 
+**name_id_format** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**synchronize_attributes** | [**SamlConfigurationPropertyItemsArray**](SamlConfigurationPropertyItemsArray.md) |  | [optional] 
+**handle_logout** | [**SamlConfigurationPropertyItemsBoolean**](SamlConfigurationPropertyItemsBoolean.md) |  | [optional] 
+**logout_url** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**clock_tolerance** | [**SamlConfigurationPropertyItemsLong**](SamlConfigurationPropertyItemsLong.md) |  | [optional] 
+**digest_method** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**signature_method** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+**user_intermediate_path** | [**SamlConfigurationPropertyItemsString**](SamlConfigurationPropertyItemsString.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::SamlConfigurationProperties.new(path: null,
+                                 service_ranking: null,
+                                 idp_url: null,
+                                 idp_cert_alias: null,
+                                 idp_http_redirect: null,
+                                 service_provider_entity_id: null,
+                                 assertion_consumer_service_url: null,
+                                 sp_private_key_alias: null,
+                                 key_store_password: null,
+                                 default_redirect_url: null,
+                                 user_id_attribute: null,
+                                 use_encryption: null,
+                                 create_user: null,
+                                 add_group_memberships: null,
+                                 group_membership_attribute: null,
+                                 default_groups: null,
+                                 name_id_format: null,
+                                 synchronize_attributes: null,
+                                 handle_logout: null,
+                                 logout_url: null,
+                                 clock_tolerance: null,
+                                 digest_method: null,
+                                 signature_method: null,
+                                 user_intermediate_path: null)
+```
 
 

data/docs/SamlConfigurationPropertyItemsArray.md

@@ -1,13 +1,27 @@
 # SwaggerAemClient::SamlConfigurationPropertyItemsArray
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | property name | [optional] 
-**optional** | **BOOLEAN** | True if optional | [optional] 
-**is_set** | **BOOLEAN** | True if property is set | [optional] 
+**optional** | **Boolean** | True if optional | [optional] 
+**is_set** | **Boolean** | True if property is set | [optional] 
 **type** | **Integer** | Property type, 1=String, 3=long, 11=boolean, 12=Password | [optional] 
 **values** | **Array<String>** | Property value | [optional] 
 **description** | **String** | Property description | [optional] 
 
+## Code Sample
+
+```ruby
+require 'SwaggerAemClient'
+
+instance = SwaggerAemClient::SamlConfigurationPropertyItemsArray.new(name: null,
+                                 optional: null,
+                                 is_set: null,
+                                 type: null,
+                                 values: null,
+                                 description: null)
+```
+