Versions Compared

Version Old Version 1 New Version 2
Changes made by

Stonebranch

Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller supports the following RESTful-based web services for Credential operations, which are listed alphabetically on this page.


Formatting specifications for each web service, including details about property requirements, are provided.

...


Description

URI

http://host_name/uc/resources/credential

HTTP Method

POST

Description

Creates a Credentials.

Example URI

http://localhost:8080/uc/resources/credential

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create a Credential Example Request 438082249, below.

Properties

See Credential Properties.

Example Response

  • Status 200 /OK
    Successfully created the credential with sysId {sysId}.
  • Status 400 /Bad Request
    Create credential failed. A duplicate value has been detected. Name must be unique.

...

Properties

UI Field Name

Description

Specifications

Required

Anchor
description - CRED
description - CRED
description

Description

User-defined; description of this record.


N

Anchor
exportReleaseLevel - CRED
exportReleaseLevel - CRED
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - CRED
exportTable - CRED
exportTable

n/aRecord table information.read onlyN

Anchor
name - CRED
name - CRED
name

Name

Name used within the Controller to identify this Credential.

Maximum 40 alphanumerics.

Y

Anchor
opswiseGroups - CRED
opswiseGroups - CRED
opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
Format:
 
XML


Panel
<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
      <opswiseGroup>group2</opswiseGroup>
</opswiseGroups>

 
JSON


Panel
"opswiseGroups": ["group1","group2"]



N

provider

Provider

Provider of credentials. 

Valid values (case-insensitive):

  • As String = Universal Controller, As Value = 1

  • As String = AWS Secrets Manager, As Value=2

  • As String = Azure Key Vault, As Value = 3

  • As String = CyberArk Credential Provider, As Value = 4

  • As String = CyberArk Central Credential Provider, As Value = 5

Default is Universal Controller (1).

N

providerParameters

Provider Parameters

Set of parameters specific to provider. See Provider Parameters for provider parameter details for each provider. 



Code Block
languagexml
titleXML



 Code Block
languagexml
titleJSON



Y
(if provider is not Universal Controller)
 Anchor
retainSysIds - CRED
retainSysIds - CRED
 retainSysIds
n/a
Specification for whether or not the Create a Credential web service will persist the sysId - CRED 438082249 property.
  • If retainSysIds="true" and sysId is included in the request, sysId will be persisted to the database.
  • If retainSysIds="false" and sysId is included in the request, sysId will be ignored; it will be autogenerated by the Controller.

 Note
titleNote
In XML web services, retainSysIds is specified as an attribute in the <credential> element.

Optional; Valid values: true/false (default is true).
N
 Anchor
runtimeKeyLocation - CRED
runtimeKeyLocation - CRED
runtimeKeyLocation
Key Location (SFTP only)
Using SFTP requires that you supply a valid credential that specifies the location of the SSL/TLS Private key on your Agent. This property provides the location, which must exist on the Agent where you intend to run the SFTP task. Currently, the Controller does not support password authentication for SFTP Transfer.
 
For File Transfer over SSL/TLS, make sure you have your private/public keys properly set up and working before you configure the Controller to use it. For example, to validate the keys, log into your destination server from your agent server using SSL/TLS.

N
 Anchor
runtimePassPhrase - CRED
runtimePassPhrase - CRED
runtimePassPhrase
Pass Phrase (SFTP only)
Pass phrase for the Runtime User's SSL/TLS Private key file.

N
 Anchor
runtimePassword - CRED
runtimePassword - CRED
runtimePassword
Runtime Password
Runtime user's Password Web Services#Change Runtime Password of Credentials.
  • If runtimePassword is omitted in the request, it will be ignored.
  • If runtimePassword is provided in the request, it will be updated.
N
 Anchor
runtimeToken - CRED
runtimeToken - CRED
runtimeToken
Token
Runtime user Token that can be used with the Functions#Return Token of a Credential function.

  • If runtimeToken is omitted in the request, it will be ignored.
  • If runtimeToken is provided in the request, it will be updated.
N
 Anchor
runtimeUser - CRED
runtimeUser - CRED
runtimeUser
Runtime User
Runtime user ID, including an LDAP- or AD-formatted user ID, under which the job will be run.

Y
 Anchor
sysId - CRED
sysId - CRED
sysId
n/a
System ID field in the database for this Credential record.
Persisted only if retainSysIds is set to true.
N
 Anchor
type - CRED
type - CRED
type
Type
Type of Credential.
 

 Note
titleNote:
You cannot modify the type after the Credential has been created, but you can Credentials#Converting Credential Types any Credential type to any other type.

Valid Values:
  • As String = Standard, As Value = 1
  • As String = Resolvable, As Value = 2
  • As String = Web Service, As Value = 3
  • As String = Email, As Value = 4
Default is Standard (1).
N
...
   

Description
URI
http://host_name/uc/resources/credential
HTTP Method
DELETE
Description
Deletes a Credential.
URI Parameters
See Delete a Credential URI Parameters 438082249, below.
Example URI
http://localhost:8080/uc/resources/credential?credentialname=test
Example Response
  • Status 200 /OK
    Credential deleted successfully.
  • Status 400 /Bad Request
    Mutual exclusion violation. Cannot specify credentialname and credentialid at the same time.
  • Status 404 /Not Found
    A credential with {name/id} "test" does not exist.
...
  

Description
URI
http://host_name/uc/resources/credential/list
HTTP Method
GET
Description
Retrieves information on all Credentials.
Example URI
http://localhost:8080/uc/resources/credential/list
Authentication
HTTP Basic
Consumes Content-Type
n/a
Produces Content-Type
application/xml, application/json
Example Response
See List Credentials Example Response 438082249, below.
Properties
See Credential Properties.
...
   

Description
URI
http://host_name/uc/resources/credential
HTTP Method
PUT
Description
Modifies the Credential specified by the sysId.
Example URI
http://localhost:8080/uc/resources/credential
Consumes Content-Type
application/xml, application/json
Produces Content-Type
n/a
Example Request
See Modify a Credential Example Request 438082249, below.
Properties
See Credential Properties.
Example Response
  • Status 200 /OK
    Successfully updated the credential with sysId <sysId> to version <version>.
...
   
URI
http://host_name/uc/resources/credential
HTTP Method
GET
Description
Retrieves information on a specific Credential.
URI Parameters
See Read a Credential URI Parameters 438082249, below.
Example URI
Consumes Content-Type
n/a
Produces Content-Type
application/xml, application/json
Example Response
See Read a Credential Example Response 438082249, below.
Properties
See Credential Properties.
...