Show / Hide Table of Contents

UpdateUserInfoForCredential Method

UpdateUserInfoForCredential(CredentialId, UserEntity)

This performs the updateUserInformation subcommand of the authenticatorCredentialManagement command. It replaces the user info in the credential represented by the given credentialId with the given user data.

C#
public void UpdateUserInfoForCredential(CredentialId credentialId, UserEntity newUserInfo)

Parameters

Type Name Description
CredentialId credentialId

The ID of the credential to update.

UserEntity newUserInfo

An object containing the information that will replace the currently stored info.

Exceptions

Type Condition
Fido2Exception

There was no credential with the given ID.

InvalidOperationException

The connected YubiKey does not support CredentialManagement, or the PIN was invalid, or there was no KeyCollector.

OperationCanceledException

The user canceled the operation while collecting the PIN.

SecurityException

The PIN retry count was exhausted.

Remarks

See the User's Manual entry on credential management.

This method will replace all the user information currently stored against the credentialId on the YubiKey. That is, it does not "edit" the information. Hence, the userEntity you supply should contain all the information you want stored, even if some of that information is currently stored on the YubiKey.

If there is no credential with the given credentialId on the YubiKey, this method will throw an exception

In this article
Back to top Generated by DocFX