Versions Compared

Old Version 7

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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


<pre> &lt;opswiseGroups&gt; &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
      <opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
Panel
Html bobswift


 
JSON


<pre> 
"opswiseGroups": ["
test
group1","group2"]
</pre>
 Panel
 Html bobswift


N
 Anchor
retainSysIds - CRED
retainSysIds - CRED
 retainSysIds
n/a
Specification for whether or not the Create a Credential web service will persist the sysId property.
html-bobswift
<ul>
<li> If <b>retainSysIds</b>
  • If retainSysIds="true" 
 and <code>sysId</code> is included in the request, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>
  • and sysId is included in the request/response, sysId will be persisted to the database.
  • If retainSysIds="false" 
 and  <code>sysId</code> is included in the request, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. 
</ul>
  • and sysId is included in the request/response, 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.
  • 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 ${_credentialToken(credential_name)} 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 convert any Credential type to any other type.

Valid Values:
html-bobswift
<ul>
<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Standard, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  1

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Resolvable, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  2

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Web 
 
  •  Service, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  3

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Email, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  4

</ul>
Default is Standard (1).
N
...