update oa3 specs 2023-11-15 (#283)

patrickcping · Nov 15, 2023 · c951203 · c951203
1 parent 86d38c4
commit c951203
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 0 deletions.
diff --git a/management/api/openapi.yaml b/management/api/openapi.yaml
@@ -27150,6 +27150,7 @@ components:
         secret:
           description: A string that specifies the application secret ID used to authenticate
             to the authorization server.
+          format: password
           readOnly: true
           type: string
       type: object
@@ -27524,6 +27525,7 @@ components:
         privateKey:
           description: "A string that specifies the PEM-encoded, unencrypted private\
             \ key that matches the certificate's public key. This is a required property."
+          format: password
           type: string
       required:
       - certificate
@@ -30061,6 +30063,7 @@ components:
           bindPassword:
             description: A string that specifies the bind password for the LDAP database.
               This is a required property.
+            format: password
             type: string
           connectionSecurity:
             $ref: '#/components/schemas/EnumGatewayTypeLDAPSecurity'
@@ -30108,6 +30111,7 @@ components:
           defaultSharedSecret:
             description: Value to use for the shared secret if the shared secret is
               not provided for one or more of the RADIUS clients specified.
+            format: password
             type: string
           radiusClients:
             description: Collection of RADIUS clients.
@@ -30145,6 +30149,7 @@ components:
         credential:
           description: A string that specifies the signed JWT for the gateway credential.
             This property is present only when the gateway credential is created.
+          format: password
           readOnly: true
           type: string
       type: object
@@ -30464,6 +30469,7 @@ components:
           appSecret:
             description: A string that specifies the application secret from Facebook.
               This is a required property.
+            format: password
             type: string
         required:
         - appId
@@ -30480,6 +30486,7 @@ components:
           clientSecret:
             description: A string that specifies the application secret from the provider.
               This is a required property.
+            format: password
             type: string
         required:
         - clientId
@@ -30501,6 +30508,7 @@ components:
           clientSecret:
             description: A string that specifies the application secret from the OIDC
               identity provider. This is a required property.
+            format: password
             type: string
           discoveryEndpoint:
             description: A string that specifies the OIDC identity provider's discovery
@@ -30554,6 +30562,7 @@ components:
           clientSecretSigningKey:
             description: A string that specifies the private key that is used to generate
               a client secret. This is a required property.
+            format: password
             type: string
           keyId:
             description: A 10-character string that Apple uses to identify an authentication
@@ -30580,6 +30589,7 @@ components:
           clientSecret:
             description: A string that specifies the application secret from PayPal.
               This is a required property.
+            format: password
             type: string
           clientEnvironment:
             description: "A string that specifies the PayPal environment. Options\
@@ -31238,6 +31248,7 @@ components:
           type: string
         password:
           description: A string that specifies the organization's SMTP server's password.
+          format: password
           type: string
         environment:
           $ref: '#/components/schemas/ObjectEnvironment'
@@ -31398,6 +31409,7 @@ components:
             type: string
           authToken:
             description: The secret key of the Twilio or Syniverse account.
+            format: password
             type: string
           numbers:
             items:
@@ -32572,6 +32584,7 @@ components:
             \ are a-z, A-Z, 0-9, -, ., _, ~. The secret has a minimum length of 64\
             \ characters per SHA-512 requirements when using the HS512 algorithm to\
             \ sign ID tokens using the secret as the key."
+          format: password
           readOnly: true
           type: string
       type: object
@@ -34364,16 +34377,19 @@ components:
           description: Play Integrity verdict decryption key from your Google Play
             Services account. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType`
             to `INTERNAL`.
+          format: password
           type: string
         serviceAccountCredentials:
           description: Contents of the JSON file that represents your Service Account
             Credentials. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType`
             to `GOOGLE`.
+          format: password
           type: string
         verificationKey:
           description: Play Integrity verdict signature verification key from your
             Google Play Services account. This parameter must be provided if you have
             set `mobile.integrityDetection.googlePlay.verificationType` to `INTERNAL`.
+          format: password
           type: string
         verificationType:
           $ref: '#/components/schemas/EnumApplicationNativeGooglePlayVerificationType'
@@ -36856,6 +36872,7 @@ components:
       properties:
         serviceAccountPassword:
           description: The password for the Kerberos service account.
+          format: password
           type: string
         serviceAccountUserPrincipalName:
           description: "The Kerberos service account user principal name (for example,\
@@ -36983,6 +37000,7 @@ components:
             \ not provided, the shared secret specified with `defaultSharedSecret`\
             \ is used. If you are not providing a shared secret for the client, leave\
             \ out `sharedSecret` or set it to null."
+          format: password
           type: string
       required:
       - ip
@@ -37696,10 +37714,12 @@ components:
         password:
           description: The password for the custom provider account. Required when
             `authentication.method=BASIC`
+          format: password
           type: string
         authToken:
           description: The authentication token for the custom provider account.  Required
             when `authentication.method=BEARER`
+          format: password
           type: string
       required:
       - method
@@ -38827,6 +38847,7 @@ components:
         value:
           description: A string that specifies the user's password value. The string
             is either in cleartext or pre-encoded format.
+          format: password
           type: string
         external:
           $ref: '#/components/schemas/User_password_external'

diff --git a/management/generate/pingone-management.yml b/management/generate/pingone-management.yml
@@ -1041,12 +1041,15 @@ components:
                       properties:
                         decryptionKey:
                           type: string
+                          format: password
                           description: Play Integrity verdict decryption key from your Google Play Services account. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType` to `INTERNAL`.
                         serviceAccountCredentials:
                           type: string
+                          format: password
                           description: Contents of the JSON file that represents your Service Account Credentials. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType` to `GOOGLE`.
                         verificationKey:
                           type: string
+                          format: password
                           description: Play Integrity verdict signature verification key from your Google Play Services account. This parameter must be provided if you have set `mobile.integrityDetection.googlePlay.verificationType` to `INTERNAL`.
                         verificationType:
                           $ref: '#/components/schemas/EnumApplicationNativeGooglePlayVerificationType'
@@ -1300,6 +1303,7 @@ components:
           $ref: '#/components/schemas/ObjectEnvironment'
         secret:
           type: string
+          format: password
           readOnly: true
           description: A string that specifies the application secret ID used to authenticate to the authorization server.
     ApplicationWSFED:
@@ -1691,6 +1695,7 @@ components:
           description: A string that specifies the PEM-encoded certificate chain.
         privateKey:
           type: string
+          format: password
           description: A string that specifies the PEM-encoded, unencrypted private key that matches the certificate's public key. This is a required property.
       required:
         - certificate
@@ -2701,6 +2706,7 @@ components:
               description: A string that specifies the distinguished name information to bind to the LDAP database (for example, uid=pingone,dc=example,dc=com).
             bindPassword:
               type: string
+              format: password
               description: A string that specifies the bind password for the LDAP database. This is a required property.
             connectionSecurity:
               $ref: '#/components/schemas/EnumGatewayTypeLDAPSecurity'
@@ -2710,6 +2716,7 @@ components:
               properties:
                 serviceAccountPassword:
                   type: string
+                  format: password
                   description: The password for the Kerberos service account.
                 serviceAccountUserPrincipalName:
                   type: string
@@ -2822,6 +2829,7 @@ components:
                 - policy
             defaultSharedSecret:
               type: string
+              format: password
               description: Value to use for the shared secret if the shared secret is not provided for one or more of the RADIUS clients specified.
             radiusClients:
               type: array
@@ -2834,6 +2842,7 @@ components:
                     description: The IP of the RADIUS client.
                   sharedSecret:
                     type: string
+                    format: password
                     description: The shared secret for the RADIUS client. If this value is not provided, the shared secret specified with `defaultSharedSecret` is used. If you are not providing a shared secret for the client, leave out `sharedSecret` or set it to null.
                 required:
                   - ip
@@ -2859,6 +2868,7 @@ components:
           description: A date that specifies the date the credential was last used in UTC. This is a required property.
         credential:
           type: string
+          format: password
           readOnly: true
           description: A string that specifies the signed JWT for the gateway credential. This property is present only when the gateway credential is created.
     GatewayInstance:
@@ -3126,6 +3136,7 @@ components:
               description: A string that specifies the application ID from Facebook. This is a required property.
             appSecret:
               type: string
+              format: password
               description: A string that specifies the application secret from Facebook. This is a required property.
           required:
             - appId
@@ -3140,6 +3151,7 @@ components:
               description: A string that specifies the application ID from the provider. This is a required property.
             clientSecret:
               type: string
+              format: password
               description: A string that specifies the application secret from the provider. This is a required property.
           required:
             - clientId
@@ -3157,6 +3169,7 @@ components:
               description: A string that specifies the application ID from the OIDC identity provider. This is a required property.
             clientSecret:
               type: string
+              format: password
               description: A string that specifies the application secret from the OIDC identity provider. This is a required property.
             discoveryEndpoint:
               type: string
@@ -3199,6 +3212,7 @@ components:
               description: A string that specifies the application ID from Apple. This is the identifier obtained after registering a services ID in the Apple developer portal. This is a required property.
             clientSecretSigningKey:
               type: string
+              format: password
               description: A string that specifies the private key that is used to generate a client secret. This is a required property.
             keyId:
               type: string
@@ -3221,6 +3235,7 @@ components:
               description: A string that specifies the application ID from PayPal. This is a required property.
             clientSecret:
               type: string
+              format: password
               description: A string that specifies the application secret from PayPal. This is a required property.
             clientEnvironment:
               type: string
@@ -3882,6 +3897,7 @@ components:
           description: A string that specifies the organization's SMTP server's username.
         password:
           type: string
+          format: password
           description: A string that specifies the organization's SMTP server's password.
         environment:
           $ref: '#/components/schemas/ObjectEnvironment'
@@ -3956,9 +3972,11 @@ components:
                   description: The username for the custom provider account. Required when `authentication.method=BASIC`
                 password:
                   type: string
+                  format: password
                   description: The password for the custom provider account. Required when `authentication.method=BASIC`
                 authToken:
                   type: string
+                  format: password
                   description: The authentication token for the custom provider account.  Required when `authentication.method=BEARER`
               required:
                 - method
@@ -4070,6 +4088,7 @@ components:
                 Relevant to Twilio only.
             authToken:
               type: string
+              format: password
               description: The secret key of the Twilio or Syniverse account.
             numbers:
               type: array
@@ -5128,6 +5147,7 @@ components:
           $ref: '#/components/schemas/ObjectEnvironment'
         secret:
           type: string
+          format: password
           readOnly: true
           description: An auto-generated resource client secret. Possible characters are a-z, A-Z, 0-9, -, ., _, ~. The secret has a minimum length of 64 characters per SHA-512 requirements when using the HS512 algorithm to sign ID tokens using the secret as the key.
     ResourceScope:
@@ -6504,6 +6524,7 @@ components:
               description: A boolean that specifies whether the user is forced to change the password on the next log in. If not provided, the property is set to false.
             value:
               type: string
+              format: password
               description: A string that specifies the user's password value. The string is either in cleartext or pre-encoded format.
             external:
               type: object

diff --git a/mfa/api/openapi.yaml b/mfa/api/openapi.yaml
@@ -4190,6 +4190,7 @@ components:
           key:
             description: A string that Apple uses as an identifier to identify an
               authentication key.  Mandatory.
+            format: password
             type: string
           teamId:
             description: A string that Apple uses as an identifier to identify teams.
@@ -4198,6 +4199,7 @@ components:
             description: A string that Apple uses as the authentication token signing
               key to securely connect to APNS. This is a p8 file with a private key
               format.
+            format: password
             type: string
         required:
         - key
@@ -4213,6 +4215,7 @@ components:
             deprecated: true
             description: A string that Apple uses as an identifier to identify an
               authentication key.  Mandatory.
+            format: password
             type: string
         required:
         - key
@@ -4226,6 +4229,7 @@ components:
             description: Used when `type` is set to `FCM_HTTP_V1`. The value should
               be the contents of the JSON file that represents your Service Account
               Credentials.
+            format: password
             type: string
         required:
         - googleServiceAccountCredentials
@@ -4241,6 +4245,7 @@ components:
           clientSecret:
             description: Used only if type is set to HMS. The client secret associated
               with the OAuth 2.0 Client ID.
+            format: password
             type: string
         required:
         - clientId

diff --git a/mfa/generate/pingone-mfa.yml b/mfa/generate/pingone-mfa.yml
@@ -779,12 +779,14 @@ components:
           properties:
             key:
               type: string
+              format: password
               description: A string that Apple uses as an identifier to identify an authentication key.  Mandatory.
             teamId:
               type: string
               description: A string that Apple uses as an identifier to identify teams.
             token:
               type: string
+              format: password
               description: A string that Apple uses as the authentication token signing key to securely connect to APNS. This is a p8 file with a private key format.
           required:
             - key
@@ -799,6 +801,7 @@ components:
           properties:
             key:
               type: string
+              format: password
               description: A string that Apple uses as an identifier to identify an authentication key.  Mandatory.
               deprecated: true
           required:
@@ -810,6 +813,7 @@ components:
           properties:
             googleServiceAccountCredentials:
               type: string
+              format: password
               description: Used when `type` is set to `FCM_HTTP_V1`. The value should be the contents of the JSON file that represents your Service Account Credentials.
           required:
             - googleServiceAccountCredentials
@@ -823,6 +827,7 @@ components:
               description: Used only if type is set to HMS. OAuth 2.0 Client ID from the Huawei Developers API console.
             clientSecret:
               type: string
+              format: password
               description: Used only if type is set to HMS. The client secret associated with the OAuth 2.0 Client ID.
           required:
             - clientId