IKeyManager.RevokeKey(Guid, String) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.DataProtection.KeyManagement

Assembly:: Microsoft.AspNetCore.DataProtection.dll

Package:: Microsoft.AspNetCore.DataProtection v1.0.0

Package:: Microsoft.AspNetCore.DataProtection v1.1.0

Package:: Microsoft.AspNetCore.DataProtection v2.0.0

Package:: Microsoft.AspNetCore.DataProtection v2.1.0

Package:: Microsoft.AspNetCore.DataProtection v2.2.0

Package:: Microsoft.AspNetCore.DataProtection v3.0.3

Package:: Microsoft.AspNetCore.DataProtection v3.1.18

Package:: Microsoft.AspNetCore.DataProtection v5.0.9

Package:: Microsoft.AspNetCore.DataProtection v6.0.6

Package:: Microsoft.AspNetCore.DataProtection v7.0.5

Package:: Microsoft.AspNetCore.DataProtection v8.0.0

Package:: Microsoft.AspNetCore.DataProtection v9.0.0-preview.6.24328.4

Source:: IKeyManager.cs

Source:: IKeyManager.cs

Source:: IKeyManager.cs

Source:: IKeyManager.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Revokes a specific key and persists the revocation to the underlying repository.

public void RevokeKey (Guid keyId, string reason = default);

public void RevokeKey (Guid keyId, string? reason = default);

abstract member RevokeKey : Guid * string -> unit

Public Sub RevokeKey (keyId As Guid, Optional reason As String = Nothing)

Parameters

keyId: Guid

The id of the key to revoke.

reason: String

An optional human-readable reason for revocation.

Remarks

This method will not mutate existing IKey instances. After calling this method, all existing IKey instances should be discarded, and GetAllKeys should be called again.

Applies to

Share via