Server Credential Methods

Method Description
addServerCredential Adds a server credential to the system.

Server credentials can be created for users or groups. The user calling this method must have UpdateServerCredentialRight or be a super administrator.

updateServerCredential Updates a server credential in the system.

The user calling this method must have UpdateServerCredentialRight or be a super administrator.

Note: When performing an update only set the fields that you want to update in the ServerCredentials object. The rest of the fields will be null.
To update a field to become null:
  • String objects should be set to be an empty string (for example: "").
removeServerCredential Removes a server credential from the system.

Server credentials can be created for users or groups.

The user calling this method must have UpdateServerCredentialRight or be a super administrator.

retrieveAllServerCredentials Retrieves all server credentials from the system as an array of server credentials.

The last element of the array is null. If no server credentials are found, an array of one element is returned with a value of null.

The user calling this method must have UpdateServerCredentialRight, ViewServerCredentialRight, or be a super administrator.

getServerCredential Gets a server credential from the system.

Server credentials can be created for users or groups. If the server credential is not found, a null is returned.

The user calling this method must have UpdateServerCredentialRight, ViewServerCredentialRight, or be a super administrator.

searchServerCredentials Searches for server credential objects in the system.

Server credentials can be created for users or groups. If the ServerCredential objects are not found, a null is returned.

The user calling this method must have UpdateServerCredentialRight, ViewServerCredentialRight, or be a super administrator.