Interface IApiKeyManagementService

Namespace

Tharga.Team

Assembly

Tharga.Team.dll

User-facing management of a team's API keys. Every operation names the team it acts on as its first argument, and requires the Manage scope on that team — holding the scope for one team does not authorize acting on another.

public interface IApiKeyManagementService

Remarks

System keys, which belong to no team, live on ISystemApiKeyManagementService.

Methods

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

Creates a new API key. When ownerScoped is true the key is private to the caller (owner = the caller's team-member key); a caller can only ever mint a key owned by themselves.

[RequireScope("apikey:manage")]
Task<IApiKey> CreateKeyAsync(string teamKey, string name, AccessLevel accessLevel, string[] roles = null, string[] scopeOverrides = null, DateTime? expiryDate = null, IReadOnlyList<Tag> tags = null, bool ownerScoped = false)

Parameters

teamKey string

name string

accessLevel AccessLevel

roles string[]

scopeOverrides string[]

expiryDate DateTime?

tags IReadOnlyList<Tag>

ownerScoped bool

Returns

Task<IApiKey>

DeleteKeyAsync(string, string)

[RequireScope("apikey:manage")]
Task DeleteKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task

GetKeysAsync(string, PrivateKeyScope, bool)

Returns the team's API keys for the caller. Team-wide keys are always included; owner-scoped ("private") keys are included per privateKeys, intersected with the caller's entitlement (owner sees own; Developer-role sees all; allowPrivileged additionally lets Administrator/Owner see private keys). Defaults preserve the original team-wide-only behaviour.

[RequireScope("apikey:manage")]
IAsyncEnumerable<IApiKey> GetKeysAsync(string teamKey, PrivateKeyScope privateKeys = PrivateKeyScope.None, bool allowPrivileged = false)

Parameters

teamKey string

privateKeys PrivateKeyScope

allowPrivileged bool

Returns

IAsyncEnumerable<IApiKey>

LockKeyAsync(string, string)

[RequireScope("apikey:manage")]
Task LockKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task

RefreshKeyAsync(string, string)

[RequireScope("apikey:manage")]
Task<IApiKey> RefreshKeyAsync(string teamKey, string key)

Parameters

teamKey string

key string

Returns

Task<IApiKey>

SetKeyDisabledAsync(string, string, bool)

Disables the key, or enables it again. A disabled key is refused at authentication but keeps its name, scopes, roles, tags and history — the reversible alternative to DeleteKeyAsync(string, string).

[RequireScope("apikey:manage")]
Task SetKeyDisabledAsync(string teamKey, string key, bool disabled)

Parameters

teamKey string

key string

disabled bool

Returns

Task

Remarks

Refreshing a disabled key does not enable it. A refresh mints a new secret; it is not a decision to trust the key again, and the usual reason to refresh is the same suspected leak that prompted the disable.

SetRolesAsync(string, string, string[])

[RequireScope("apikey:manage")]
Task SetRolesAsync(string teamKey, string key, string[] roles)

Parameters

teamKey string

key string

roles string[]

Returns

Task

SetScopeOverridesAsync(string, string, string[])

[RequireScope("apikey:manage")]
Task SetScopeOverridesAsync(string teamKey, string key, string[] scopes)

Parameters

teamKey string

key string

scopes string[]

Returns

Task