KeyCredentialManager KeyCredentialManager KeyCredentialManager KeyCredentialManager Class

Definition

Contains methods for basic management of key credentials.

public : static class KeyCredentialManagerpublic static class KeyCredentialManagerPublic Static Class KeyCredentialManager// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

DeleteAsync(String) DeleteAsync(String) DeleteAsync(String) DeleteAsync(String)

Deletes a previously provisioned user identity key for the current user and application.

public : static IAsyncAction DeleteAsync(PlatForm::String name)public static IAsyncAction DeleteAsync(String name)Public Static Function DeleteAsync(name As String) As IAsyncAction// You can use this method in JavaScript.
Parameters
name
PlatForm::String String String String

The name of the key to delete.

Returns

This method does not return a value.

IsSupportedAsync() IsSupportedAsync() IsSupportedAsync() IsSupportedAsync()

Determines if the current device and user is capable of provisioning a key credential.

public : static IAsyncOperation<PlatForm::Boolean> IsSupportedAsync()public static IAsyncOperation<bool> IsSupportedAsync()Public Static Function IsSupportedAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

When this method completes, it returns true if the current device and user is capable of provisioning a key credential. Otherwise, it returns false.

Remarks

An application cannot provision a key credential until the user has successfully done the following:

  • Connected their user account to their Microsoft account.
  • Provided an unlock gesture (PIN or biometric) to protect the container that stores their key credential.

OpenAsync(String) OpenAsync(String) OpenAsync(String) OpenAsync(String)

Retrieves a key credential for the current user and application.

public : static IAsyncOperation<KeyCredentialRetrievalResult> OpenAsync(PlatForm::String name)public static IAsyncOperation<KeyCredentialRetrievalResult> OpenAsync(String name)Public Static Function OpenAsync(name As String) As IAsyncOperation( Of KeyCredentialRetrievalResult )// You can use this method in JavaScript.
Parameters
name
PlatForm::String String String String

The name of the key credential to open.

Returns

RenewAttestationAsync() RenewAttestationAsync() RenewAttestationAsync() RenewAttestationAsync()

Renews an attestation for a key credential.

public : static IAsyncAction RenewAttestationAsync()public static IAsyncAction RenewAttestationAsync()Public Static Function RenewAttestationAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

This method does not return a value.

RequestCreateAsync(String, KeyCredentialCreationOption) RequestCreateAsync(String, KeyCredentialCreationOption) RequestCreateAsync(String, KeyCredentialCreationOption) RequestCreateAsync(String, KeyCredentialCreationOption)

Creates a new key credential for the current user and application.

public : static IAsyncOperation<KeyCredentialRetrievalResult> RequestCreateAsync(PlatForm::String name, KeyCredentialCreationOption option)public static IAsyncOperation<KeyCredentialRetrievalResult> RequestCreateAsync(String name, KeyCredentialCreationOption option)Public Static Function RequestCreateAsync(name As String, option As KeyCredentialCreationOption) As IAsyncOperation( Of KeyCredentialRetrievalResult )// You can use this method in JavaScript.
Parameters
name
PlatForm::String String String String

The name of the key credential to create.

Returns