Merge pull request #91 from IBM/password_policy

patch: Custom password generation policy for user-credentials secrets

examples/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/SecretsManagerExamples.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/examples/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/SecretsManagerExamples.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/SecretsManager.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -12,7 +12,7 @@
  */
 
 /*
- * IBM OpenAPI SDK Code Generator Version: 3.82.1-2082d402-20231115-195014
+ * IBM OpenAPI SDK Code Generator Version: 3.84.2-a032c73d-20240125-175315
  */
 
 package com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2;

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecret.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretMetadata.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretMetadataPatch.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -64,9 +64,9 @@ public ArbitrarySecretMetadataPatch build() {
     }
 
     /**
-     * Adds an labels to labels.
+     * Adds a new element to labels.
      *
-     * @param labels the new labels
+     * @param labels the new element to be added
      * @return the ArbitrarySecretMetadataPatch builder
      */
     public Builder addLabels(String labels) {

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretPrototype.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -106,9 +106,9 @@ public ArbitrarySecretPrototype build() {
     }
 
     /**
-     * Adds an labels to labels.
+     * Adds a new element to labels.
      *
-     * @param labels the new labels
+     * @param labels the new element to be added
      * @return the ArbitrarySecretPrototype builder
      */
     public Builder addLabels(String labels) {

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretVersion.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretVersionMetadata.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ArbitrarySecretVersionPrototype.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/CertificateIssuanceInfo.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/CertificateValidity.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ChallengeResource.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/CommonRotationPolicy.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/Configuration.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -383,8 +383,8 @@ public String getLetsEncryptEnvironment() {
   /**
    * Gets the letsEncryptPreferredChain.
    *
-   * If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If
-   * no match, the default offered chain will be used.
+   * This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
+   * Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
    *
    * @return the letsEncryptPreferredChain
    */
@@ -407,16 +407,22 @@ public String getLetsEncryptPrivateKey() {
   /**
    * Gets the cloudInternetServicesApikey.
    *
-   * An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.
+   * An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
    *
    * To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
-   * key must be assigned the Reader service role on Internet Services (`internet-svcs`).
+   * key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records
+   * you need to assign the Manager role.
    *
-   * If you need to manage specific domains, you can assign the Manager role. For production environments, it is
-   * recommended that you assign the Reader access role, and then use the
+   * If you want to manage specific domains, you can assign the Manager role for this specific domain.  For production
+   * environments, it is recommended that you assign the Reader access role, and then use the
    * [IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific
-   * domains. For more information, see the
-   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).
+   * domains.
+   *
+   * If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance  with
+   * service-to-service authorization.
+   *
+   * For more information, see the
+   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
    *
    * @return the cloudInternetServicesApikey
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationAction.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -393,7 +393,7 @@ public PrivateCertificateConfigurationCACertificate getData() {
   /**
    * Gets the intermediateCertificateAuthority.
    *
-   * The unique name of your configuration.
+   * The name of the intermediate certificate authority configuration.
    *
    * @return the intermediateCertificateAuthority
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationActionPrototype.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -367,7 +367,7 @@ public String csr() {
   /**
    * Gets the intermediateCertificateAuthority.
    *
-   * The unique name of your configuration.
+   * The name of the intermediate certificate authority configuration.
    *
    * @return the intermediateCertificateAuthority
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationMetadata.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -261,8 +261,8 @@ public String getLetsEncryptEnvironment() {
   /**
    * Gets the letsEncryptPreferredChain.
    *
-   * If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If
-   * no match, the default offered chain will be used.
+   * This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
+   * Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
    *
    * @return the letsEncryptPreferredChain
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationMetadataPaginatedCollection.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationPatch.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -714,8 +714,8 @@ public String letsEncryptPrivateKey() {
   /**
    * Gets the letsEncryptPreferredChain.
    *
-   * If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If
-   * no match, the default offered chain will be used.
+   * This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
+   * Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
    *
    * @return the letsEncryptPreferredChain
    */
@@ -726,16 +726,22 @@ public String letsEncryptPreferredChain() {
   /**
    * Gets the cloudInternetServicesApikey.
    *
-   * An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.
+   * An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
    *
    * To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
-   * key must be assigned the Reader service role on Internet Services (`internet-svcs`).
+   * key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records
+   * you need to assign the Manager role.
    *
-   * If you need to manage specific domains, you can assign the Manager role. For production environments, it is
-   * recommended that you assign the Reader access role, and then use the
+   * If you want to manage specific domains, you can assign the Manager role for this specific domain.  For production
+   * environments, it is recommended that you assign the Reader access role, and then use the
    * [IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific
-   * domains. For more information, see the
-   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).
+   * domains.
+   *
+   * If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance  with
+   * service-to-service authorization.
+   *
+   * For more information, see the
+   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
    *
    * @return the cloudInternetServicesApikey
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationPrototype.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -999,8 +999,8 @@ public String letsEncryptPrivateKey() {
   /**
    * Gets the letsEncryptPreferredChain.
    *
-   * If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If
-   * no match, the default offered chain will be used.
+   * This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
+   * Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
    *
    * @return the letsEncryptPreferredChain
    */
@@ -1011,16 +1011,22 @@ public String letsEncryptPreferredChain() {
   /**
    * Gets the cloudInternetServicesApikey.
    *
-   * An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.
+   * An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
    *
    * To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
-   * key must be assigned the Reader service role on Internet Services (`internet-svcs`).
+   * key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records
+   * you need to assign the Manager role.
    *
-   * If you need to manage specific domains, you can assign the Manager role. For production environments, it is
-   * recommended that you assign the Reader access role, and then use the
+   * If you want to manage specific domains, you can assign the Manager role for this specific domain.  For production
+   * environments, it is recommended that you assign the Reader access role, and then use the
    * [IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific
-   * domains. For more information, see the
-   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).
+   * domains.
+   *
+   * If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance  with
+   * service-to-service authorization.
+   *
+   * For more information, see the
+   * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
    *
    * @return the cloudInternetServicesApikey
    */

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/ConfigurationsPager.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

modules/secrets-manager/src/main/java/com/ibm/cloud/secrets_manager_sdk/secrets_manager/v2/model/CreateConfigurationActionOptions.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at