Cisco Cisco Process Orchestrator 3.1 User Guide
Copyright 2014 Cisco Systems
62
Cisco Highly Confidential – Controlled Access
A printed copy of this document is considered uncontrolled. Refer to the online version for the controlled revision.
System Web Service
The System Web service allows users to import and retrieve external encryption RSA key information.
The WSDL for the System Web service methods is:
http://<server>:<port>/WS/System?wsdl
.
GetPublicKey
Users will be able to retrieve a string representation of Cisco Process Orchestrator’s public RSA key to be used for
external string encryption. The returned string will be Base64 encoded.
external string encryption. The returned string will be Base64 encoded.
Parameters
None
Return Type
String
ImportEncryptionKeys
Imports a RSA public / private key pair file into a Cisco Process Orchestrator environment. Update permission
on the “Environment Settings” object is required to import new public / private key pair.
on the “Environment Settings” object is required to import new public / private key pair.
Parameters
keyFilePath (string)—Universal Naming Convention (UNC) file name of the RSA key file
encryptedPassword (string)—password to access the key file, encrypted by Cisco Process Orchestrator’s RSA
public key from the GetPublicKey Web service method
public key from the GetPublicKey Web service method
Return Type
Boolean – Indicates if the method succeeds.
Exceptions
Upon failure to decrypt the password, it raises an exception “The server failed to import encryption key file. It
encountered an error when decrypting password of the encryption key file. The password should be encrypted with
Cisco Process Orchestrator's external public key. Clear text password is not supported.”
encountered an error when decrypting password of the encryption key file. The password should be encrypted with
Cisco Process Orchestrator's external public key. Clear text password is not supported.”
Upon failure to import the encryption keys, it raises an exception “The server failed to import encryption key file”.
Its inner exception has more error information.
Its inner exception has more error information.
GetEnvironmentInformation
Returns Cisco Process Orchestrator’s environment information, including environment name and environment
GUID
GUID
Parameters
None
Return Type
EnvironmentInformation object