Class ApiKeyLifecycleDecorator

Namespace

Tharga.Team.Service

Assembly

Tharga.Team.Service.dll

Decorator that wraps IApiKeyAdministrationService and notifies the registered IApiKeyLifecycleHandler(s) after a key is created, recycled, or deleted. The raw private token (available on the create/refresh result) is forwarded on create/recycle; delete is signalled tokenless. Read/lock/scope/role operations pass through without notification.

Handlers run after the underlying mutation succeeds; a handler exception propagates out of the originating operation (capture failures are not swallowed). The token is never logged.

public class ApiKeyLifecycleDecorator : IApiKeyAdministrationService

Inheritance

object

ApiKeyLifecycleDecorator

Implements

IApiKeyAdministrationService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ApiKeyLifecycleDecorator(IApiKeyAdministrationService, IEnumerable<IApiKeyLifecycleHandler>)

public ApiKeyLifecycleDecorator(IApiKeyAdministrationService inner, IEnumerable<IApiKeyLifecycleHandler> handlers)

Parameters

inner IApiKeyAdministrationService

handlers IEnumerable<IApiKeyLifecycleHandler>

Methods

CreateKeyAsync(string, string, AccessLevel, string[], string[], DateTime?, IReadOnlyList<Tag>, string, string)

Creates a new API key with the specified settings (advanced mode). tags are system-set key-value tags, settable only here (not from the UI) and immutable thereafter. createdBy records who created the key; null for keys created without a user context (e.g. auto-generated), surfaced as "System" in the UI. ownerMemberKey makes the key owner-scoped ("private") — bound to that team member and hidden from / immutable by other members; null = a normal team-wide key.

public Task<IApiKey> CreateKeyAsync(string teamKey, string name, AccessLevel accessLevel, string[] roles = null, string[] scopeOverrides = null, DateTime? expiryDate = null, IReadOnlyList<Tag> tags = null, string createdBy = null, string ownerMemberKey = null)

Parameters

teamKey string

name string

accessLevel AccessLevel

roles string[]

scopeOverrides string[]

expiryDate DateTime?

tags IReadOnlyList<Tag>

createdBy string

ownerMemberKey string

Returns

Task<IApiKey>

CreateSystemKeyAsync(string, string[], DateTime?, string)

Creates a new system-level API key with the specified explicit scope set.

public Task<IApiKey> CreateSystemKeyAsync(string name, string[] scopes, DateTime? expiryDate = null, string createdBy = null)

Parameters

name string

Human-readable name for the key.

scopes string[]

Explicit scopes granted to this key. Not resolved through AccessLevel/roles.

expiryDate DateTime?

Optional expiry date.

createdBy string

Identity of the user creating the key (for audit).

Returns

Task<IApiKey>

DeleteKeyAsync(string, string)

Deletes an API key. Verifies team ownership.

public Task DeleteKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task

DeleteSystemKeyAsync(string)

Deletes a system API key.

public Task DeleteSystemKeyAsync(string key)

Parameters

key string

Returns

Task

GetByApiKeyAsync(string)

Looks up an API key by its raw value. Returns null if no match is found.

public Task<IApiKey> GetByApiKeyAsync(string apiKey)

Parameters

apiKey string

Returns

Task<IApiKey>

GetKeysAsync(string)

Returns all API keys for the specified team, creating default keys if fewer than AutoKeyCount exist.

public IAsyncEnumerable<IApiKey> GetKeysAsync(string teamKey)

Parameters

teamKey string

Returns

IAsyncEnumerable<IApiKey>

GetSystemKeysAsync()

Returns all system-level API keys (not bound to a team).

public IAsyncEnumerable<IApiKey> GetSystemKeysAsync()

Returns

IAsyncEnumerable<IApiKey>

LockKeyAsync(string, string)

Discards the stored secret so the raw key value can never be retrieved again. Verifies team ownership.

public Task LockKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task

Remarks

This does not disable the key. A locked key still authenticates — locking only makes the value unrecoverable, which is why ApiKeyOptions.AutoLockKeys can lock every key at creation without breaking anything.

To stop a key working, use SetKeyDisabledAsync(string, string, bool, string), which is reversible and keeps the key's name, scopes, roles, tags and history. Delete only when the key should cease to exist.

LockSystemKeyAsync(string)

Discards the stored secret of a system API key so its raw value can never be retrieved again.

public Task LockSystemKeyAsync(string key)

Parameters

key string

Returns

Task

Remarks

This does not disable the key — see LockKeyAsync(string, string).

RefreshKeyAsync(string, string)

Generates a new API key value for an existing key entry. Returns the entity with the raw key visible once.

public Task<IApiKey> RefreshKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task<IApiKey>

RefreshSystemKeyAsync(string)

Regenerates a system key's raw value. Returns the entity with the raw key visible once.

public Task<IApiKey> RefreshSystemKeyAsync(string key)

Parameters

key string

Returns

Task<IApiKey>

SetKeyDisabledAsync(string, string, bool, string)

Stops a team key being usable, or makes it usable again, without losing its name, scopes, roles, tags or audit trail.

public Task SetKeyDisabledAsync(string teamKey, string key, bool disabled, string actor = null)

Parameters

teamKey string

key string

disabled bool

actor string

Returns

Task

Remarks

The reversible alternative to deletion, for the ordinary operational cases: a key suspected of leaking, a partner integration paused, a key parked while an incident is investigated.

Not the same as locking. Locking discards the stored secret so its raw value cannot be retrieved again; a locked key still authenticates. Disabling stops it working.

Refreshing does not enable a disabled key. Minting a new secret is not a decision to trust the key again.

SetRolesAsync(string, string, string[])

Sets the Roles (tenant roles) array on an existing team API key. Verifies team ownership. Pass null or an empty array to clear all roles.

public Task SetRolesAsync(string teamKey, string key, string[] roles)

Parameters

teamKey string

key string

roles string[]

Returns

Task

SetScopeOverridesAsync(string, string, string[])

Sets the ScopeOverrides array on an existing team API key. Verifies team ownership. Pass null or an empty array to clear all overrides.

public Task SetScopeOverridesAsync(string teamKey, string key, string[] scopes)

Parameters

teamKey string

key string

scopes string[]

Returns

Task

SetSystemKeyDisabledAsync(string, bool, string)

Stops a team key being usable, or makes it usable again, without losing its name, scopes, roles, tags or audit trail.

public Task SetSystemKeyDisabledAsync(string key, bool disabled, string actor = null)

Parameters

key string

disabled bool

actor string

Returns

Task

Remarks

The reversible alternative to deletion, for the ordinary operational cases: a key suspected of leaking, a partner integration paused, a key parked while an incident is investigated.

Not the same as locking. Locking discards the stored secret so its raw value cannot be retrieved again; a locked key still authenticates. Disabling stops it working.

Refreshing does not enable a disabled key. Minting a new secret is not a decision to trust the key again.