Additional Tools

In This Section

Previous Section

Certificate Generation

user-sync certgen [optional parameters]

User Sync Tool includes built in X509 certificate/key pair generator which is suitable for creating the UMAPI integration. The cert generator can be invoked from the command line using “user-sync certgen” [OPTIONS] to generate a new certificate/key pair with random or user-specified subjects. User Sync Tool can use these files to communicate with the admin console. Please visit Adobe.IO to complete the integration process.

Parameters and argument specifications Description
Specifying -r or --randomize will randomize the subjects for the certificate. No user input is required when using this option.
Specifying -y or --overwrite will overwrite files without having to confirm.
-p filename
--private-key-file filename
Specifying -p or --private-key-file will set a custom output path for the private key. Absolute or relative to the working folder. The default is private.key.
-c filename
--cert-pub-file filename
Specifying -c or --cert-pub-file will set a custom output path for the public certificate. Absolute or relative to the working folder. The default is certificate_pub.crt.

Example #1

> python user-sync.pex certgen

Enter information as required to generate the X509 certificate/key pair for your organization. This information is used only for authentication with UMAPI and does not need to reflect
an SSL or other official identity.
Expiration date (mm/dd/yyyy) [02/04/2030]: 02/04/2030
Country Code [US]: US
State [Your State]: MN
City [Your City]: Minneapolis
Organization [Company]: Company, Inc.
Common Name [Your Name]: John Doe
Email [email<span>@</span>]: email<span>@</span>
Files were created at:

In the example above, we entered some information about our organization, location, etc. As indicated by the program output, these fields will not be used by Adobe to identify you or your organization; and therefore, you may fill in these fields as you deem correct. You can also use --randomize to produce a secure random subject and automate the Certgen process (no user input will be required).

Example #2

> python user-sync.pex certgen –randomize

In this case, a certificate was created with the following random attributes. This certificate will not expire for 10 years.

Email = fcc626a96eec
Common Name = 5b61dd368ea8
Organization = 39d2b95b0c4a
Locale = d10111c9101f
State = cec8268e8b05
Country = 6d

You can use certificate_pub to create your UMAPI integration and private key to configure connector-umapi.yml.

Private Key Encryption

user-sync encrypt [optional parameters]
user-sync decrypt [optional parameters]

Private key encryption allows a user to encrypt a private key file with a passphrase. The UST can be configured to read this passphrase from a stored value from the priv_key_pass in the connector-umapi.yml file. When the UST runs, a decrypted version of the private key file is read without being stored. The decrypt command will allow a user to decrypt the private key file when the correct passphrase is entered. The decrypted data will overwrite the data in the private key file.

Parameters and argument specifications Description
key-path filename Provide an absolute or relative filename for the private key to be encyrpted/decrypted. The default is private.key
Password will be prompted if not passed as a parameter. This will be used as the passphrase for the RSA encryption of the private key file.

Previous Section