UseRevokeKey
katanakit-js / useRevokeKey
Function: useRevokeKey()
Section titled “Function: useRevokeKey()”function useRevokeKey(record): { createdAt: string; id: string; label: string; note?: string; provider: string; secret: string; status: "active" | "revoked"; updatedAt: string;};Defined in: core/services/keyvault.service.ts:262
Marks a key as revoked. See KeyVaultService.useRevokeKey.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
record |
{ createdAt: string; id: string; label: string; note?: string; provider: string; secret: string; status: "active" | "revoked"; updatedAt: string; } |
record.createdAt? |
string |
record.id? |
string |
record.label? |
string |
record.note? |
string |
record.provider? |
string |
record.secret? |
string |
record.status? |
"active" | "revoked" |
record.updatedAt? |
string |
Returns
Section titled “Returns”{ createdAt: string; id: string; label: string; note?: string; provider: string; secret: string; status: "active" | "revoked"; updatedAt: string;}createdAt
Section titled “createdAt”createdAt: string;id: string;label: string;note?: string;provider
Section titled “provider”provider: string = KeyProviderSchema;secret
Section titled “secret”secret: string;status
Section titled “status”status: "active" | "revoked" = KeyStatusSchema;updatedAt
Section titled “updatedAt”updatedAt: string;