...
Universal Controller supports the following RESTful-based web services for Credential operations, which are listed alphabetically on this page.
- Credential Web Services#Create Create a CredentialCredential Web Services#Delete
- Delete a Credential
- Credential Web Services#List List Credentials
- Credential Web Services#Modify Modify a CredentialCredential Web Services#Read
- Read a Credential
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 Credential. |
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, below. |
Properties | See Credential Web Services#Credential Properties. |
Example Response |
|
...
Properties | UI Field Name | Description | Specifications | Required | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
description | Description | User-defined; description of this record. | N | |||||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | ||||||||||||||
exportTable | n/a | Record table information. | read only | N | ||||||||||||||
name | Name | Name used within the Controller to identify this Credential. | Maximum 40 alphanumerics. | Y | ||||||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to. Panel | Panel | this record belongs to.
| N | |||||||||||||
provider | Provider | Valid values (case-insensitive):
Default is Universal Controller (1). | N | |||||||||||||||
providerParameters | Provider Parameters |
| Y | |||||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Credential web service will persist the sysId property.
| Optional; Valid values: true/false (default is true). | N | ||||||||||||||
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. | N | |||||||||||||||
runtimePassPhrase | Pass Phrase (SFTP only) | Pass phrase for the Runtime User's SSL/TLS Private key file. | N | |||||||||||||||
runtimePassword | Runtime Password | Runtime user's password. |
| N | ||||||||||||||
runtimeToken | Token | Runtime user Token that can be used with the ${_credentialToken(credential_name)} function. |
| N | ||||||||||||||
runtimeUser | Runtime User | Runtime user ID, including an LDAP- or AD-formatted user ID, under which the job will be run. | Y | |||||||||||||||
sysId | n/a | System ID field in the database for this Credential record. | Persisted only if retainSysIds is set to true. | N | ||||||||||||||
type | Type | Type of Credential.
| Valid Values: Default is Standard (1). | N |
...
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, below. |
Properties | See Credential Web Services#Credential Properties. |
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/credential |
HTTP Method | PUT |
Description | Modifies the Credential specified by the |
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, below. |
Properties | See Credential Web Services#Credential Properties. |
Example Response |
|
...
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, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Read a Credential: Example Response, below. |
Properties | See Credential Web Services#Credential Properties. |
Anchor | ||||
---|---|---|---|---|
|
...