Credentials Data Methods

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

addCredentialsEntry

Adds a credentials entry to the specified protocol for the specified domain.

Input

Parameter	Comment
cmdbContext	For details, see CmdbContext and the schema documentation for `CmdbContext`.
domainName	The domain to update.
protocolName	The name of the protocol.
credentialsEntryParameters	The CIProperties collection of the new credentials.

Output

Parameter	Comment
credentialsEntryID	The CI ID of the new credential entry.

getCredentialsEntriesIDs

Returns the IDs of the credentials defined for the specified protocol.

Input

Parameter	Comment
cmdbContext	For details, see CmdbContext and the schema documentation for `CmdbContext`.
domainName	The domain for which to get the credentials.
protocolName	The name of a protocol used on that domain.

Output

Parameter	Comment
credentialsEntryIDs	The list of credential IDs for the protocol on the domain.

getCredentialsEntry

Returns the credentials defined for the specified protocol. Encrypted attributes are returned empty.

Input

Parameter	Comment
cmdbContext	For details, see CmdbContext and the schema documentation for `CmdbContext`.
domainName	The domain for which to get the credentials.
protocolName	The name of a protocol used on that domain.
credentialsEntryID	The credential ID to get.

Output

Parameter	Comment
credentialsEntryParameters	The CIProperties collection of the credentials.

updateCredentialsEntry

Sets new values for properties of the specified credentials entry.

The existing properties are deleted and these properties are set. Any property whose value is not set in this call is left undefined.

Input

Parameter	Comment
cmdbContext	For details, see CmdbContext and the schema documentation for `CmdbContext`.
domainName	The domain in which to update credentials.
protocolName	The name of a protocol used on the domain.
credentialsEntryID	The ID of the credentials to update.
credentialsEntryParameters	The CIProperties collection to set as properties for the credentials.

Connect

ITOM Marketplace

IT Service Management blog

Documentation Forum

Micro Focus Support and News Forum

Learn

Micro Focus Support Online

Micro Focus Support Downloads

Micro Focus Software Education

Contact

Submit Service Request

View Service Requests