IKeyManager.RevokeAllKeys(DateTimeOffset, 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-rc.1.24452.1
Source:
IKeyManager.cs
Source:
IKeyManager.cs
Source:
IKeyManager.cs
Source:
IKeyManager.cs

Revokes all keys created before a specified date and persists the revocation to the underlying repository.

public void RevokeAllKeys (DateTimeOffset revocationDate, string reason = default);
public void RevokeAllKeys (DateTimeOffset revocationDate, string? reason = default);
abstract member RevokeAllKeys : DateTimeOffset * string -> unit
Public Sub RevokeAllKeys (revocationDate As DateTimeOffset, Optional reason As String = Nothing)

Parameters

revocationDate
DateTimeOffset

The revocation date. All keys with a creation date before this value will be revoked.

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