8.6.7 UpdateCredential

The UpdateCredential Method is used to update a KeyCredential used by a Server.

The KeyCredential secret may be encrypted using the key returned by GetEncryptingKey. The SecurityPolicyUri species the algorithm used for encryption. The format of the encrypted data is described in 8.5.6.

This Method shall be called from an encrypted SecureChannel and from a Client that has access to the SecurityAdmin Role (see 8.2).

Signature 

UpdateCredential(
	[in] String 	CredentialId
	[in] ByteString CredentialSecret
	[in] String 	CertificateThumbprint
	[in] String 	SecurityPolicyUri
);
Argument Description
CredentialIdThe CredentialId is the identifier, such as a user name, which often needs to be presented when using the CredentialSecret.
CredentialSecretThe secret associated with the KeyCredential.
CertificateThumbprint

The SHA1 hash of the Certificate used to encrypt the secret.

For RSA SecurityPolicies this shall be one of the ApplicationInstance Certificates assigned to the Server. For ECC or RSA-DH SecurityPolicies this field is not specified. Not specified if the secret is not encrypted.

SecurityPolicyUri

The SecurityPolicy used to encrypt the secret.

If not specified the secret is not encrypted.

Method Result Codes (defined in Call Service)

Result Code Description
Bad_InvalidArgumentThe CredentialId or CredentialSecret is not valid.
Bad_CertificateInvalidThe Certificate is invalid or it is not one of the Server’s Certificates.
Bad_SecurityPolicyRejectedThe SecurityPolicy is unrecognized or not allowed.
Bad_UserAccessDeniedThe current user does not have the rights required.
Bad_SecurityModeInsufficientThe SecureChannel is not encrypted.

Table 139 specifies the AddressSpace representation for the UpdateKeyCredential Method.

Table 138 – UpdateCredential Method AddressSpace Definition
Attribute Value
BrowseName0:UpdateCredential
References NodeClass BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[] 0:PropertyTypeMandatory